Skip to navigation
API ReferencePartner Domains

Create

Put a partner domain on the allow-list. Requires domains:write. Errors: 422 invalid_domain, 422 public_domain, 409 already_partner, 409 claimed_here (one of this workspace’s verified domains: set its allowListed instead), 409 too_many_partner_domains (at most 100).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
domainstringRequired

Just the domain, globex.com; an @ or a whole address is trimmed to it. Shared mailbox providers are refused.

Response

This endpoint returns an object.
idstring
domainstring
createdAtdatetime

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Validation Error
429
Too Many Requests Error