Email settings

Change the primary address

Requires mailbox admin permission and a paid plan, except for a change back to revdokumail.com. Send the current address as expected_address. Omit username for a generated name. A custom-domain change returns 202; read the settings until assignment.status is active or failed. For account owners and administrators the old address becomes an alias unless keep_old_as_alias is false. Without a free alias slot the request returns EMAIL_ALIAS_LIMIT; send false to retire the old address. A change from revdokumail.com to a customer domain always keeps the old address as the revdokumail.com base address, which uses no alias slot. A change from a customer domain back to revdokumail.com makes that base address the main address again at once (200, assignment.status active): username is ignored, no address change is counted and it works on every plan.

post/v1/mailboxes/{mailbox_id}/email/rotate

Request

  • Base URL: https://api.revdoku.com
  • URL: https://api.revdoku.com/v1/mailboxes/{mailbox_id}/email/rotate
  • Auth: HTTP bearer

Path parameters

mailbox_idstring required

Request body

confirmtrue required
expected_addressstring required

Current address from your last settings read. A different current address returns EMAIL_ADDRESS_CHANGED.

usernamestring

New name before @. On revdokumail.com, a prefix with a new 4-character random suffix; on a custom domain, the exact name.

domainstring

Available platform domain, a ready domain of this account, or platform.

keep_old_as_aliasboolean

Keep the old address as an alias. Defaults to true for account owners and administrators while the old domain still receives email, otherwise false. Keeping it needs a free alias slot and an account owner or administrator. A change from revdokumail.com to a customer domain always keeps the old address as the base address. That needs no alias slot and no administrator.

account_idstring

Select another granted account for this request.

reasonstring nullable

Optional purpose for this action. AI agents should explain intentional reads and changes when known; omit when unknown. Do not include secrets, file contents, or transcripts.

Response

Success

successtrue required

Changes

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