Campaigns

GET /v1/campaigns/templates/{templateId}

One campaign template.

All Campaigns endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/campaigns/templates/{templateId} \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

One template, including its rendered magic-tag list so an editor can show which values a send will substitute and what each one falls back to.

Parameters

NameTypeRequiredWhat it is
templateId (path)stringYes

Response

NameTypeRequiredWhat it is
idstringYes
org_idstringYes
namestringYes
purposestring<marketing, transactional>Yes
subjectstringYes
bodystringYes
channelsstring[]Yes
archivedbooleanYes
created_atstringYes
updated_atstringYes

Errors this endpoint can return

401 · 403 · 404