Ometria Transactional Email API

openapi: 3.2.0
info:
  version: 1.1.0
  title: Ometria data Transactional Email API
  description: 'Welcome to the Ometria API reference.


    The Ometria API is organized around the REST methodology, and it uses resource-oriented URLs, and common HTTP response codes to indicate API errors. All requests are authenticated using an API key which can be obtained from your account settings.


    ### HTTPS


    All requests to the Ometria API MUST be carried out via HTTPS. API servers do not listen on unsecured HTTP ports to avoid the possibility of insecure information exchange.


    ### Message encoding


    The V2 Ometria API uses JSON encoding for all data exchanges and assumes UTF-8 character encoding throughout.


    ### Rate limits


    The Ometria API has a default rate limit of 4 requests per second per Ometria account. The /push/ endpoint allows 8 requests per second per Ometria account. If you expect to exceed this limit, please contact us.


    In the case of your application being rate limited, the HTTP code 429 (too many requests) will be returned. In this case your application should reduce the number of requests it is trying to send.'
  contact:
    name: Ometria
    email: support@ometria.com
    url: https://ometria.com
servers:
- url: https://api.ometria.com/v2
security:
- apikey: []
tags:
- name: Transactional Email
paths:
  /transactional-email/send:
    post:
      tags:
      - Transactional Email
      summary: Send Transactional Email
      description: Send a transactional email
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionalEmail'
        description: Transactional Email object
        required: true
      responses:
        '200':
          description: Email successfully sent
        '403':
          description: API key is not authorised to access this resource
      operationId: postTransactionalEmailSend
      x-operation-id-source: derived
components:
  schemas:
    TransactionalEmailContent:
      type: object
      description: Describes the Email Content.
      properties:
        html:
          type: string
          description: The HTML version of the email.
        text:
          type: string
          description: The Text version of the email.
      example:
        html: <html><head></head><body>Email content</body></html>
        text: Email content
    TransactionalEmailAddress:
      type: object
      description: Describes an Email Address.
      required:
      - name
      - email
      properties:
        name:
          type: string
          description: The recipient's name.
        email:
          type: string
          description: The recipient's email.
      example:
        name: John Smith
        email: j.smith@example.com
    UrlParameters:
      type: object
      description: Tracking parameters for transactional emails if no parameters are defined in the platform or in an API call.
      properties:
        utm_medium:
          type: string
          description: Tracking parameter medium e.g. email
        utm_source:
          type: string
          description: Tracking parameter source e.g. ometria
        utm_campaign:
          type: string
          description: Campaign has and title e.g. utm_campaign=om_f8xxexx8exx2_welcome_campaign
    TransactionalEmail:
      type: object
      description: Describes a Transactional Email record.
      required:
      - subject
      - to
      - from
      properties:
        subject:
          type: string
          description: The subject line to be used in the email.
        to:
          $ref: '#/components/schemas/TransactionalEmailAddress'
          description: The 'to' email address
        from:
          $ref: '#/components/schemas/TransactionalEmailAddress'
          description: The 'from' email address.
        reply_to:
          $ref: '#/components/schemas/TransactionalEmailAddress'
        transactional:
          type: boolean
          description: Whether this email should be considered transactional or not.
          default: false
        stream:
          type: string
          description: A string that can be made up for tracking purposes.
          default: default
          pattern: ^[\\w]+$"
        profile_id:
          type: string
          description: Enter a profile ID to make profile information available as dynamic content for using in your email templates.
        template_id:
          type: integer
          format: int32
          description: The ID of the HTML email template to be used.
        content:
          $ref: '#/components/schemas/TransactionalEmailContent'
          description: The content of the email.
        data:
          type: object
          description: Data passed in this object will be made available as dynamic content which you can merge into the template before sending.
          default: '{}'
        url_parameters:
          $ref: '#/components/schemas/UrlParameters'
          description: Tracking parameters for transactional emails if no parameters are defined in the platform or in an API call.
        sandbox:
          type: boolean
          description: 'To be used during testing. When set to "True", the email will be processed but not sent. '
          default: false
      example:
        subject: Email Subject
        to:
          name: John Smith
          email: j.smith@example.com
        from:
          name: John Smith
          email: j.smith@example.com
        reply_to:
          name: John Smith
          email: j.smith@example.com
        transactional: true
        stream: 87tgHafe
        profile_id: ''
        template_id: 3
        data: {}
        sandbox: true
        url_parameters:
          utm_campaign: transactional campaign
  securitySchemes:
    apikey:
      type: apiKey
      name: X-Ometria-Auth
      in: header
      description: Ometria API key which can be obtained from your Ometria account administrator
    apiKeyReadTranslations:
      type: apiKey
      name: X-Ometria-Auth
      in: header
      description: 'Ometria API key which can be obtained from your Ometria account administrator. **Note**: The API key must have the scope `read:translations`.'
    apiKeyWriteTranslations:
      type: apiKey
      name: X-Ometria-Auth
      in: header
      description: 'Ometria API key which can be obtained from your Ometria account administrator. **Note**: The API key must have the scope `write:translations`.'
x-explorer-enabled: false
x-readme:
  proxy-enabled: true
  samples-enabled: true