Preview a domain rotation

Check whether you can rotate a domain onto a replacement domain, and see which mailboxes would move and their new addresses. Nothing is changed.

What a rotation does

Every mailbox on the domain moves to the replacement domain and keeps its username. For example, [email protected] becomes [email protected].

Each mailbox keeps its password, billing and renewal date.

The old address keeps receiving mail as an alias of the new one.

After the rotation completes, reconnect the mailboxes to your sending tools with their new addresses. You can export them again with Export mailboxes.

Choosing the domains

Give the domain to rotate with domain_uid or domain, and the replacement with target_domain_uid or target_domain. Send one of each pair, not both.

Both domains must be in the workspace given in X-Workspace-Id.

The replacement must be an active domain with no mailboxes.

Domain names are not case sensitive.

Why a rotation cannot start

`code`	Why the rotation cannot start
`DOMAIN_NOT_SET_UP`	The domain you want to rotate was never set up, so it has nothing to rotate.
`TARGET_WARMING`	The replacement domain is being warmed. Stop warming on it first.
`SAME_DOMAIN`	The domain and the replacement are the same domain.
`MIXED_PROVIDERS`	The domain has mailboxes on more than one provider. Only domains whose mailboxes are all on one provider can be rotated.
`TARGET_NOT_EMPTY`	The replacement domain already has mailboxes. Choose a domain with no mailboxes.
`TARGET_NOT_AVAILABLE_FOR_PROVIDER`	The replacement domain can't host mailboxes of this provider. Choose another replacement.
`ROTATION_IN_PROGRESS`	A rotation of this domain is already running.
`TARGET_IN_USE`	The replacement domain is already the replacement in another rotation that is running.
`ORDER_IN_PROGRESS`	An order for one of the two domains is still in progress.
`MAILBOX_SETUP_IN_PROGRESS`	Mailboxes on one of the two domains are still being set up.
`RESETUP_IN_PROGRESS`	A mailbox resetup is scheduled or running for one of the two domains.
`MOVE_IN_PROGRESS`	One of the two domains is being moved to another workspace.
`NOTHING_TO_ROTATE`	The domain has no mailboxes to rotate.
`PREVIOUS_ROTATION_FAILED`	The last rotation of this domain did not complete. Contact support to finish it before you start a new one.

Most of these clear on their own when the other work finishes. Try again later, or contact support if a reason does not clear.

Next steps
When result.can_rotate is true, send the same request body to Start a domain rotation.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location 'https://api.inboxkit.com/v1/api/domains/rotate/preview' \ --header 'X-Workspace-Id;' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "domain": "example-outreach.com", "target_domain": "example-sales.com" }'

{ "error": false, "message": "This rotation can start", "result": { "can_rotate": true, "domain": { "uid": "d1b2c3a4-1111-4a1b-9c8d-111122223333", "name": "example-outreach.com" }, "target_domain": { "uid": "9c1b7e20-2222-4b2c-8d9e-333344445555", "name": "example-sales.com" }, "provider": "GOOGLE", "mailbox_count": 2, "mailboxes": [ { "uid": "a1b2c3d4-0000-4000-8000-000000000001", "from_email": "[email protected]", "to_email": "[email protected]" }, { "uid": "a1b2c3d4-0000-4000-8000-000000000002", "from_email": "[email protected]", "to_email": "[email protected]" } ], "blockers": [] } }

Preview a domain rotation

Request

Responses