Get campaign templates | Atlas

[
  {
    "assistant_id": "tpl-9f8a7c3d2b1e4a6f",
    "title": "Welcome Call - English Outbound",
    "description": "A friendly outbound call template to welcome new customers and provide onboarding information.",
    "language": "en-US",
    "type": "outbound",
    "voiceProvider": "11labs",
    "order": 1,
    "required_fields": [
      "customerName",
      "appointmentDate"
    ]
  },
  {
    "assistant_id": "tpl-3d2b1e4a6f9f8a7c",
    "title": "Customer Support - Spanish Inbound",
    "description": "Inbound call template for handling customer support inquiries in Spanish.",
    "language": "es-US",
    "type": "inbound",
    "voiceProvider": "minimax",
    "order": 2,
    "required_fields": [
      "ticketId"
    ]
  },
  {
    "assistant_id": "tpl-7c3d2b1e4a6f9f8a",
    "title": "Web Chat Greeting - Multilanguage",
    "description": "Web chat starter template that supports multiple languages for greeting visitors.",
    "language": "multilanguage",
    "type": "web",
    "voiceProvider": "11labs",
    "order": 3,
    "required_fields": []
  },
  {
    "assistant_id": "tpl-1e4a6f9f8a7c3d2b",
    "title": "SMS Promo Campaign - French",
    "description": "SMS message template for promotional campaigns targeting French-speaking customers.",
    "language": "fr-FR",
    "type": "messages",
    "voiceProvider": "minimax",
    "order": 4,
    "required_fields": [
      "promoCode",
      "expirationDate"
    ]
  }
]

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

Pass language to filter server-side, or omit it and filter client-side on the language field of each item.

Returns the catalog of starter templates used to seed `TemplateId` on `POST /campaign`. Each template is scoped to a `language` and a `type` (`outbound`, `inbound`, `web`, `messages`); present a picker that's filtered to the language and channel the user is creating. Pass `language` to filter server-side, or omit it and filter client-side on the `language` field of each item.

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

assistant_idstring

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

titlestring

Display name of the template.

descriptionstring

Optional descriptive copy.

languageenum

Language the template was authored in. Use this to filter the catalog for the user's selected language.

typeenum

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

voiceProviderenum

Voice engine the template is wired to.

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

500

Internal Server Error

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