Skip to main content
PATCH
Update 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

name
string
required

Name of the template to edit, exactly as List message templates returns it. It cannot be changed.

Example:

"reactivation_september"

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 edited template.

template
object
required

The new content of an existing WhatsApp template. name and category are not accepted.

Response

Meta accepted the edit for review.

A template whose edit Meta accepted for review.

id
string

Meta's template id.

Example:

"1157693219400316"

name
string

The template name.

Example:

"order_shipped"

language
string

The template language.

Example:

"en_US"

category
string | null

The template category as last synced. null if the catalogue entry carries none.

Example:

"UTILITY"