API ReferenceServices

Set service provider conferencing

Set the conferencing configuration for a service provider. The hosting external user can be identified by ID or by email address (matched case-insensitively against the connected account's external users) — exactly one of external_user_id or email 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 selected 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.

The external user must belong to the connected account, which must be a conferencing connection on the same account as the service provider.

Setting conferencing replaces any existing configuration for the service provider, so this operation is an idempotent upsert.

Returns a 404 when the service or provider does not exist, the provider is not assigned to the service, or the service provider is not accessible to the current actor.

PUT
/v1/services/{service_id}/providers/{provider_id}/conferencing

Authorization

authorization
AuthorizationBearer <token>

In: header

Path Parameters

service_id*string

The service's unique identifier

Match^srv_\w{12}$
provider_id*string

The provider's unique identifier

Match^prov_\w{12}$

Request Body

application/json

Service provider conferencing params

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for setting a service provider's conferencing configuration. The connected account must be a conferencing connection (e.g., Zoom). Exactly one of external_user_id or email must be provided to identify the hosting external user, which must belong to the connected account.

Request schema for setting a service provider's conferencing configuration. The connected account must be a conferencing connection (e.g., Zoom). Exactly one of external_user_id or email must be provided to identify the hosting external user, which must belong to the connected account.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/services/srv_abcdef123456/providers/prov_abcdef123456/conferencing" \  -H "Content-Type: application/json" \  -d '{    "connected_account_id": "cact_d025a96ac0c6",    "external_user_id": "exusr_d025a96ac0c6"  }'
{  "data": {    "conferencing_provider": "zoom_admin",    "connected_account": {      "connection_scope": "user",      "created_at": "2025-03-12T12:34:55Z",      "display_name": "John Doe",      "email": "user@example.com",      "external_account_id": null,      "external_subject": "123456789",      "id": "cact_d025a96ac0c6",      "object": "connected_account",      "provider": "google",      "status": "active",      "updated_at": "2025-03-13T10:11:12Z",      "user_id": "user_d025a96ac0c6"    },    "external_user": {      "email": "dr.smith@example.com",      "first_name": "Jane",      "id": "exusr_d025a96ac0c6",      "last_name": "Smith",      "object": "external_user",      "status": "active"    },    "object": "service_provider_conferencing",    "provider_id": "prov_d025a96ac0c6",    "service_id": "srv_d025a96ac0c6"  }}

Set service conferencing PUT

Set a service's default conferencing and configure every provider on the service from their default user mappings on the connected account. Providers without a default user mapping are skipped (reported in the response, not an error). Returns a 404 when the service does not exist or is not accessible to the current actor, and a 422 when `connected_account_id` does not reference a conferencing connection on the service's account.

Sort service forms POST

Reorder forms attached to a service.