API docs by Redocly

Dyspatch API (2019.03)

Download OpenAPI specification:Download

Dyspatch Support: support@dyspatch.io URL: https://docs.dyspatch.io Terms of Service

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 for more details on how to implement Dyspatch.

API Client Libraries

Dyspatch provides API Clients for popular languages and web frameworks.

Templates

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.

List Templates

Gets a list of Template Metadata objects for all templates. Up to 25 results returned before results are paginated.

Authorizations:
Bearer
query Parameters
cursor
string

A cursor value used to retrieve a specific page from a paginated result set.

header Parameters
Accept
required
string

A version of the API that should be used for the request. For example, to use version "2019.03", set the value to "application/vnd.dyspatch.2019.03+json"

Responses

Response samples

Content type
application/vnd.dyspatch.2019.03+json
{
  • "cursor": {
    },
  • "data": [
    ]
}

Get Template by ID

Gets a template object with the matching ID. Templates without a published draft will result in an error.

Authorizations:
Bearer
path Parameters
templateId
required
string

A template ID

query Parameters
targetLanguage
required
string
Enum: "html" "handlebars" "ampscript" "freemarker" "cheetah" "jinja"

The type of templating language to compile as. Should only be used for visual templates.

header Parameters
Accept
required
string

A version of the API that should be used for the request. For example, to use version "2019.03", set the value to "application/vnd.dyspatch.2019.03+json"

Responses

Response samples

Content type
application/vnd.dyspatch.2019.03+json
{
  • "id": "tem_g3L7Cw6Hp5wU",
  • "name": "string",
  • "description": "string",
  • "url": "/templates/tem_g3L7Cw6Hp5wUaf395LehwK",
  • "compiled": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "localizations": [
    ]
}

Localizations

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.

Get Localization Object by ID

Returns a specific localization object with a matching ID

Authorizations:
Bearer
path Parameters
localizationId
required
string

A localization ID

query Parameters
targetLanguage
required
string
Enum: "html" "handlebars" "ampscript" "freemarker" "cheetah" "jinja"

The type of templating language to compile as. Should only be used for visual templates.

header Parameters
Accept
required
string

A version of the API that should be used for the request. For example, to use version "2019.03", set the value to "application/vnd.dyspatch.2019.03+json"

Responses

Response samples

Content type
application/vnd.dyspatch.2019.03+json
{
  • "id": "loc_g3L7Cw6Hp5wUaf395LehwK",
  • "language": "en-US",
  • "url": "/localizations/loc_g3L7Cw6Hp5wUaf395LehwK",
  • "template": "tem_g3L7Cw6Hp5wU",
  • "compiled": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "name": "English (US)"
}