API ReferenceConnected accounts

Sync external users

Refresh the external users for a connected account by syncing them from the provider (e.g., pulling the current list of users from a connected Zoom account). New users are added, existing users are updated, and users no longer present at the provider are removed. Returns the full, refreshed list of external users.

Returns a 404 when the connected account does not exist, is not accessible to the current actor, or is not a conferencing connected account. Returns a 502 when the provider could not be reached or rejected the request (e.g. the connection needs to be re-authorized).

POST
/v1/connected_accounts/{connected_account_id}/external_users/sync

Authorization

authorization
AuthorizationBearer <token>

In: header

Path Parameters

connected_account_id*string

The connected account's unique identifier

Match^cact_\w{12}$

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/connected_accounts/cact_abcdef123456/external_users/sync"
{  "data": [    {      "email": "dr.smith@example.com",      "first_name": "Jane",      "id": "exusr_d025a96ac0c6",      "last_name": "Smith",      "object": "external_user",      "status": "active"    }  ]}