Workspaces
Confirm workspace sync
Start the bulk mailbox import
Asynchronous - returns 202 with a jobId. Selection is deselect-based: with selectAll every not-yet-connected directory mailbox is connected (optionally restricted to selectedDomains) minus deselect; otherwise only emailsToConnect. Poll .../sync-status for progress.
Path Parameters
providerWorkspaceIdnumber
workspaceIdnumber
selectAllboolean
Connect every not-yet-connected directory mailbox (minus deselect).
selectedDomains?array<string>
When selectAll, restrict to these domains. Empty = all domains.
deselect?array<string>
When selectAll, exclude these specific emails.
emailsToConnect?array<string>
When not selectAll, the explicit emails to connect.
enableWarmupboolean
Enable warmup on every successfully-connected mailbox.
Response Body
curl -X POST "https://lynx-api.trulyinbox.com/v2/workspaces/0/provider-workspaces/0/sync" \ -H "Content-Type: application/json" \ -d '{ "selectAll": true, "enableWarmup": true }'{
"data": {
"jobId": "string",
"total": 0,
"status": "string"
},
"meta": {
"request_id": "req_2f1c…",
"timestamp": "2019-08-24T14:15:22Z"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"details": {},
"retry_after": 34
},
"meta": {
"request_id": "req_2f1c…",
"timestamp": "2019-08-24T14:15:22Z"
}
}{
"error": {
"code": "invalid_request",
"message": "string",
"details": {},
"retry_after": 34
},
"meta": {
"request_id": "req_2f1c…",
"timestamp": "2019-08-24T14:15:22Z"
}
}