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-9f8a7c6d2b3e4f1a",
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_number",
11         "customer_name"
12       ]
13     },
14     {
15       "assistant_id": "tpl-4b2d1e7f9c8a3b6d",
16       "title": "Inbound Support Line",
17       "description": "Inbound call template for customer support with routing options.",
18       "type": "inbound",
19       "order": 2,
20       "required_fields": []
21     },
22     {
23       "assistant_id": "tpl-7c3e5a9b1d2f4e6c",
24       "title": "Website Chat Assistant",
25       "description": "Web voice bubble template to assist visitors with FAQs and product info.",
26       "type": "web",
27       "order": 3,
28       "required_fields": [
29         "website_url"
30       ]
31     },
32     {
33       "assistant_id": "tpl-2a9f8b7c6d5e4f3a",
34       "title": "SMS Promotion Campaign",
35       "description": "SMS messaging template for sending promotional offers and updates.",
36       "type": "messages",
37       "order": 4,
38       "required_fields": [
39         "sms_sender_id",
40         "promotion_code"
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.

Response

Successful response

datalist of objects

Errors

500

Internal Server Error