Switch the AI on or off for a connection
PATCH/v1/agents/:agentId/connections/:connectionId
x-scope: "connections:write"
Whether the agent's AI answers this channel's messages, its comments, or both. Send at
least one (422 no_settings otherwise). With messages off, incoming messages still
reach the dashboard and the AI doesn't reply to them, but follow-ups already scheduled on
that channel still go out. Follow-ups are set per platform, not per connection: removing
the platform from the follow-up platforms stops them on every connection of that
platform on the agent. With comments off, Mojeeb ignores the channel's new comments: they
are neither answered nor recorded, and switching comments back on doesn't fetch them.
Comments apply to Facebook and Instagram.
A disconnected connection (active: false) can't be changed (409 connection_inactive).
Reconnecting in the dashboard sets both switches from its connect screen, so set them
again afterwards.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 413
- 422
- 429
- 500
- 503
The connection as it now is.
Response Headers
Correlation id for this request — paste into support tickets.
Authentication failed. Single code (invalid_api_key) covers every
sub-case: missing header, wrong scheme, malformed, unknown, revoked or
expired key. The message field disambiguates for humans debugging.
One exception: when the key could not be checked because of a server-side
fault, the status is still 401 but type is internal_error and code
is internal_server_error; retry with backoff.
Response Headers
Correlation id for this request — paste into support tickets.
Authenticated, but not allowed: insufficient_scope (the key lacks the scope in this
operation's x-scope) or agent_not_authorized (the key is limited to other agents).
Response Headers
Correlation id for this request — paste into support tickets.
not_found when the connection isn't one of this agent's channels; agent_not_found when
the agent is not one of your company's agents. endpoint_not_found when an id in the path isn't a UUID.
Response Headers
Correlation id for this request — paste into support tickets.
The connection is disconnected (active: false), so its settings
can't be changed. Nothing was changed. Reconnect it in the dashboard
first.
Response Headers
Correlation id for this request — paste into support tickets.
The request body is larger than 1 MB.
Response Headers
Correlation id for this request — paste into support tickets.
invalid_request_body when the body isn't valid JSON, a field has the wrong type or format, or a field breaks a limit in its schema; param names the field. no_settings when nothing to change was sent.
Response Headers
Correlation id for this request — paste into support tickets.
Per-key rate limit hit. Default is 60/min/key; an endpoint with an
x-rate-limit-per-minute of its own counts in a budget of its own
(today listWhatsAppTemplates, which allows 10/min/key, and
sendConversationMessage, which allows 20/min/key), and its 429
reports that limit in X-RateLimit-Limit. Retry-After tells you when to retry;
X-RateLimit-Reset is the Unix timestamp of the next window.
Per-success-response
X-RateLimit-*headers are a known gap; on 2xx responses these headers are NOT currently emitted. Customers should rely on 429 +Retry-Afterfor backoff signals.
Response Headers
Correlation id for this request — paste into support tickets.
Seconds to wait before retrying.
The per-minute request limit of the endpoint called. Every key has the same limits today.
Remaining requests in the current window. 0 on rejection.
Unix timestamp at which the current window resets.
Unexpected server-side failure. Retry with exponential backoff. If
the failure persists, send us the correlation_id.
Response Headers
Correlation id for this request — paste into support tickets.
Mojeeb couldn't check access because of a temporary fault: the key's,
or on assignLead and assignConversation the teammate's. Nothing was
changed. Retry with backoff.
Response Headers
Correlation id for this request — paste into support tickets.