Transfer customers between agents
Move customers from one agent to another in a single call. Requires the org:agents:write permission. Both agents must be visible to the caller, and the destination agent must be able to take new customers. Every customer in customer_user_ids must have an active assignment to the source agent. from_user_id and to_user_id must differ. Returns 404 when either agent does not exist.
Authorization
oauth2 Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.
In: header
Request Body
application/json
Request to transfer customers between agents.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/agents/customers/transfers" \ -H "Content-Type: application/json" \ -d '{ "from_user_id": "550e8400-e29b-41d4-a716-446655440000", "to_user_id": "550e8400-e29b-41d4-a716-446655440002", "customer_user_ids": [ "550e8400-e29b-41d4-a716-446655440001" ] }'{ "code": "BAD_REQUEST", "description": "Bad Request"}{ "code": "UNAUTHORISED", "description": "Unauthorised"}{ "code": "FORBIDDEN", "description": "Forbidden"}{ "code": "BAD_REQUEST", "description": "Invalid input"}{ "code": "RATE_LIMIT_EXCEEDED", "description": "Too Many Requests"}{ "code": "INTERNAL_ERROR", "description": "Internal Server Error"}Create an agent POST
Register a user as an agent in the caller's organization. Requires the `org:agents:write` permission. The user must exist in the organization and must not already be an agent. The supervisor named in `supervisor_user_id`, when set, must be an active agent able to supervise the requested role. Returns 404 if the user or the supervisor does not exist, and 409 if the user is already an agent.
Get the caller's agent profile GET
Get the caller's own agent profile. Requires the `org:agents:read` permission. Returns 403 when the caller is not an agent in the granted organization.