Skip to main content
POST
Send 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

Approved template name.

Example:

"order_confirmation"

language
string
required

Template language/locale code (e.g. pt_BR).

Example:

"pt_BR"

number
string

Recipient phone in E.164 without +, or a JID.

Example:

"5511999999999"

components
object[]

Template components (header/body/button parameters).

Example:
webhookUrl
string

Optional per-message webhook URL for status callbacks.

Example:

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

Response

Success — provider-native response body.

Sent template message. Served by the Cloud API (Meta) channel; returns the persisted messageRaw envelope with the template rendered as a conversation preview.

key
object

Message key identifying the sent template message.

message
object

Rendered message content. Templates are stored as a conversation preview marked with the template name.

messageType
string

Content type; templates render as 'conversation'.

messageTimestamp
integer

Unix timestamp (seconds) when the message was accepted.

instanceId
string

Instance UUID that sent the message.

webhookUrl
string | null

Webhook URL configured for this instance (may be null).

status
enum<string>

Delivery status.

Available options:
ERROR,
PENDING,
SERVER_ACK,
DELIVERY_ACK,
READ,
PLAYED
source
string

Origin device; 'unknown' for Cloud API sends.