# MCP tool reference 1 callable tools. Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference. Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result. [Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt) ## sync_unibox_history Check sync status, pull older mail from the provider, inspect history import options, or copy one conversation's history into a second connected mailbox. Select the action explicitly. Use when a conversation the customer expects is genuinely not in the product yet. Check the status first: a mailbox that reports its history complete has nothing older to fetch. It is not a search. Both actions are durable work returning an operation handle, and repeatedly asking at the same position dispatches nothing new. Scopes: unibox:read, inbox:update Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "status" ] } ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "inboxIds": { "type": "string" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|cursor|limit|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "cursor", "limit", "inboxIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "sync_older" ] } ] }, "older": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "batchSize": { "type": "integer", "minimum": 10, "maximum": 100 } }, "patternProperties": { "^(?!(?:inboxIds|batchSize)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "batchSize" ] } } }, "required": [ "workspaceId", "action", "older" ], "patternProperties": { "^(?!(?:workspaceId|action|older)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "older" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "import_options" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "start_import" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "destinationInboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId", "destinationInboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId|destinationInboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId", "destinationInboxId" ] } } ], "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "status" ] } ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "inboxIds": { "type": "string" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|cursor|limit|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "cursor", "limit", "inboxIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "sync_older" ] } ] }, "older": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "batchSize": { "type": "integer", "minimum": 10, "maximum": 100 } }, "patternProperties": { "^(?!(?:inboxIds|batchSize)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "batchSize" ] } } }, "required": [ "workspaceId", "action", "older" ], "patternProperties": { "^(?!(?:workspaceId|action|older)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "older" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "import_options" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "start_import" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "destinationInboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId", "destinationInboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId|destinationInboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId", "destinationInboxId" ] } } ], "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "statusUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] }, "acceptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "message": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "completed" ], "patternProperties": { "^(?!(?:completed|total|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "completed", "total", "message" ] } }, "canCancel": { "type": "boolean" } }, "required": [ "id", "statusUrl", "state", "acceptedAt", "canCancel" ], "patternProperties": { "^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "statusUrl", "state", "acceptedAt", "progress", "canCancel" ] } }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "statusUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] }, "acceptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "message": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "completed" ], "patternProperties": { "^(?!(?:completed|total|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "completed", "total", "message" ] } }, "canCancel": { "type": "boolean" }, "counts": { "type": "object", "properties": { "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "existing": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unresolved": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "separateThreads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "imported", "existing", "remaining", "unresolved", "separateThreads", "total" ], "patternProperties": { "^(?!(?:imported|existing|remaining|unresolved|separateThreads|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "imported", "existing", "remaining", "unresolved", "separateThreads", "total" ] } } }, "required": [ "id", "statusUrl", "state", "acceptedAt", "canCancel" ], "patternProperties": { "^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel|counts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "statusUrl", "state", "acceptedAt", "progress", "canCancel", "counts" ] } }, { "type": "object", "properties": { "inboxes": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "historyComplete": { "type": "boolean" }, "syncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "estimatedTotal": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "oldestSyncedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "newestSyncedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "progress": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] } }, "required": [ "inboxId", "emailAddress", "historyComplete", "syncedCount", "estimatedTotal", "oldestSyncedAt", "newestSyncedAt", "progress" ], "patternProperties": { "^(?!(?:inboxId|emailAddress|historyComplete|syncedCount|estimatedTotal|oldestSyncedAt|newestSyncedAt|progress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "emailAddress", "historyComplete", "syncedCount", "estimatedTotal", "oldestSyncedAt", "newestSyncedAt", "progress" ] } }, "maxItems": 100 }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] }, "allHistoryComplete": { "type": "boolean" }, "totalSynced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalEstimated": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "canLoadMore": { "type": "boolean" } }, "required": [ "inboxes", "allHistoryComplete", "totalSynced", "totalEstimated", "canLoadMore" ], "patternProperties": { "^(?!(?:inboxes|nextCursor|allHistoryComplete|totalSynced|totalEstimated|canLoadMore)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxes", "nextCursor", "allHistoryComplete", "totalSynced", "totalEstimated", "canLoadMore" ] } }, { "type": "object", "properties": { "eligible": { "type": "boolean" }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "destinations": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "inboxId", "emailAddress" ], "patternProperties": { "^(?!(?:inboxId|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "emailAddress" ] } }, "maxItems": 200 } }, "required": [ "eligible", "reason", "destinations" ], "patternProperties": { "^(?!(?:eligible|reason|destinations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "eligible", "reason", "destinations" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "statusUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] }, "acceptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "message": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "completed" ], "patternProperties": { "^(?!(?:completed|total|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "completed", "total", "message" ] } }, "canCancel": { "type": "boolean" } }, "required": [ "id", "statusUrl", "state", "acceptedAt", "canCancel" ], "patternProperties": { "^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "statusUrl", "state", "acceptedAt", "progress", "canCancel" ] } }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "statusUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] }, "acceptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "message": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "completed" ], "patternProperties": { "^(?!(?:completed|total|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "completed", "total", "message" ] } }, "canCancel": { "type": "boolean" }, "counts": { "type": "object", "properties": { "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "existing": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unresolved": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "separateThreads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "imported", "existing", "remaining", "unresolved", "separateThreads", "total" ], "patternProperties": { "^(?!(?:imported|existing|remaining|unresolved|separateThreads|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "imported", "existing", "remaining", "unresolved", "separateThreads", "total" ] } } }, "required": [ "id", "statusUrl", "state", "acceptedAt", "canCancel" ], "patternProperties": { "^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel|counts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "statusUrl", "state", "acceptedAt", "progress", "canCancel", "counts" ] } }, { "type": "object", "properties": { "inboxes": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "historyComplete": { "type": "boolean" }, "syncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "estimatedTotal": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "oldestSyncedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "newestSyncedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "progress": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] } }, "required": [ "inboxId", "emailAddress", "historyComplete", "syncedCount", "estimatedTotal", "oldestSyncedAt", "newestSyncedAt", "progress" ], "patternProperties": { "^(?!(?:inboxId|emailAddress|historyComplete|syncedCount|estimatedTotal|oldestSyncedAt|newestSyncedAt|progress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "emailAddress", "historyComplete", "syncedCount", "estimatedTotal", "oldestSyncedAt", "newestSyncedAt", "progress" ] } }, "maxItems": 100 }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] }, "allHistoryComplete": { "type": "boolean" }, "totalSynced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalEstimated": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "canLoadMore": { "type": "boolean" } }, "required": [ "inboxes", "allHistoryComplete", "totalSynced", "totalEstimated", "canLoadMore" ], "patternProperties": { "^(?!(?:inboxes|nextCursor|allHistoryComplete|totalSynced|totalEstimated|canLoadMore)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxes", "nextCursor", "allHistoryComplete", "totalSynced", "totalEstimated", "canLoadMore" ] } }, { "type": "object", "properties": { "eligible": { "type": "boolean" }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "destinations": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "inboxId", "emailAddress" ], "patternProperties": { "^(?!(?:inboxId|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "emailAddress" ] } }, "maxItems": 200 } }, "required": [ "eligible", "reason", "destinations" ], "patternProperties": { "^(?!(?:eligible|reason|destinations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "eligible", "reason", "destinations" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `uniboxSync.getStatus`: `GET /v1/workspaces/:workspaceId/unibox/sync/status` - `uniboxSync.syncOlder`: `POST /v1/workspaces/:workspaceId/unibox/sync/older` - `uniboxSync.getHistoryImportOptions`: `GET /v1/workspaces/:workspaceId/unibox/messages/:messageId/history-import/options` - `uniboxSync.startHistoryImport`: `POST /v1/workspaces/:workspaceId/unibox/messages/:messageId/history-import`