Skip to content

Connect Provider

POST
/provider-domains/{domain_id}/connect-provider

Connect a purchased domain to the managed mailbox-provisioning backend.

Required once per domain before checkout-mailboxes will succeed for a managed (provider='managed') purchase — an unconnected domain 400s there with an actionable message pointing back here.

Authorizations

Parameters

Path Parameters

domain_id
required

Provider domain ID (provider_domains.id) — from GET /provider-domains

integer

Provider domain ID (provider_domains.id) — from GET /provider-domains

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required
object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string