SautiDesk
SautiDesk API
Channels and templates

List starter message templates

GET
/v1/desk/templates/starters

Lists the ready-made starter templates that can be installed, such as order updates and appointment reminders. Each starter has a key used to install it.

Requires: desk.read scope, Converse licence.

Authorization

bearerAuth
AuthorizationBearer <token>

A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.

In: header

Query Parameters

cursor?string

next_cursor from the previous page. Leave it out for the first page.

limit?integer

Page size: 100 by default, 100 at most.

Response

OK

Example

{  "data": [    {      "key": "example-value",      "title": "Order 1182 has not arrived",      "purpose": "example",      "topic": "Order 1182 has not arrived",      "channels": [        {          "channel": null,          "category": null,          "subject": null,          "body": null,          "variables": null        }      ]    }  ],  "next_cursor": "eyJvIjoyNX0",  "has_more": false,  "activated": {    "example": [      "example"    ]  }}
FieldTypeDescription
datarequiredobject[]
keyrequiredstring
titlerequiredstringA short title.
purposerequiredstring
topicrequiredstring
channelsrequiredobject[]The channels to install the starter template on, for example sms and whatsapp.
channelrequiredstringThe channel to use: sms, whatsapp or email.
categoryrequiredstringThe name of the category.
subjectstringThe subject line.
bodyrequiredstringThe message text.
variablesrequiredobject[]The values for the template's placeholders, each by name.
next_cursorrequiredstring | null
has_morerequiredboolean
activatedrequiredobject
curl -X GET "https://api.sautidesk.com/v1/desk/templates/starters"