跳到导航
ReceptionWorkspaces

Create Reseller Workspace

Create a workspace for one of your customers, optionally with a tier, a phone number and team invites.

请求头

xi-api-keystring可选

请求

This endpoint expects an object.
business_namestring必需1-100 characters
subscriptionobject or null可选
Paid tier to subscribe to. Omitted leaves the workspace with no subscription.
phone_numberstring or null可选
A free number from the reseller's phone pool, reserved for the workspace until onboarding binds it to the receptionist.
memberslist of objects可选默认为 []

People to invite once the workspace exists, capped by the tier’s team size. Best-effort: each outcome is in member_results.

complete_onboardingboolean可选默认为 false

Finish setup right away, as POST /v1/reception/reseller/workspaces/{workspace_id}/complete-onboarding does. Best-effort: onboarding_completed_at_unix stays null on failure, and that call can be retried.

idempotency_keystring or null可选<=255 characters

Client-generated key that makes a retry safe. The same key and body within 24 hours returns the first result without running again. While that first request is still running, a retry gets 409 idempotency_key_in_progress; a different body with the same key gets 400 idempotency_key_reused. A request that fails is not saved, so it can be retried with the same key.

响应

成功响应

workspace_idstring
business_namestring
billing_tierstring or null
receptionist_countinteger
calls_last_30_daysinteger
created_at_unixinteger
subscriptionobject or null可选

The reseller-managed subscription, when this workspace has one. None means nothing is sold here yet and a tier can be assigned.

has_payment_issueboolean可选默认为 false
A charge for this workspace is unpaid. Assigning or changing a tier is refused until it clears, so surface it rather than letting it fail.
onboarding_completed_at_unixinteger or null可选
When onboarding finished. Until then the onboarding wizard may replace or remove the workspace's business data.
member_resultslist of objects可选默认为 []

错误

422
Unprocessable Entity Error