Get campaign templates

GET

https://api.youratlas.com/v1/api/campaign/templates

GET

/v1/api/campaign/templates

$ curl https://api.youratlas.com/v1/api/campaign/templates \
>      -H "api-key: <apiKey>" \
>      -H "Content-Type: application/json"

1 {
2   "data": [
3     {
4       "assistant_id": "tpl-8f3a2c9b",
5       "title": "New Customer Welcome Call",
6       "description": "A friendly outbound call template to welcome new customers and introduce services.",
7       "type": "outbound",
8       "order": 1,
9       "required_fields": [
10         "customer_phone",
11         "agent_id"
12       ]
13     },
14     {
15       "assistant_id": "tpl-4d7e1f23",
16       "title": "Inbound Support Line",
17       "description": "Inbound campaign template for handling customer support calls efficiently.",
18       "type": "inbound",
19       "order": 2,
20       "required_fields": [
21         "support_queue_id"
22       ]
23     },
24     {
25       "assistant_id": "tpl-9b6c5d8e",
26       "title": "Website Chat Widget",
27       "description": "Engage visitors with a proactive chat bubble on your website.",
28       "type": "web",
29       "order": 3,
30       "required_fields": []
31     },
32     {
33       "assistant_id": "tpl-2a1f7b4c",
34       "title": "SMS Promotion Blast",
35       "description": "Send promotional SMS messages to your subscriber list.",
36       "type": "messages",
37       "order": 4,
38       "required_fields": [
39         "sms_sender_id",
40         "message_template_id"
41       ]
42     }
43   ]
44 }

Returns the catalog of starter templates used to seed TemplateId on POST /campaign. Each template targets a type (outbound, inbound, web, messages); present a picker filtered to the channel the user is creating.

Pass the language query parameter to filter the catalog server-side by language. The returned template items do not carry a language field, so filter by language via this query parameter rather than client-side.

Returns the catalog of starter templates used to seed `TemplateId` on `POST /campaign`. Each template targets a `type` (`outbound`, `inbound`, `web`, `messages`); present a picker filtered to the channel the user is creating. Pass the `language` query parameter to filter the catalog server-side by language. The returned template items do not carry a `language` field, so filter by language via this query parameter rather than client-side.

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Query parameters

languageenumOptional

BCP-47 language code. Supported: en-US (English), es-US (Spanish), de (German), ro-RO (Romanian), fr-FR (French), hi-IN (Hindi), he-IL (Hebrew), tr-TR (Turkish), or multilanguage (Multilingual). Omit to return all languages.

BCP-47 language code. Supported: `en-US` (English), `es-US` (Spanish), `de` (German), `ro-RO` (Romanian), `fr-FR` (French), `hi-IN` (Hindi), `he-IL` (Hebrew), `tr-TR` (Turkish), or `multilanguage` (Multilingual). Omit to return all languages.

Response

Successful response

datalist of objectsOptional

Errors

500

Internal Server Error