Skip to main content

Set user mapping

PUT 
/v1/connected_accounts/:connected_account_id/user_mappings/:provider_id

Set the default user mapping between a provider and an external user on a connected account. The external user can be identified by ID or by email address (matched case-insensitively against the connected account's external users) — exactly one of the two must be provided. email is a convenience; when it matches no external user, the connected account's external users are refreshed from the provider and matching is retried once, so a freshly-added user can be mapped without a manual sync. Matching still fails with a 422 when the email matches zero (after a successful refresh) or multiple external users, so integrations that need determinism should resolve and use external_user_id. When the refresh itself cannot reach the provider (e.g. the connection needs to be re-authorized), a 502 is returned rather than a 422.

Setting a mapping replaces any existing mapping for the provider on this connected account, so this operation is an idempotent upsert.

Returns a 404 when the connected account does not exist, is not accessible to the current actor, or is not a conferencing connected account; or when the provider does not exist or has been deactivated.

Request​

Responses​

Success