Dyspatch Push Drafts API

openapi: 3.2.0
info:
  version: '2026.06'
  title: Dyspatch Push Drafts 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.'
  contact:
    name: Dyspatch Support
    url: https://docs.dyspatch.io
    email: support@dyspatch.io
  termsOfService: https://www.dyspatch.io/legal/terms-of-service/
servers:
- url: https://api.dyspatch.io
tags:
- name: Push Drafts
  description: Push Drafts represent unpublished versions of templates that are still mutable. There could be many in progress drafts for a template.
paths:
  /push/drafts:
    get:
      operationId: getPushDrafts
      security:
      - Bearer: []
      summary: List Push Drafts
      description: Returns all Push drafts for your organization.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/status'
      - $ref: '#/components/parameters/draftTemplateFilter'
      - $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.2026.06+json:
              schema:
                $ref: '#/components/schemas/DraftsRead'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        default:
          $ref: '#/components/responses/InternalError'
  /push/drafts/{draftId}/publishRequest:
    post:
      operationId: submitPushDraftForApproval
      security:
      - Bearer: []
      summary: Submit Push Draft for Approval
      description: Moves the Push draft into submitted state.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/version'
      responses:
        '200':
          description: Successfully submitted
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        default:
          $ref: '#/components/responses/InternalError'
  /push/drafts/{draftId}/publish/approve:
    post:
      operationId: approvePushDraft
      security:
      - Bearer: []
      summary: Approve Push Draft
      description: Approves a Push draft that is in Design or Publish review.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/version'
      requestBody:
        description: Optional Feedback for the approval
        content:
          text/plain:
            schema:
              type: string
        required: false
      responses:
        '200':
          description: Successfully submitted
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        default:
          $ref: '#/components/responses/InternalError'
  /push/drafts/{draftId}/publish/approveAll:
    post:
      operationId: approvePushDraftForAll
      security:
      - Bearer: []
      summary: Approve Push Draft For All Reviewers
      description: Approves a Push draft that is in Design or Publish review for all reviewers.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/version'
      requestBody:
        description: Optional Feedback for the approval
        content:
          text/plain:
            schema:
              type: string
        required: false
      responses:
        '200':
          description: Successfully submitted
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        default:
          $ref: '#/components/responses/InternalError'
  /push/drafts/{draftId}/publish/reject:
    post:
      operationId: rejectPushDraft
      security:
      - Bearer: []
      summary: Reject Push Draft
      description: Rejects a Push draft that is in Design or Publish review.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/version'
      requestBody:
        description: Optional Feedback for the rejection
        content:
          text/plain:
            schema:
              type: string
        required: false
      responses:
        '200':
          description: Successfully submitted
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        default:
          $ref: '#/components/responses/InternalError'
  /push/drafts/{draftId}/duplicate:
    post:
      operationId: duplicatePushDraft
      security:
      - Bearer: []
      summary: Duplicate Push Draft
      description: Creates a copy of a Push draft with a new name.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/version'
      requestBody:
        description: Name for the new draft
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: Name of the new draft
        required: true
      responses:
        '200':
          description: Successfully duplicated draft
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: ID of the newly created draft
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        default:
          $ref: '#/components/responses/InternalError'
  /push/drafts/{draftId}/lockForTranslation:
    put:
      operationId: lockPushDraftForTranslation
      security:
      - Bearer: []
      summary: Lock Push Draft for Translation
      description: Locks a Push draft to prevent edits while translations are being completed.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/version'
      responses:
        '204':
          description: Successfully locked draft for translation
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        default:
          $ref: '#/components/responses/InternalError'
    delete:
      operationId: unlockPushDraftForTranslation
      security:
      - Bearer: []
      summary: Unlock Push Draft for Translation
      description: Unlocks a Push draft to allow edits after translations are completed.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/version'
      responses:
        '204':
          description: Successfully unlocked draft for translation
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        default:
          $ref: '#/components/responses/InternalError'
  /push/drafts/{draftId}:
    get:
      operationId: getPushDraftById
      security:
      - Bearer: []
      summary: Get Push Draft by ID
      description: Gets a Push draft object with the matching ID. The "compiled" field will contain the template in the default, unlocalized form.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/pushTargetLanguage'
      - $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.2026.06+json:
              schema:
                $ref: '#/components/schemas/PushDraftRead'
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        default:
          $ref: '#/components/responses/InternalError'
    delete:
      operationId: archivePushDraft
      security:
      - Bearer: []
      summary: Archive Push Draft
      description: Archives a Push draft by marking it as deleted.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/version'
      responses:
        '204':
          description: Successfully archived draft
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
        default:
          $ref: '#/components/responses/InternalError'
  /push/drafts/{draftId}/localizations:
    get:
      operationId: getPushLocalizationForDraft
      security:
      - Bearer: []
      summary: Get Localizations on a Push Draft
      description: Returns localization metadata for the Push draft
      tags:
      - Push 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.2026.06+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LocalizationMetaRead'
        '400':
          $ref: '#/components/responses/InvalidRequest'
  /push/drafts/{draftId}/localizations/{languageId}:
    put:
      operationId: savePushLocalization
      security:
      - Bearer: []
      summary: Create or Update a Push Localization
      description: Inserts a localization or sets the name on an existing localization that already uses the languageId
      tags:
      - Push 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
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
    delete:
      operationId: deletePushLocalization
      security:
      - Bearer: []
      summary: Remove a Localization from Push Draft
      description: Deletes the localization with the given language ID if it exists
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/languageId'
      - $ref: '#/components/parameters/version'
      responses:
        '200':
          description: Successful delete
        '400':
          $ref: '#/components/responses/InvalidRequest'
  /push/drafts/{draftId}/localizations/{languageId}/translations:
    get:
      operationId: getPushTranslations
      security:
      - Bearer: []
      summary: Get Push Draft Translations for Language
      description: Returns the translations for the given language in key/value pairs.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/languageId'
      - $ref: '#/components/parameters/version'
      responses:
        '200':
          description: Successful
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
                example:
                  Hello %(name)s: Bonjour %(name)s
                  Welcome: Bienvenue
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: setPushTranslation
      security:
      - Bearer: []
      summary: Set Push Draft 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:
      - Push 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
        '400':
          $ref: '#/components/responses/InvalidRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /push/drafts/{draftId}/localizationKeys:
    get:
      operationId: getPushDraftLocalizationKeys
      security:
      - Bearer: []
      summary: Get Push Draft Localization Keys
      description: Returns the list of values that need to be translated for the draft. Set the `Accept` header to `application/vnd.dyspatch.2026.06+json` to get a JSON object, or `text/vnd.dyspatch.2026.06+x-gettext-translation` to get the POT file.
      tags:
      - Push Drafts
      parameters:
      - $ref: '#/components/parameters/draftId'
      - $ref: '#/components/parameters/version'
      responses:
        '200':
          description: Localization keys
          content:
            application/vnd.dyspatch.2026.06+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LocalizationKeyRead'
            text/vnd.dyspatch.2026.06+x-gettext-translation:
              schema:
                type: string
                format: binary
        '400':
          $ref: '#/components/responses/InvalidRequest'
components:
  schemas:
    languages:
      type: array
      items:
        type: string
        example: fr-FR
      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.

        '
    PushDraftRead:
      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'
        path:
          $ref: '#/components/schemas/path'
        workspaceId:
          $ref: '#/components/schemas/workspaceId'
        compiled:
          $ref: '#/components/schemas/PushCompiledRead'
        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
        status:
          $ref: '#/components/schemas/status'
        templateName:
          $ref: '#/components/schemas/templateName'
        designApprovedDate:
          $ref: '#/components/schemas/designApprovedDate'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/AssignedTagsMetaRead'
          description: A list of Tags assigned to the Draft
    localizationName:
      type: string
      example: English (US)
      description: The user-specified name of a localization
    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
    localizationUrl:
      type: string
      example: /localizations/loc_g3L7Cw6Hp5wUaf395LehwK
      description: The API url for a specific localization
    templateName:
      type: string
      description: The name of a template
      example: Template Name
    AssignedTagsMetaRead:
      type: object
      description: assigned tags metadata
      properties:
        id:
          $ref: '#/components/schemas/tagId'
        name:
          $ref: '#/components/schemas/tagName'
    draftUrl:
      type: string
      example: /drafts/tdft_g3L7Cw6Hp5wUaf395LehwK/dft_g3L7Cw6Hp5wU
      description: The API url for a specific draft
    workspaceId:
      type: string
      description: The workspace this object belongs to
      example: fdr_01gb8vd6pz
    variables:
      type: array
      items:
        type: string
        example: myVar
      description: 'a list of variables used in the template

        '
    PushCompiledRead:
      type: object
      description: revision data
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/PushContent'
        variables:
          $ref: '#/components/schemas/variables'
    templateId:
      type: string
      description: An opaque, unique identifier for a template
      example: tem_g3L7Cw6Hp5wU
    draftName:
      type: string
      description: The name of a draft
      example: Draft Name
    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'
        updatedAt:
          $ref: '#/components/schemas/updatedAt'
    status:
      type: string
      example: LOCKED_FOR_TRANSLATION
      enum:
      - IN_PROGRESS
      - PENDING_APPROVAL
      - LOCKED_FOR_TRANSLATION
      - UNKNOWN
      description: 'The status of the current draft:

        - `IN_PROGRESS`: Draft is actively being edited

        - `PENDING_APPROVAL`: Draft is awaiting approval

        - `LOCKED_FOR_TRANSLATION`: Draft is locked pending translation

        - `UNKNOWN`: Status cannot be determined at this time

        '
    tagName:
      type: string
      example: My Tag
      description: The user-specified name of a tag
    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
    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
    updatedAt:
      type: string
      format: date-time
      description: The time of last update
    designApprovedDate:
      type: string
      format: date-time
      description: 'If using the design approval workflow this is the date the template draft design was approved, otherwise it will be empty.

        '
    tagId:
      type: string
      example: /An opaque, unique identifier for a tag
      description: tag_01gpe172x7p6aa1c9grr48efq8
    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:\n  * server_error - Internal server error.\n  * invalid_parameter - Validation error, parameter will contain invalid field and message will contain the reason.\n  * invalid_body - Body could not be parsed, message will contain the reason.\n  * invalid_request - Validation error, the protocol used to make the request was not https.\n  * unauthorized - Credentials were found but permissions were not sufficient.\n  * unauthenticated - Credentials were not found or were not valid.\n  * not_found - The requested resource was not found.\n  * 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.\n  * 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.\n"
        message:
          type: string
          description: Human readable error message
        parameter:
          type: string
          description: The invalid parameter, if 'code' is invalid_parameter
    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'
        path:
          $ref: '#/components/schemas/path'
        workspaceId:
          $ref: '#/components/schemas/workspaceId'
        createdAt:
          $ref: '#/components/schemas/createdAt'
        updatedAt:
          $ref: '#/components/schemas/updatedAt'
        status:
          $ref: '#/components/schemas/status'
        templateName:
          $ref: '#/components/schemas/templateName'
        designApprovedDate:
          $ref: '#/components/schemas/designApprovedDate'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/AssignedTagsMetaRead'
          description: A list of Tags assigned to the Draft
    LocalizationKeyRead:
      type: object
      description: localization key
      properties:
        key:
          type: string
        comment:
          type: string
    draftId:
      type: string
      description: An opaque, unique identifier for a draft
      example: tdft_g3L7Cw6Hp5wU
    createdAt:
      type: string
      format: date-time
      description: The time of initial creation
    path:
      type: string
      description: The folder path location for this object
      example: fdr_01gb8vd6pz/fdr_01gqjmdbq/fdr_01gqjmg1
    PushContent:
      type: object
      description: push draft content
      properties:
        type:
          type: string
          example: Title
          description: What type of content this contains (Title, Body)
        value:
          type: string
          example: This is some text
          description: The value of the content
    localizationId:
      type: string
      description: An opaque, unique identifier for a localization
      example: loc_g3L7Cw6Hp5wUaf395LehwK
  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 "2026.06", set the value to "application/vnd.dyspatch.2026.06+json"
      schema:
        type: string
    draftId:
      name: draftId
      in: path
      description: A draft ID
      required: true
      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
    languageId:
      name: languageId
      in: path
      description: 'A language ID (eg: en-US)'
      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:
        - LOCKED_FOR_TRANSLATION
    pushTargetLanguage:
      name: targetLanguage
      in: query
      description: The type of templating language to use when compiling the content.
      required: false
      schema:
        type: string
        enum:
        - push
        - handlebars
        - liquid
        - django
        - jinja
        - handlebarsjava
    draftTemplateFilter:
      name: templateId
      in: query
      description: Filter drafts by template ID
      required: false
      schema:
        type: string
  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'
    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'
    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'
    Forbidden:
      description: Forbidden
      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'
    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.2026.06+json''

        ```

        '
x-tagGroups:
- name: Email
  tags:
  - Templates
  - Drafts
  - Localizations
- name: Platform
  tags:
  - Workspaces
  - Blocks
  - Tags
  - Customer Profiles
  - Themes
- name: Other Communication Channels
  tags:
  - SMS Templates
  - SMS Drafts
  - SMS Localizations
  - Push Templates
  - Push Drafts
  - Push Localizations
  - Live Activity Templates
  - Live Activity Drafts
  - Live Activity Localizations
  - Voice Templates
  - Voice Drafts
  - Voice Localizations