Re-point an inbound agent
Point an existing inbound agent at a different agent of yours.
Point an existing inbound agent at a different agent of yours.
This rewrites the application's call-handling endpoints so that incoming
calls are answered by agent_id instead. It is the supported way to swap
the agent behind a live phone number without re-provisioning the number, and
it takes effect on the next inbound call.
Both ends are checked against your organisation before anything is written:
an application_sid that is not yours answers 404, and so does an
agent_id that is not yours. The webhook URLs themselves are derived
server-side and are not accepted as input.
Rate limit: 1000 requests per minute per organization (bucket default). Exceeding it returns 429 with Retry-After; the X-RateLimit-* response headers report your remaining allowance on every call.
v2/inbound-agents/{application_sid}/webhooksAuthorization
AuthorizationRequiredBearer <token>
Your Graine API key. Create one in the dashboard under Developers, or via POST /v2/api-keys. Send it as Authorization: Bearer <key>.
In: header
Request Body
application/jsonRequiredagent_idRequiredAgent Id
The agent that should answer calls routed here. Must belong to your organisation.
Path Parameters
application_sidRequiredApplication Sid
The inbound application to update, from GET /v2/inbound-agents.
Query Parameters
organization_idOrganization Id
Must match the organisation the API key belongs to.
Response Body
200
The application and the agent that now answers it.
application_sidRequiredApplication Sid
The application that was updated.
agent_idRequiredAgent Id
The agent that now answers calls routed here.
updatedUpdated
Always true; a failure is reported as an error envelope.
true400
1000 — malformed or contradictory input (bad transfer target, bad timeout).
errorRequiredError
Stable integer code from the /v2 error table.
messageRequiredMessage
Human-readable single sentence.
401
1100 — missing, unknown or inactive API key. 1101 — a browser session token was presented.
errorRequiredError
Stable integer code from the /v2 error table.
messageRequiredMessage
Human-readable single sentence.
402
1400 — the organisation has insufficient credits for this request.
errorRequiredError
Stable integer code from the /v2 error table.
messageRequiredMessage
Human-readable single sentence.
403
1102 — the key is valid but lacks the scope this endpoint requires, or names another organisation. GET /v2/scopes reports which scopes the key holds.
errorRequiredError
Stable integer code from the /v2 error table.
messageRequiredMessage
Human-readable single sentence.
404
1200 — no such resource in this organisation. Cross-tenant reads answer 404, never 403.
errorRequiredError
Stable integer code from the /v2 error table.
messageRequiredMessage
Human-readable single sentence.
422
1001 — the body or query failed validation; the message names the first offending field.
errorRequiredinteger
Stable integer code from the error table. Branch on this, not on the message.
messageRequiredstring
One human-readable sentence. Wording may change; the code will not.
429
1300 — per-organisation rate limit exceeded. Carries Retry-After.
errorRequiredError
Stable integer code from the /v2 error table.
messageRequiredMessage
Human-readable single sentence.
503
1501 — the telephony service is unreachable or returned a 5xx.
errorRequiredError
Stable integer code from the /v2 error table.
messageRequiredMessage
Human-readable single sentence.
504
1502 — the telephony service did not respond in time.
errorRequiredError
Stable integer code from the /v2 error table.
messageRequiredMessage
Human-readable single sentence.
The application and the agent that now answers it.