API ReferenceServices

Set service conferencing

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.

PUT
/v1/services/{service_id}/conferencing

Authorization

authorization
AuthorizationBearer <token>

In: header

Path Parameters

service_id*string

The service's unique identifier

Match^srv_\w{12}$

Request Body

application/json

Service conferencing params

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for setting a service's default conferencing. The conferencing provider is inferred from the connected account. Setting the default also configures every provider on the service from their default user mappings on the connected account; providers without a mapping are skipped.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/services/srv_abcdef123456/conferencing" \  -H "Content-Type: application/json" \  -d '{    "connected_account_id": "cact_d025a96ac0c6"  }'
{  "data": {    "configured": [      {        "provider_id": "prov_d025a96ac0c6"      }    ],    "skipped": [      {        "provider_id": "prov_a1b2c3d4e5f6",        "reason": "no_user_mapping"      }    ]  }}

List services GET

List all services for an account

Set service provider conferencing PUT

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.