/v1/conversation_templates

List the templates that can be used to start a conversation.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Lists the message templates that can be used to start a conversation with /v1/start_conversation. Only approved templates are returned; any template that is awaiting content approval is omitted, since it cannot be sent until it is approved.

This endpoint takes no parameters.

Each template in the response includes:

FieldTypeDescription
idStringPass this as template_id to /v1/start_conversation. It may be a built-in template name (e.g. default_appointment_reminder_sms) or the numeric id of one of your own templates.
nameStringThe human-readable template name.
comm_typesObjectWhich channels the template supports. Each key is a boolean: sms, email, and call (where call is a voice call). Use this to decide the type to pass to /v1/start_conversation.

Example response:

{
  "templates": [
    {
      "id": "default_appointment_reminder_sms",
      "name": "Default Appointment Reminder",
      "comm_types": { "sms": true, "email": false, "call": false }
    },
    {
      "id": "12345",
      "name": "My Custom Email Follow-up",
      "comm_types": { "sms": false, "email": true, "call": false }
    }
  ]
}

OAuth scope

Calls authenticated with an OAuth 2.0 bearer token must include the messaging:read scope. A token without it receives a 403 insufficient_scope response. HTTP Basic auth is not scope-gated.

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!