Workspaces
Confirm Workspace Sync
POST
/v1/workspaces/{workspaceId}/syncPOST
/v1/workspaces/
{workspaceId}/syncConfirm and start connecting the selected mailboxes
Enqueues an async job that connects the selected mailboxes with warmup defaults configured. Poll the sync-status endpoint for completion.
Authorization
X-Api-Key<token>
In: header
Request Body
application/jsonRequiredselectAllboolean
Connect every not-yet-connected mailbox in the workspace (optionally narrowed by selectedDomains and deselect). When false, only the mailboxes listed in emailsToConnect are connected.
Example:trueselectedDomainsarray<string>
When selectAll is true, restrict to these domains only.
Example:["customerdomain.com"]deselectarray<string>
When selectAll is true, mailboxes to exclude from the sync.
Example:[]emailsToConnectarray<string>
When selectAll is false, the exact mailboxes to connect.
Example:[]enableWarmupboolean
Enable warmup for newly connected mailboxes, subject to remaining plan quota.
Example:trueemailAccountIdsToDeletearray<number>
Previously-synced email account IDs from this workspace to delete as part of this sync.
Example:[]tagNamestring
Tag name to apply to every mailbox connected in this sync.
Example:"partner-import"Path Parameters
workspaceIdstring
Responses
202
202 response
{
"status": "processing",
"jobId": "dwd-sync-aB3xY7Qk-1720000000000"
}