Skip to main content
PATCH
Update the satisfaction survey of an inbox

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 fields to change go under csat_survey.

csat_survey
object
required

The fields to change, at least one of them.

Response

The satisfaction survey after the update.

The satisfaction survey of one inbox.

id
integer
required

The id of the inbox the survey belongs to.

Example:

3

name
string
required

Inbox name.

Example:

"Support WhatsApp"

channel_type
string | null
required

Channel::WebWidget, Channel::Email or Channel::Whatsapp.

Example:

"Channel::Whatsapp"

requires_approval
boolean
required

True on a WhatsApp Cloud inbox, where the survey is a message template Meta has to approve before it is delivered.

Example:

true

format
enum<string> | null
required

The scale: full_5 is a rating from 1 to 5 followed by a comment step, rating_5 is the rating only. Null while the inbox has no survey.

Available options:
full_5,
rating_5
Example:

"full_5"

language
enum<string> | null
required

Language of the survey. Null while the inbox has no survey.

Available options:
en,
es,
pt_BR
Example:

"pt_BR"

content
object
required

The texts of the survey. A key that was never set is absent.

status
enum<string>
required

unconfigured: no survey yet. ready: web widget and email, the survey is live. not_created: WhatsApp, the template was not submitted yet. pending: Meta is reviewing it. approved: it is delivered. rejected: Meta refused it. failed: the submission to Meta failed, see provisioning_error.

Available options:
unconfigured,
ready,
not_created,
pending,
approved,
rejected,
failed
Example:

"pending"

provisioning_error
object | null
required

Why the last submission to Meta failed. Null when there is none, and always null outside WhatsApp Cloud.