Sort service forms

Reorder forms attached to a service.

POST
/v1/services/{service_id}/forms/sort

Authorization

authorization
AuthorizationBearer <token>

In: header

Path Parameters

service_id*string

Service ID

Request Body

application/json

Sort params

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for reordering service forms.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/services/string/forms/sort" \  -H "Content-Type: application/json" \  -d '{    "ids": [      "sf_aaa111222333",      "sf_bbb444555666"    ]  }'
{  "data": [    {      "created_at": "2025-02-17T17:49:19Z",      "form_id": "frm_d025a96ac0c6",      "form_name": "Intake Form",      "id": "sf_d025a96ac0c6",      "object": "service_form",      "sort_order": 1,      "updated_at": "2025-02-17T17:49:19Z"    }  ]}

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.

Sync service conferencing POST

Re-apply the service's default conferencing to all of its providers, in alignment with the current default user mappings on the connected account. Use this after establishing or updating user mappings on the connection to push them onto the service's providers, without re-declaring the default. 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 the service has no default conferencing configured.