Skip to main content
POST
Create template

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
name
string
required

Unique template name (lowercase, underscores).

Example:

"order_confirmation"

category
string
required

Template category: AUTHENTICATION, MARKETING, or UTILITY.

Example:

"UTILITY"

language
string
required

Language/locale code (e.g. pt_BR, en_US).

Example:

"pt_BR"

components
object[]
required

Template component objects (header, body, footer, buttons).

Example:
allowCategoryChange
boolean

Allow Meta to reassign the category during review.

Example:

true

webhookUrl
string

URL notified about template status changes.

Example:

"https://example.com/webhooks/template-status"

Response

Success — provider-native response body.

The persisted template record. Evolution registers the template on the WhatsApp Business (Meta) API and stores the returned metadata locally, returning the saved DB row.

id
string
required

Internal Evolution record id (cuid).

templateId
string
required

Meta message template id (HSM id) returned by the WhatsApp Business API.

name
string
required

Template name.

template
object
required

Raw response object returned by the Meta message_templates create call.

instanceId
string
required

Id of the instance that owns the template.

webhookUrl
string | null

Optional webhook URL associated with the template.

createdAt
string<date-time> | null

Creation timestamp.

updatedAt
string<date-time>

Last update timestamp.