Skip to main content

Upload the app's agent roster

PUT 
/app/agents

The partner's agents for this install (telephony contract §9.4): up to 1,000 per call, upserted by external_id (an agent the list leaves out keeps its row), each matched to an active workspace member by email. A match an admin made by hand is never overwritten, and a blank email keeps the stored one (and the match made on it).

The answer's user is the matched member while they are still active; a match whose member left — by email or by hand — reads how: none here, so manual with user: null is only ever an admin's "No KudosCRM user" (Manage reads the stored how). Calls are attributed by the same rule.

The install's own OAuth token only: a personal access token or a legacy app credential is 403 resource_not_grantable (/app/* is open to OAuth tokens alone), a person's session 403 install_token_required; the token needs users:read (403 insufficient_scope, meta.required_scope: users:read); the app must be on the telephony contract (403 telephony_contract_required). A paused install is 503 app_paused, a suspended app 403 app_suspended. Throttle: app/agents/install, 30 a minute.

Request​

Responses​

Each agent sent, as stored now, in the order given.