Change a custom API tool or switch it on or off
PATCH/v1/agents/:agentId/custom-api-tools/:toolId
x-scope: "custom_api:write"
Changes the parts you send. A change to the request (method, url, headers,
body_format, body, inputs) voids the last test, so the tool must pass a new test
before it can be switched on again; a tool already on stays on. active: true switches
the tool on only after a passing test of its current request (409 tool_not_tested
otherwise) and goes in a request of its own, without a request change (422 invalid_request otherwise). A tool can't move to another site, because its login is
the site's (422 invalid_request, param url). login changes the tool's login
under the same rules as on create. Every part is checked before any is saved, so a
refused change leaves the tool and its login as they were.
Request
Responses
- 200
- 401
- 403
- 404
- 409
- 413
- 422
- 429
- 500
- 503
The tool 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
custom_api:read or custom_api:write), agent_not_authorized (the
key is limited to other agents), shared_with_other_agents (the
tool's login is also used by tools of agents the key can't act on, so
the key can't add a tool to it or change it) or feature_not_available
(Custom API isn't on your company's plan).
Response Headers
Correlation id for this request — paste into support tickets.
agent_not_found when the agent is not one of your company's agents
(the API never confirms whether another company's agent exists);
not_found when the tool is not one of this agent's custom API tools;
endpoint_not_found for a path or method no endpoint serves, including
an id that is not a UUID.
Response Headers
Correlation id for this request — paste into support tickets.
login_shared: the login sent differs from the tool's saved one, or
carries a secret, and other tools use it; send change_shared_login: true to change it for all of them. tool_not_tested: active: true before a passing test of the
tool's current request.
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 for the operation, a
field has the wrong type, or a field breaks a limit in its schema (a
query parameter that doesn't parse, on listCustomApiToolRuns).
invalid_request when the tool breaks one of the rules the dashboard
checks too (its link, inputs, headers, body or login), or the cursor
isn't one this list gave out. param names the field when there is one,
and the message says what to change.
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.