Mailboxes

Update mailbox delivery routing

Choose whether new primary-address conversations stay in this mailbox, go to one mailbox, or rotate among mailboxes. Fixed and round-robin routing require an explicit fallback mailbox; the source mailbox may also be a normal destination. A destination that is out of office is skipped for new selections; existing conversation affinity is preserved.

patch/mailboxes/{id}/delivery-routing

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/mailboxes/{id}/delivery-routing
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

OR
OR

Response

Updated mailbox delivery routing. Pending routes become active after the mail routing cache has synchronized.

OR
OR

Changes

No recorded changes to this operation across all 1 revision of this API.