Skip to content

Get Provisioning States

POST
/provider-domains/{domain_id}/provisioning-states

Live provisioning step and last error for up to 50 mailboxes. Reads only.

Best-effort by design: a mailbox with no live provisioning run - finished, never started, or aged out - comes back null rather than erroring, so poll this and fall back to the mailbox’s own status.

Authorizations

Parameters

Path Parameters

domain_id
required

Sending domain id (provider_domains.id) - from GET /provider-domains

integer

Sending domain id (provider_domains.id) - from GET /provider-domains

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Ask for the live provisioning step of up to 50 mailboxes.

object
mailbox_ids

Mailbox ids to report on. Up to 50.

Array<integer>
<= 50 items

Responses

200

Successful Response

object
data
required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as “nothing to report” rather than “we did not tell you”. Every value passes through scrub_vendor_names on the way in.

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
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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