Dyspatch API Changelog

Whenever a backwards-incompatible change is introduced we release a new dated API version. Use an Accept header to specify the version used when making API calls:

curl --request GET \
--url https://api.dyspatch.io/templates \
--header 'Authorization: Bearer EXAMPLEAPIKEYXXXXXXXX12345678' \
--header 'Accept: application/vnd.dyspatch.2024.12+json'

The latest version is 2024-12.

Earlier versions of the API can be accessed by clicking a title below.

2024-12

• Current version is now 2024.12
• New Added Email Draft endpoints
  • Approve Draft: /drafts/{draftId}/publish/approve
  • Approve Draft For All Reviewers: /drafts/{draftId}/publish/approveAll
  • Reject Draft: /drafts/{draftId}/publish/reject
• New Added SMS Draft endpoints
  • Approve SMS Draft: /sms/drafts/{draftId}/publish/approve
  • Approve SMS Draft For All Reviewers: /sms/drafts/{draftId}/publish/approveAll
  • Reject SMS Draft: /sms/drafts/{draftId}/publish/reject
• New Added Push Draft endpoints
  • Approve Push Draft: /push/drafts/{draftId}/publish/approve
  • Approve Push Draft For All Reviewers: /push/drafts/{draftId}/publish/approveAll
  • Reject Push Draft: /push/drafts/{draftId}/publish/reject
• New Added Voice Draft endpoints
  • Approve Voice Draft: /voice/drafts/{draftId}/publish/approve
  • Approve Voice Draft For All Reviewers: /voice/drafts/{draftId}/publish/approveAll
  • Reject Voice Draft: /voice/drafts/{draftId}/publish/reject

2024-11

• Current version is now 2024.11
• New Added Push Template endpoints
  • List Push Templates: /push/templates
  • Get Push Template by ID: /push/templates/{templateId}/
  • Render Push Template by ID: /push/render/template/{templateId}/
  • Render Localized Push Template by ID: /push/render/template/{templateId}/{languageId}/
• New Added Push Draft endpoints
  • List Push Drafts: /push/drafts
  • Submit Push Draft for Approval: /push/drafts/{draftId}/publishRequest
  • Get Push Draft by ID: /push/drafts/{draftId}
  • Get Localizations on an Push Draft: /push/drafts/{draftId}/localizations
  • Create or Update an Push Localization: /push/drafts/{draftId}/localizations/{languageId}
  • Remove a Localization from Push Draft: /push/drafts/{draftId}/localizations/{languageId}
  • Set Push Draft Translations for Language: /push/drafts/{draftId}/localizations/{languageId}/translations
  • Get Push Draft Localization Keys: /push/drafts/{draftId}/localizationKeys
• New Added Push Localization endpoints
  • Get Push Localization Object by ID: /push/localizations/{localizationId}
  • Get Push Draft Localization Object by ID: /push/localizations/{localizationId}/drafts/{draftId}
• New Added Voice Template endpoints
• List Voice Templates: /voice/templates
• Get Voice Template by ID: /voice/templates/{templateId}/
• Render Voice Template by ID: /voice/render/template/{templateId}/
• Render Localized Voice Template by ID: /voice/render/template/{templateId}/{languageId}/
• New Added Voice Draft endpoints
  • List Voice Drafts: /voice/drafts
  • Submit Voice Draft for Approval: /voice/drafts/{draftId}/publishRequest
  • Get Voice Draft by ID: /voice/drafts/{draftId}
  • Get Localizations on an Voice Draft: /voice/drafts/{draftId}/localizations
  • Create or Update an Voice Localization: /voice/drafts/{draftId}/localizations/{languageId}
  • Remove a Localization from Voice Draft: /voice/drafts/{draftId}/localizations/{languageId}
  • Set Voice Draft Translations for Language: /voice/drafts/{draftId}/localizations/{languageId}/translations
  • Get Voice Draft Localization Keys: /voice/drafts/{draftId}/localizationKeys
• New Added Voice Localization endpoints
  • Get Voice Localization Object by ID: /voice/localizations/{localizationId}
  • Get Voice Draft Localization Object by ID: /voice/localizations/{localizationId}/drafts/{draftId}

2024-08

• Adds an updatedAt field to localizations for the following endpoints:
  • /templates
  • /templates/{templateId}
  • /drafts
  • /drafts/{draftId/}
  • /drafts/{draftId}/localizations
  • /sms/templates
  • /sms/templates/{templateId}
  • /sms/drafts
  • /sms/drafts/{draftId/}
  • /sms/drafts/{draftId}/localizations
  • /blocks/{blockId}/localizations

2024-07

• New Added Render Localized Template by ID endpoint: /render/template/{templateId}/{languageId}
• New Added SMS Template endpoints
  • List SMS Templates: /sms/templates
  • Get SMS Template by ID: /sms/templates
  • Render SMS Template by ID: /sms/templates
  • Render Localized SMS Template by ID: /sms/templates
• New Added SMS Draft endpoints
  • List SMS Drafts: /sms/drafts
  • Submit SMS Draft for Approval: /sms/drafts/{draftId}/publishRequest
  • Get SMS Draft by ID: /sms/drafts/{draftId}
  • Get Localizations on an SMS Draft: /sms/drafts/{draftId}/localizations
  • Create or Update an SMS Localization: /sms/drafts/{draftId}/localizations/{languageId}
  • Remove a Localization from SMS Draft: /sms/drafts/{draftId}/localizations/{languageId}
  • Set SMS Draft Translations for Language: /sms/drafts/{draftId}/localizations/{languageId}/translations
  • Get SMS Draft Localization Keys: /sms/drafts/{draftId}/localizationKeys
• New Added SMS Localization endpoints
  • Get SMS Localization Object by ID: /sms/localizations/{localizationId}
  • Get SMS Draft Localization Object by ID: /sms/localizations/{localizationId}/drafts/{draftId}

2023-07

• Change /drafts/{draftId} and /drafts updated
  • designApprovedDate is now included in the draft responses.

2023-03

• New Added block localization endpoint /blocks/{blockId}/localizations.
• New Added block localization keys endpoint /blocks/{blockId}/localizationKeys.
• New Added block localization create/delete endpoint /blocks/{blockId}/localizations/{languageId}.
• New Added block localization translation update endpoint /blocks/{blockId}/localizations/{languageId}/translations.

2023-02

• New Added template render API endpoint /render/template/{templateId}.
• New Added block API endpoints /blocks/ and /blocks/{blockId}.

2023-01

• New Added workspace API endpoints /workspaces and /workspaces/{folderId}.
• Change /drafts/{draftId} and /drafts updated
  • templateName is now included in the draft responses.
  • status is now included in the draft response and reflects the status of the draft (IN_PROGRESS, LOCKED_FOR_TRANSLATION, PENDING_APPROVAL)
  • path and workspaceId are included in the draft responses, refecting where the draft fits in the folder hierarchy.
• Change /templates/{templateId} and /templates updated
  • publishedDraftId is included in the template responses and reflects the id of the currently published draft.
  • path and workspaceId are included in the template responses, refecting where the template fits in the folder hierarchy.

2020-11

• New Add ampHtml parameter to all compiled objects to support AMP output.
• New new endpoint /localizations/:draftId/localizations/:localizationId to return the value for a localization ID at a particular draft.
• Change url in draft localizations list will point to this new endpoint.

2020-04

• Add ability to create localizations that reference locale groups.
• Updated /drafts/{draftId} and /templates/{templateID}
  • language field has been renamed to languages and returns an array of languages.
  • localization has been renamed to id.

2019-10

• Add new /localizations/... endpoints for localization management.
• Draft content is available from the /drafts/... endpoints.
• A draft can be submitted for approval with a request to /drafts/{draftId}/publishRequest.

2019-03

• The first public version of the Dyspatch API.
• Add new required field targetLanguage to get template by ID method.
  • Required for versions after 2019.01.beta.
• Add new required field targetLanguage to get localization by ID method.
  • Required for versions after 2019.01.beta.