PRprimitive
Domains

Claim a vanity inbox name

Make the name the organization's current managed inbox. The previous inbox stops being current but keeps receiving mail. Needs the Power plan and domains:manage, which a credential confined to some mailboxes never holds. Sending records are published in the same request when they can be. outbound_ready false means they could not be yet: mail to the new name still arrives, but sending from it is refused until they are published.

post/managed-inbox/vanity

Request

  • Base URL
    https://api.primitive.dev/v1
  • URL
    https://api.primitive.dev/v1/managed-inbox/vanity
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

namestring required

Response

Claim a vanity inbox name

successtrue required

Changes

No operation changes recorded.