Skip to main content
POST
Create a message template

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

inboxId
integer
required

The id returned when the inbox was created or listed.

Example:

3

Body

application/json

The template to submit to WhatsApp.

template
object
required

A WhatsApp template to submit for Meta review.

Response

Meta accepted the template for review. It is not usable until its status is approved.

A template accepted by Meta for review.

id
string | null

Meta's template id.

Example:

"1157693219400316"

name
string

The template name as submitted.

Example:

"order_shipped"

language
string

The template language as submitted.

Example:

"en_US"

category
string | null

The category Meta recorded, which can differ from the one requested. null only if Meta left it out.

Example:

"UTILITY"

status
string | null

Review status Meta assigned, normally PENDING. A template is not usable until it is approved. null only if Meta left it out.

Example:

"PENDING"