openapi: 3.0.0
info:
  version: "2020.11"
  title: Dyspatch API
  description: |
    # Introduction

    The Dyspatch API is based on the REST paradigm, and features resource based URLs with standard HTTP response
    codes to indicate errors. We use standard HTTP authentication and request verbs, and all responses are JSON formatted.
    See our [Implementation Guide](https://docs.dyspatch.io/integrations/implementing_dyspatch/) for more details on
    how to implement Dyspatch.

    ## API Client Libraries
    Dyspatch provides API Clients for popular languages and web frameworks.

    - [Java](https://github.com/getdyspatch/dyspatch-java)
    - [Javascript](https://github.com/getdyspatch/dyspatch-javascript)
    - [Python](https://github.com/getdyspatch/dyspatch-python)
    - [C#](https://github.com/getdyspatch/dyspatch-dotnet)
    - [Go](https://github.com/getdyspatch/dyspatch-golang)
    - [Ruby](https://github.com/getdyspatch/dyspatch-ruby)
  contact:
    name: Dyspatch Support
    url: https://docs.dyspatch.io
    email: support@dyspatch.io
  termsOfService: https://www.dyspatch.io/legal/terms-of-service/
paths:
  /templates:
    get:
      operationId: getTemplates
      security:
        - Bearer: []
      summary: List Templates
      description:
        Gets a list of Template Metadata objects for all templates. Up to 25
        results returned before results are paginated.
      tags:
        - Templates
      parameters:
        - $ref: "#/components/parameters/cursor"
        - $ref: "#/components/parameters/version"
      responses:
        "200":
          description: A list of templates
          headers:
            X-RateLimit-Remaining:
              description: The number of requests left for the time window.
              schema:
                type: integer
          content:
            application/vnd.dyspatch.2020.11+json:
              schema:
                $ref: "#/components/schemas/TemplatesRead"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthenticated"
        "403":
          $ref: "#/components/responses/Unauthorized"
        "429":
          $ref: "#/components/responses/RateLimited"
        "500":
          $ref: "#/components/responses/InternalError"
        default:
          $ref: "#/components/responses/InternalError"
  "/templates/{templateId}":
    get:
      operationId: getTemplateById
      security:
        - Bearer: []
      summary: Get Template by ID
      description:
        Gets a template object with the matching ID. Templates without a
        published draft will result in an error.
      tags:
        - Templates
      parameters:
        - $ref: "#/components/parameters/templateId"
        - $ref: "#/components/parameters/targetLanguage"
        - $ref: "#/components/parameters/version"
      responses:
        "200":
          description:
            A template object with the requested ID. Templates without a
            published draft will result in an error.
          headers:
            X-RateLimit-Remaining:
              description: The number of requests left for the current time window
              schema:
                type: integer
          content:
            application/vnd.dyspatch.2020.11+json:
              schema:
                $ref: "#/components/schemas/TemplateRead"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthenticated"
        "403":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/RateLimited"
        "500":
          $ref: "#/components/responses/InternalError"
        default:
          $ref: "#/components/responses/InternalError"
  /drafts:
    get:
      operationId: getDrafts
      security:
        - Bearer: []
      summary: List Drafts
      description: Returns all drafts for your organization.
      tags:
        - Drafts
      parameters:
        - $ref: "#/components/parameters/cursor"
        - $ref: "#/components/parameters/status"
        - $ref: "#/components/parameters/version"
      responses:
        "200":
          description: Drafts
          headers:
            X-RateLimit-Remaining:
              description: The number of requests left for the time window.
              schema:
                type: integer
          content:
            application/vnd.dyspatch.2020.11+json:
              schema:
                $ref: "#/components/schemas/DraftsRead"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthenticated"
        "403":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/RateLimited"
        "500":
          $ref: "#/components/responses/InternalError"
        default:
          $ref: "#/components/responses/InternalError"
  "/drafts/{draftId}/publishRequest":
    post:
      operationId: submitDraftForApproval
      security:
        - Bearer: []
      summary: Submit the draft for approval
      description: Moves the draft into submitted state.
      tags:
        - Drafts
      parameters:
        - $ref: "#/components/parameters/draftId"
        - $ref: "#/components/parameters/version"
      responses:
        "200":
          description: Successfully submitted
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthenticated"
        "403":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/RateLimited"
        "500":
          $ref: "#/components/responses/InternalError"
        default:
          $ref: "#/components/responses/InternalError"
  "/drafts/{draftId}":
    get:
      operationId: getDraftById
      security:
        - Bearer: []
      summary: Get Draft by ID
      description:
        Gets a draft object with the matching ID. The "compiled" field will
        contain the template in the default, unlocalized form.
      tags:
        - Drafts
      parameters:
        - $ref: "#/components/parameters/draftId"
        - $ref: "#/components/parameters/targetLanguage"
        - $ref: "#/components/parameters/version"
      responses:
        "200":
          description: A draft object with the requested ID.
          headers:
            X-RateLimit-Remaining:
              description: The number of requests left for the current time window
              schema:
                type: integer
          content:
            application/vnd.dyspatch.2020.11+json:
              schema:
                $ref: "#/components/schemas/DraftRead"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthenticated"
        "403":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/RateLimited"
        "500":
          $ref: "#/components/responses/InternalError"
        default:
          $ref: "#/components/responses/InternalError"
  "/drafts/{draftId}/localizations":
    get:
      operationId: getLocalizationForDraft
      security:
        - Bearer: []
      summary: Get localizations on a draft
      description: Returns localization metadata for the draft
      tags:
        - Drafts
      parameters:
        - $ref: "#/components/parameters/draftId"
        - $ref: "#/components/parameters/version"
      responses:
        "200":
          description: A list of localizations
          headers:
            X-RateLimit-Remaining:
              description: The number of requests left for the current time window
              schema:
                type: integer
          content:
            application/vnd.dyspatch.2020.11+json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/LocalizationMetaRead"
  "/drafts/{draftId}/localizations/{languageId}":
    put:
      operationId: saveLocalization
      security:
        - Bearer: []
      summary: Create or update a localization
      description:
        Inserts a localization or sets the name on an existing localization that
        already uses the languageId
      tags:
        - Drafts
      parameters:
        - $ref: "#/components/parameters/draftId"
        - $ref: "#/components/parameters/languageId"
        - $ref: "#/components/parameters/version"
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: English (US)
        required: true
      responses:
        "200":
          description: Successful upsert
    delete:
      operationId: deleteLocalization
      security:
        - Bearer: []
      summary: Remove a localization
      description: Deletes the localization with the given language ID if it exists
      tags:
        - Drafts
      parameters:
        - $ref: "#/components/parameters/draftId"
        - $ref: "#/components/parameters/languageId"
        - $ref: "#/components/parameters/version"
      responses:
        "200":
          description: Successful delete
  "/drafts/{draftId}/localizations/{languageId}/translations":
    put:
      operationId: setTranslation
      security:
        - Bearer: []
      summary: Set translations for language
      description:
        Completely replaces any existing translations for the given language
        with those provided in request body. Variables embedded in keys or
        values are expected to be in the format `%(my_variable)s` and will
        automatically convert to the correct Dyspatch format depending on the
        type of template. Accepts key/value pairs in JSON format or in gettext
        PO file format. For JSON set `Content-Type` header to
        `application/json`. For gettext PO format set `Content-Type` header to
        `text/x-gettext-translation`.
      tags:
        - Drafts
      parameters:
        - $ref: "#/components/parameters/draftId"
        - $ref: "#/components/parameters/languageId"
        - $ref: "#/components/parameters/version"
      requestBody:
        content:
          application/json:
            schema:
              type: object
              additionalProperties:
                type: string
              example:
                Hello %(name)s: Bonjour %(name)s
                Welcome: Bienvenue
        required: true
      responses:
        "200":
          description: Successful
        "403":
          $ref: "#/components/responses/Unauthorized"
  "/drafts/{draftId}/localizationKeys":
    get:
      operationId: getDraftLocalizationKeys
      security:
        - Bearer: []
      summary: Get localization keys
      description:
        Returns the list of values that need to be translated for the draft. Set
        the `Accept` header to `application/vnd.dyspatch.2020.11+json` to get a
        JSON object, or `text/vnd.dyspatch.2020.11+x-gettext-translation` to get
        the POT file.
      tags:
        - Drafts
      parameters:
        - $ref: "#/components/parameters/draftId"
        - $ref: "#/components/parameters/version"
      responses:
        "200":
          description: Localization keys
          content:
            application/vnd.dyspatch.2020.11+json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/LocalizationKeyRead"
            text/vnd.dyspatch.2020.11+x-gettext-translation:
              schema:
                type: string
                format: binary
  "/localizations/{localizationId}":
    get:
      operationId: getPublishedLocalizationById
      security:
        - Bearer: []
      summary: Get Localization Object by ID
      description: Returns the published content associated with the localization of the matching ID
      tags:
        - Localizations
      parameters:
        - $ref: "#/components/parameters/localizationId"
        - $ref: "#/components/parameters/targetLanguage"
        - $ref: "#/components/parameters/version"
      responses:
        "200":
          description: A localization object with the requested ID
          headers:
            X-RateLimit-Remaining:
              description: The number of requests left for the current time window
              schema:
                type: integer
          content:
            application/vnd.dyspatch.2020.11+json:
              schema:
                $ref: "#/components/schemas/LocalizationRead"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthenticated"
        "403":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/RateLimited"
        "500":
          $ref: "#/components/responses/InternalError"
        default:
          $ref: "#/components/responses/InternalError"
  "/localizations/{localizationId}/drafts/{draftId}":
    get:
      operationId: getDraftLocalizationById
      security:
        - Bearer: []
      summary: Get Draft Localization Object by ID
      description: Returns a specific localization object of the matching draft with a matching localization ID
      tags:
        - Localizations
      parameters:
        - $ref: "#/components/parameters/draftId"
        - $ref: "#/components/parameters/localizationId"
        - $ref: "#/components/parameters/targetLanguage"
        - $ref: "#/components/parameters/version"
      responses:
        "200":
          description: A localization object from the matching draft ID with the requested ID
          headers:
            X-RateLimit-Remaining:
              description: The number of requests left for the current time window
              schema:
                type: integer
          content:
            application/vnd.dyspatch.2020.11+json:
              schema:
                $ref: "#/components/schemas/LocalizationRead"
        "400":
          $ref: "#/components/responses/InvalidRequest"
        "401":
          $ref: "#/components/responses/Unauthenticated"
        "403":
          $ref: "#/components/responses/Unauthorized"
        "404":
          $ref: "#/components/responses/NotFound"
        "429":
          $ref: "#/components/responses/RateLimited"
        "500":
          $ref: "#/components/responses/InternalError"
        default:
          $ref: "#/components/responses/InternalError"
tags:
  - name: Templates
    description: |
      Templates are the email templates found in your Dyspatch account. Only the
      published Template Draft is returned.

      A typical integration will start with using the Templates list endpoint to iterate through and sync Templates.
  - name: Drafts
    description: >
      Drafts represent unpublished versions of templates that are still mutable.
      There could be many in progress drafts for a template.
  - name: Localizations
    description: |
      Localization objects are the same as Template objects except they contain
      localized content.

      If your account is using localizations then use this instead of the compiled Template object.
servers:
  - url: https://api.dyspatch.io
components:
  parameters:
    version:
      in: header
      name: Accept
      required: true
      description:
        A version of the API that should be used for the request. For example,
        to use version "2020.11", set the value to
        "application/vnd.dyspatch.2020.11+json"
      schema:
        type: string
    cursor:
      name: cursor
      in: query
      description:
        A cursor value used to retrieve a specific page from a paginated result
        set.
      required: false
      schema:
        type: string
    templateId:
      name: templateId
      in: path
      description: A template ID
      required: true
      schema:
        type: string
    draftId:
      name: draftId
      in: path
      description: A draft ID
      required: true
      schema:
        type: string
    languageId:
      name: languageId
      in: path
      description: "A language ID (eg: en-US)"
      required: true
      schema:
        type: string
    targetLanguage:
      name: targetLanguage
      in: query
      description:
        The type of templating language to compile as. Should only be used for
        visual templates.
      required: true
      schema:
        type: string
        enum:
          - html
          - handlebars
          - ampscript
          - freemarker
          - cheetah
          - jinja
          - liquid
          - mandrillhandlebars
    localizationId:
      name: localizationId
      in: path
      description: A localization ID
      required: true
      schema:
        type: string
    status:
      name: status
      in: query
      description: Filter the list of drafts by a particular status
      required: false
      schema:
        type: string
        enum:
          - awaitingTranslation
  responses:
    InternalError:
      description: Server error
      headers:
        X-RateLimit-Remaining:
          description: The number of requests left for the time window.
          schema:
            type: integer
      content:
        "*/*":
          schema:
            $ref: "#/components/schemas/APIError"
    InvalidRequest:
      description: Invalid request
      headers:
        X-RateLimit-Remaining:
          description: The number of requests left for the time window.
          schema:
            type: integer
      content:
        "*/*":
          schema:
            $ref: "#/components/schemas/APIError"
    RateLimited:
      description: Rate limit exceeded
      headers:
        X-RateLimit-Remaining:
          description: The number of requests left for the time window.
          schema:
            type: integer
      content:
        "*/*":
          schema:
            $ref: "#/components/schemas/APIError"
    Unauthenticated:
      description: Unauthenticated
      headers:
        X-RateLimit-Remaining:
          description: The number of requests left for the time window.
          schema:
            type: integer
      content:
        "*/*":
          schema:
            $ref: "#/components/schemas/APIError"
    Unauthorized:
      description: Unauthorized
      headers:
        X-RateLimit-Remaining:
          description: The number of requests left for the time window.
          schema:
            type: integer
      content:
        "*/*":
          schema:
            $ref: "#/components/schemas/APIError"
    NotFound:
      description: Resource not found
      headers:
        X-RateLimit-Remaining:
          description: The number of requests left for the time window.
          schema:
            type: integer
      content:
        "*/*":
          schema:
            $ref: "#/components/schemas/APIError"
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
      description: |
        Set Bearer followed by your API key as the Authorization header in your
        API requests.

        ```shell
        Authorization: Bearer EXAMPLEAPIKEYXXXXXXXX12345678
        ```

        Below is an example curl request with an API key in the Authorization header.

        ```shell
        curl --request GET \
        --url https://api.dyspatch.io/templates \
        --header 'Authorization: Bearer EXAMPLEAPIKEYXXXXXXXX12345678' \
        --header 'Accept: application/vnd.dyspatch.2020.11+json'
        ```
  schemas:
    cursor:
      type: object
      description: Information about paginated results
      properties:
        next:
          type: string
          description: A cursor to fetch the next page of results
        hasMore:
          type: boolean
          description: Whether there is a next page of results
    templateId:
      type: string
      description: An opaque, unique identifier for a template
      example: tem_g3L7Cw6Hp5wU
    draftId:
      type: string
      description: An opaque, unique identifier for a draft
      example: tdft_g3L7Cw6Hp5wU
    localeGroupId:
      description: the locale group this localization belongs to, if this field is empty the localization does not belong to any locale group
      type: string
      example: lgr_alka38ajla301
    templateName:
      type: string
      description: The name of a template
    templateDescription:
      type: string
      description: A description of the template
    templateUrl:
      type: string
      example: /templates/tem_g3L7Cw6Hp5wUaf395LehwK
      description: The API url for a specific template
    draftName:
      type: string
      description: The name of a draft
    draftUrl:
      type: string
      example: /drafts/tdft_g3L7Cw6Hp5wUaf395LehwK/dft_g3L7Cw6Hp5wU
      description: The API url for a specific draft
    localizationId:
      type: string
      description: An opaque, unique identifier for a localization
      example: loc_g3L7Cw6Hp5wUaf395LehwK
    localizationUrl:
      type: string
      example: /localizations/loc_g3L7Cw6Hp5wUaf395LehwK
      description: The API url for a specific localization
    localizationName:
      type: string
      example: English (US)
      description: The user-specified name of a localization
    languages:
      type: array
      items:
        type: string
      description: >
        a list of locale codes that are available in the localization.
        See [supported languages](https://docs.dyspatch.io/localization/supported_languages/)
        for an exhaustive list of locale codes.
    createdAt:
      type: string
      format: date-time
      description: The time of initial creation
    updatedAt:
      type: string
      format: date-time
      description: The time of last update
    TemplateMetaRead:
      type: object
      description: the template metadata
      properties:
        id:
          $ref: "#/components/schemas/templateId"
        name:
          $ref: "#/components/schemas/templateName"
        description:
          $ref: "#/components/schemas/templateDescription"
        url:
          $ref: "#/components/schemas/templateUrl"
        localizations:
          type: array
          items:
            $ref: "#/components/schemas/LocalizationMetaRead"
          description: A list of the template's available localization objects
        createdAt:
          $ref: "#/components/schemas/createdAt"
        updatedAt:
          $ref: "#/components/schemas/updatedAt"
    TemplatesRead:
      type: object
      description: list of template metadata
      properties:
        cursor:
          $ref: "#/components/schemas/cursor"
        data:
          type: array
          items:
            $ref: "#/components/schemas/TemplateMetaRead"
          description: A list of template metadata objects
    TemplateRead:
      type: object
      description: list of template metadata
      properties:
        id:
          $ref: "#/components/schemas/templateId"
        name:
          $ref: "#/components/schemas/templateName"
        description:
          $ref: "#/components/schemas/templateDescription"
        url:
          $ref: "#/components/schemas/templateUrl"
        compiled:
          $ref: "#/components/schemas/CompiledRead"
        createdAt:
          $ref: "#/components/schemas/createdAt"
        updatedAt:
          $ref: "#/components/schemas/updatedAt"
        localizations:
          type: array
          items:
            $ref: "#/components/schemas/LocalizationMetaRead"
          description: A list of the Template's available localizations
    DraftRead:
      type: object
      description: template draft metadata included latest draft revision
      properties:
        id:
          $ref: "#/components/schemas/draftId"
        template:
          $ref: "#/components/schemas/templateId"
        name:
          $ref: "#/components/schemas/draftName"
        url:
          $ref: "#/components/schemas/draftUrl"
        compiled:
          $ref: "#/components/schemas/CompiledRead"
        createdAt:
          $ref: "#/components/schemas/createdAt"
        updatedAt:
          $ref: "#/components/schemas/updatedAt"
        localizations:
          type: array
          items:
            $ref: "#/components/schemas/LocalizationMetaRead"
          description: A list of the Template's available localizations
    LocalizationMetaRead:
      type: object
      description: localization metadata
      properties:
        id:
          $ref: "#/components/schemas/localizationId"
        name:
          $ref: "#/components/schemas/localizationName"
        url:
          $ref: "#/components/schemas/localizationUrl"
        localeGroup:
          $ref: "#/components/schemas/localeGroupId"
        languages:
          $ref: "#/components/schemas/languages"
    LocalizationRead:
      type: object
      description: localization metadata and latest revision for associated template
      properties:
        id:
          $ref: "#/components/schemas/localizationId"
        languages:
          $ref: "#/components/schemas/languages"
        url:
          $ref: "#/components/schemas/localizationUrl"
        template:
          $ref: "#/components/schemas/templateId"
        compiled:
          $ref: "#/components/schemas/CompiledRead"
        createdAt:
          $ref: "#/components/schemas/createdAt"
        updatedAt:
          $ref: "#/components/schemas/updatedAt"
        name:
          $ref: "#/components/schemas/localizationName"
        localeGroup:
          $ref: "#/components/schemas/localeGroupId"
    LocalizationKeyRead:
      type: object
      description: localization key
      properties:
        key:
          type: string
        comment:
          type: string
    DraftsRead:
      type: object
      description: list of draft metadata
      properties:
        cursor:
          $ref: "#/components/schemas/cursor"
        data:
          type: array
          items:
            $ref: "#/components/schemas/DraftMetaRead"
          description: A list of draft metadata objects
    DraftMetaRead:
      type: object
      description: draft metadata
      properties:
        id:
          $ref: "#/components/schemas/draftId"
        templateId:
          $ref: "#/components/schemas/templateId"
        name:
          $ref: "#/components/schemas/draftName"
        url:
          $ref: "#/components/schemas/draftUrl"
        createdAt:
          $ref: "#/components/schemas/createdAt"
        updatedAt:
          $ref: "#/components/schemas/updatedAt"
    APIError:
      type: object
      description: possible errors from the api
      properties:
        code:
          type: string
          enum:
            - server_error
            - invalid_parameter
            - invalid_body
            - invalid_request
            - unauthorized
            - unauthenticated
            - not_found
            - rate_limited
            - prohibited_action
          description: |
            Error code:
              * server_error - Internal server error.
              * invalid_parameter - Validation error, parameter will contain invalid field and message will contain the reason.
              * invalid_body - Body could not be parsed, message will contain the reason.
              * invalid_request - Validation error, the protocol used to make the request was not https.
              * unauthorized - Credentials were found but permissions were not sufficient.
              * unauthenticated - Credentials were not found or were not valid.
              * not_found - The requested resource was not found.
              * rate_limited - The request was refused because a rate limit was exceeded. There is an account wide rate limit of 3600 requests per-minute, although that is subject to change. The current remaining rate limit can be viewed by checking the X-Ratelimit-Remaining header.
              * prohibited_action - The request was refused because an action was not valid for the requested resource. Typically this will happen if you try to make changes to a locked resource.
        message:
          type: string
          description: Human readable error message
        parameter:
          type: string
          description: The invalid parameter, if 'code' is invalid_parameter
    CompiledRead:
      type: object
      description: revision data
      properties:
        sender:
          type: string
          example: example@example.com
          description: Sender address
        replyTo:
          type: string
          example: example@example.com
          description: Reply-To address
        subject:
          type: string
          format: byte
          example: PGh0bWw+PC9odG1sPgo=
          description: Base64 encoded template subject line
        html:
          type: string
          format: byte
          example: PGh0bWw+PC9odG1sPgo=
          description: Base64 encoded template HTML body
        ampHtml:
          type: string
          format: byte
          example: PGh0bWwg4pqhNGVtYWlsPjwvaHRtbD4=
          description: Base64 encoded template AMP body
        text:
          type: string
          format: byte
          example: dGV4dCBjb250ZW50
          description: Base64 encoded template text body
