Skip to content

Create a message template

POST
/v1/message-templates
curl --request POST \
--url https://api.vocapable.com/v1/message-templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "locale": "en", "body": "example", "status": "draft" }'
Media typeapplication/json
MessageTemplateCreateRequest
object
name
required
Name
string
>= 1 characters <= 200 characters
locale
Locale
string
default: en >= 2 characters <= 35 characters
body
required
Body
string
>= 1 characters
status
Status
string
default: active
Allowed values: draft active

Successful Response

Media typeapplication/json
MessageTemplateSummary
object
id
required
Id
string
name
required
Name
string
locale
required
Locale
string
body
required
Body
string
status
required
Status
string
variables
required
Variables
Array<string>
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Examplegenerated
{
"id": "example",
"name": "example",
"locale": "example",
"body": "example",
"status": "example",
"variables": [
"example"
],
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}