Get template detail | Atlas

Authentication

api-keystring

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

Path parameters

idstringRequired

Response

Successful response

assistant_idstring

Template ID. Pass this value as TemplateId when calling POST /campaign.

titlestring

Display name of the template.

descriptionstring

Optional descriptive copy.

typeenum

Campaign channel the template targets. Match against the campaign being created — outbound/inbound for phone, web for voice bubble, messages for SMS.

orderinteger

Display order within the language + type group.

required_fieldslist of strings

Fields that must be supplied on POST /campaign when using this template. Empty array means no extras beyond the standard payload.

Errors

404

Not Found Error

500

Internal Server Error

1	{
2	"assistant_id": "tpl_9f8b7c6d5e4a3b2c1d0e",
3	"title": "Spring Sale Outreach",
4	"description": "Template for outbound campaigns targeting customers with spring sale promotions.",
5	"type": "outbound",
6	"order": 3,
7	"required_fields": [
8	"customer_phone",
9	"sale_code"
10	]
11	}