API Reference

Create a message template.

post
https://localhost/v4/templates

Create a message template.

Required scope: write_templates.

📘

Message Variables

While template bodies support Podium Inbox variables, our Send a Message endpoint does not support variables. If a variable exists in the template that you wish to send, you must fill in the variables yourself before sending.

Body Params

Create template params

string
enum
required

The access level of the template. Must be 'location' or 'organization'.

Allowed:
string | null

URL of template attachment.

locationUids
array of uuids | null

list of locations or empty list. Required when 'accessLevel' is 'location'.

locationUids
boolean
Defaults to false

If the template can be deleted.

string

The template subject.

string
required

Text of the template message.

string
required

Title of the template.

string
enum
required

Type of the template. Must be 'custom, 'review_invite', or 'review_invite_backup'

Allowed:
Responses

Callback

Updated 24 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago