How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Dyspatch Push Drafts API

Push Drafts represent unpublished versions of templates that are still mutable. There could be many in progress drafts for a template.

Dyspatch Push Drafts API is one of 20 APIs that Dyspatch publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Push Drafts. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 16 operations across 12 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 2026.06.

Requests are made against a single base URL, https://api.dyspatch.io.

16 operations 12 paths 29 schemas 3 DELETE5 GET5 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026.06
Base URL
https://api.dyspatch.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Dyspatch Push Drafts API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer).

  • Bearer — Set Bearer followed by your API key as the Authorization header in your API requests. shell Authorization: Bearer EXAMPLEAPIKEYXXXXXXXX12345678 Below is an exa…

Paths & Operations 16

Across 12 paths, the API surfaces 16 operations — 3 DELETE, 5 GET, 5 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Push Drafts 16

Push Drafts represent unpublished versions of templates that are still mutable. There could be many in progress drafts for a template.

GET
/push/drafts
List Push Drafts
getPushDrafts 4 params → 200400401404429500default
POST
/push/drafts/{draftId}/publishRequest
Submit Push Draft for Approval
submitPushDraftForApproval 2 params → 200400401404429500default
POST
/push/drafts/{draftId}/publish/approve
Approve Push Draft
approvePushDraft 2 params body → 200400401404429500default
POST
/push/drafts/{draftId}/publish/approveAll
Approve Push Draft For All Reviewers
approvePushDraftForAll 2 params body → 200400401404429500default
POST
/push/drafts/{draftId}/publish/reject
Reject Push Draft
rejectPushDraft 2 params body → 200400401404429500default
POST
/push/drafts/{draftId}/duplicate
Duplicate Push Draft
duplicatePushDraft 2 params body → 200400401404429500default
PUT
/push/drafts/{draftId}/lockForTranslation
Lock Push Draft for Translation
lockPushDraftForTranslation 2 params → 204400401404429500default
DELETE
/push/drafts/{draftId}/lockForTranslation
Unlock Push Draft for Translation
unlockPushDraftForTranslation 2 params → 204400401404429500default
GET
/push/drafts/{draftId}
Get Push Draft by ID
getPushDraftById 3 params → 200400401404429500default
DELETE
/push/drafts/{draftId}
Archive Push Draft
archivePushDraft 2 params → 204400401404429500default
GET
/push/drafts/{draftId}/localizations
Get Localizations on a Push Draft
getPushLocalizationForDraft 2 params → 200400
PUT
/push/drafts/{draftId}/localizations/{languageId}
Create or Update a Push Localization
savePushLocalization 3 params body → 200400403
DELETE
/push/drafts/{draftId}/localizations/{languageId}
Remove a Localization from Push Draft
deletePushLocalization 3 params → 200400
GET
/push/drafts/{draftId}/localizations/{languageId}/translations
Get Push Draft Translations for Language
getPushTranslations 3 params → 200400401403404
PUT
/push/drafts/{draftId}/localizations/{languageId}/translations
Set Push Draft Translations for Language
setPushTranslation 3 params body → 200400401403
GET
/push/drafts/{draftId}/localizationKeys
Get Push Draft Localization Keys
getPushDraftLocalizationKeys 2 params → 200400

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are PushDraftRead (14 properties), DraftMetaRead (12 properties), LocalizationMetaRead (6 properties), APIError (3 properties). Each schema is shown below with its type and property counts.

workspaceId
string
The workspace this object belongs to
PushDraftRead
object
template draft metadata included latest draft revision
14 properties
LocalizationKeyRead
object
localization key
2 properties
localizationUrl
string
The API url for a specific localization
draftId
string
An opaque, unique identifier for a draft
localeGroupId
string
the locale group this localization belongs to, if this field is empty the localization does not belong to any locale group
AssignedTagsMetaRead
object
assigned tags metadata
2 properties
templateName
string
The name of a template
createdAt
string
The time of initial creation
DraftsRead
object
list of draft metadata
2 properties
templateId
string
An opaque, unique identifier for a template
draftUrl
string
The API url for a specific draft
localizationName
string
The user-specified name of a localization
tagName
string
The user-specified name of a tag
DraftMetaRead
object
draft metadata
12 properties
variables
array
a list of variables used in the template
APIError
object
possible errors from the api
3 properties
localizationId
string
An opaque, unique identifier for a localization
languages
array
a list of locale codes that are available in the localization. See [supported languages](https://docs.dyspatch.io/localization/supportedlanguages/) for an exha…
cursor
object
Information about paginated results
2 properties
draftName
string
The name of a draft
tagId
string
tag01gpe172x7p6aa1c9grr48efq8
path
string
The folder path location for this object
PushContent
object
push draft content
2 properties
designApprovedDate
string
If using the design approval workflow this is the date the template draft design was approved, otherwise it will be empty.
updatedAt
string
The time of last update
status
string
The status of the current draft: - INPROGRESS: Draft is actively being edited - PENDINGAPPROVAL: Draft is awaiting approval - LOCKEDFORTRANSLATION: Draft is lo…
PushCompiledRead
object
revision data
2 properties
LocalizationMetaRead
object
localization metadata
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dyspatch-push-drafts-api-openapi.yml Raw ↑

Other APIs Dyspatch publishes across the network.

Dyspatch Blocks API
Dyspatch Customer Profiles API
Dyspatch Drafts API
Dyspatch Live Activity Drafts API
Dyspatch Live Activity Localizations API
Dyspatch Live Activity Templates API
Dyspatch Localizations API
Dyspatch Push Localizations API
Dyspatch Push Templates API
Dyspatch SMS Drafts API
Dyspatch SMS Localizations API
Dyspatch SMS Templates API
Where this information came from

This is an independent, third-party profile of Dyspatch Push Drafts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.