Preview a domain move

Check what moving domains to another workspace in your team would do, before you move them. For each domain, the response says whether it can move now and, if not, why. Nothing is changed.

Mailboxes always move together with their domain. You cannot move a single mailbox on its own.

Choosing the domains

Send uids, domains, or both, with up to 50 entries in uids and domains combined.

A domain sent both ways counts once.

Domain names are not case sensitive.

Why a domain cannot move

`error_category`	Why the domain cannot move
`DOMAIN_NOT_IN_WORKSPACE`	The domain is not in the workspace given in `X-Workspace-Id`.
`DOMAIN_BEING_DELETED`	The domain is being deleted or cancelled.
`DOMAIN_WARMING`	The domain is warming. Wait until warming finishes, or cancel it.
`ORDER_IN_PROGRESS`	An order for this domain is still in progress.
`MAILBOX_SETUP_IN_PROGRESS`	Some mailboxes on this domain are still being set up.
`ROTATION_IN_PROGRESS`	This domain is part of a domain rotation that is still running.
`RESETUP_IN_PROGRESS`	A mailbox resetup is scheduled or running for this domain.
`EXPORT_IN_PROGRESS`	Mailboxes on this domain are being exported to a sequencer.
`CONSENT_REQUEST_PENDING`	A consent request for a mailbox on this domain is still pending.
`CLIENT_ID_REQUEST_PENDING`	A client ID request for this domain is still pending.
`MOVE_IN_PROGRESS`	This domain is already being moved.

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

Next steps
When result.can_move is true, send the same request body to Move domains to another workspace.

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/move-workspace/preview' \ --header 'X-Workspace-Id;' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "domains": [ "example-outreach.com", "example-sales.com" ], "target_workspace_uid": "7a9e4b20-15cd-4f6a-b3e2-9c0d8e7f6a55" }'

{ "error": false, "message": "1 of 2 domains can be moved", "result": { "can_move": false, "source_workspace": { "uid": "3f6c2a1e-8b4d-4c55-9e10-2a7b6c9d0e11", "name": "Agency Main" }, "target_workspace": { "uid": "7a9e4b20-15cd-4f6a-b3e2-9c0d8e7f6a55", "name": "Client Orion" }, "summary": { "total": 2, "movable": 1, "blocked": 1, "already_in_target": 0, "mailboxes": 5 }, "domains": [ { "domain": "example-outreach.com", "uid": "d1b2c3a4-1111-4a1b-9c8d-111122223333", "mailbox_count": 5, "can_move": true }, { "domain": "example-sales.com", "uid": "d9e8f7a6-2222-4b2c-8d7e-444455556666", "mailbox_count": 3, "can_move": false, "error_category": "MAILBOX_SETUP_IN_PROGRESS", "message": "Some mailboxes on example-sales.com are still being set up. Try again when setup finishes. If this looks wrong, contact support." } ], "sequencers": [ { "name": "Outreach Sequencer", "platform": "smartlead", "action": "clone" } ] } }

Preview a domain move

Request

Responses