Skip to main content
POST
Unblock the contact of a conversation

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

conversationId
integer
required

The conversation's display_id — the number shown in the dashboard URL and delivered in webhooks. It is never the internal database id, and it is never the conversation's uuid: when all you have is a uuid or a helpdesk ticket id, resolve it to a display_id with Find a conversation first.

Example:

1042

Response

The state after the call: muted: false, the conversation status (unchanged) and the contact and inbox concerned. The same answer, with nothing written, when the customer was not blocked.

What a block or unblock left behind, read back after the write so it can be confirmed.

conversation_id
integer
required

The conversation the call was made on, by its display id.

Example:

1042

muted
boolean
required

Whether the customer is blocked on this inbox after the call: true after blocking, false after unblocking. It reflects a block set through the API or by the dashboard button.

Example:

true

status
enum<string>
required

The conversation status after the call. Blocking resolves the conversation; unblocking leaves the status as it was.

Available options:
open,
resolved,
pending,
snoozed,
proactive
Example:

"resolved"

contact
object | null
required

The customer who was blocked or unblocked, null on the rare conversation without one.

inbox
object
required

The inbox the block applies to. The same customer is not affected on any other inbox.