Passer au contenu principal
PATCH
Update an Instagram channel

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

id
string
requis
Exemple:

"iga_xxx"

Corps

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

Exemple:

"AGI-XXXXX"

enabled
boolean

Disabled, received messages are ignored and nothing is sent

Réponse

200 - application/json

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

success
boolean
Exemple:

true

code
integer
Exemple:

1000

message
string
Exemple:

"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