Skip to main content
PATCH
Update a Messenger channel

Authorizations

Authorization
string
header
required

Company API key, sent as Authorization: Bearer <key>. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.

Path Parameters

id
string
required
Example:

"fbp_xxx"

Body

application/json
name
string | null

Internal name, the name of the Page or of the Instagram account by default

Maximum string length: 255
agent_id
string | null

Agent answering on the channel; null detaches it

Example:

"AGI-XXXXX"

enabled
boolean

Disabled, received messages are ignored and nothing is sent

Response

200 - application/json

Always HTTP 200: the outcome is in success and code (absolute value of the response code).

success
boolean
Example:

true

code
integer
Example:

1000

message
string
Example:

"Request success."

body
object

Endpoint payload, null when there is none

token
string | null

Present only on authentication routes

trace_id
string | null

Present only when success is false