Create a message template

post

https://company_subdomain.talkpush.com/api/talkpush_services/messaging/templates

Creates a new Message Template for the company. The template is immediately available in the UI and can be referenced by autoflows.

Content format: The content field must use Handlebars syntax for dynamic tokens, e.g. Hi {{candidate_name}}, your interview for {{job_title}} is confirmed. All tokens used in content are validated against the company's available tokens (see GET /messaging/tokens). Unknown tokens return a 422 with the list of offending token names.

Type: Use email, sms, whatsapp, or messenger. The calendar type is not yet supported via the API.

Required fields: name, content, type, sub_type, category.

Query Params

api_key

string

required

The API key provided for your application.

Body Params

name

string

required

Display name for the template.

content

string

required

Template body in Handlebars format. Use {{token_id}} for dynamic values (see GET /messaging/tokens for available tokens).

type

string

enum

required

Communication channel. Must be one of email, sms, whatsapp, messenger. (calendar is not yet supported via the API.)

Allowed:

sub_type

string

required

Open-ended sub-classification (e.g. invitation, rejection, reminder). No fixed enum.

category

string

required

Free-form grouping for the template (e.g. onboarding, scheduling, rejection, offer, general).

locale

string

Defaults to en

BCP 47 language tag. Defaults to en when omitted.

settings

object

Optional channel-specific settings. For email templates, include subject_line here.

Responses

401

Missing, invalid, or inactive API key.

500

Internal server error; the response may include an exception message.

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Template created successfully.