# 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) ## manage_independent_inbox_oauth_batch Prepares an explicitly selected independent Google/Microsoft mailbox batch, returns a secure credential-entry handoff, starts existing OAuth automation, reads bounded progress, retries remaining accounts, cancels outstanding work, and obtains exceptional human handoffs. No supplier connection required. Never pass mailbox secrets to this tool. For independently owned Google Workspace or Microsoft 365 mailboxes with credentials entered by a human in Scheduler Zero. For supplier imports, IMAP/SMTP, mailbox purchasing, source sequencer cutover, or entering credentials in chat. Scopes: inbox:connect, inbox:read Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "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" }, "request": { "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "prepare" ] }, "payload": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365" ] } }, "required": [ "emailAddress", "provider" ], "patternProperties": { "^(?!(?:emailAddress|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "provider" ] } }, "minItems": 1, "maxItems": 500 } }, "required": [ "name", "accounts" ], "patternProperties": { "^(?!(?:name|accounts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "accounts" ] } } }, "required": [ "action", "payload" ], "patternProperties": { "^(?!(?:action|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "list" ] }, "query": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "patternProperties": { "^(?!(?:limit|offset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "offset" ] } } }, "required": [ "action", "query" ], "patternProperties": { "^(?!(?:action|query)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "query" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "get" ] }, "batchId": { "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" }, "query": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "handoffId": { "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" } }, "patternProperties": { "^(?!(?:limit|offset|handoffId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "offset", "handoffId" ] } } }, "required": [ "action", "batchId", "query" ], "patternProperties": { "^(?!(?:action|batchId|query)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "batchId", "query" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "start" ] }, "batchId": { "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": [ "action", "batchId" ], "patternProperties": { "^(?!(?:action|batchId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "batchId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "retry" ] }, "batchId": { "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": [ "action", "batchId" ], "patternProperties": { "^(?!(?:action|batchId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "batchId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "cancel" ] }, "batchId": { "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": [ "action", "batchId" ], "patternProperties": { "^(?!(?:action|batchId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "batchId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "handoff" ] }, "batchId": { "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" }, "itemId": { "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": [ "action", "batchId", "itemId" ], "patternProperties": { "^(?!(?:action|batchId|itemId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "batchId", "itemId" ] } } ] } }, "required": [ "workspaceId", "request" ], "patternProperties": { "^(?!(?:workspaceId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "request" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } } } ``` ### Input schema (OAuth / delegated agent) ```json { "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" }, "request": { "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "prepare" ] }, "payload": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "accounts": { "type": "array", "items": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365" ] } }, "required": [ "emailAddress", "provider" ], "patternProperties": { "^(?!(?:emailAddress|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "provider" ] } }, "minItems": 1, "maxItems": 500 } }, "required": [ "name", "accounts" ], "patternProperties": { "^(?!(?:name|accounts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "accounts" ] } } }, "required": [ "action", "payload" ], "patternProperties": { "^(?!(?:action|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "list" ] }, "query": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "patternProperties": { "^(?!(?:limit|offset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "offset" ] } } }, "required": [ "action", "query" ], "patternProperties": { "^(?!(?:action|query)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "query" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "get" ] }, "batchId": { "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" }, "query": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "handoffId": { "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" } }, "patternProperties": { "^(?!(?:limit|offset|handoffId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "offset", "handoffId" ] } } }, "required": [ "action", "batchId", "query" ], "patternProperties": { "^(?!(?:action|batchId|query)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "batchId", "query" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "start" ] }, "batchId": { "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": [ "action", "batchId" ], "patternProperties": { "^(?!(?:action|batchId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "batchId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "retry" ] }, "batchId": { "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": [ "action", "batchId" ], "patternProperties": { "^(?!(?:action|batchId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "batchId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "cancel" ] }, "batchId": { "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": [ "action", "batchId" ], "patternProperties": { "^(?!(?:action|batchId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "batchId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "handoff" ] }, "batchId": { "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" }, "itemId": { "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": [ "action", "batchId", "itemId" ], "patternProperties": { "^(?!(?:action|batchId|itemId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "batchId", "itemId" ] } } ] } }, "required": [ "workspaceId", "request" ], "patternProperties": { "^(?!(?:workspaceId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "request" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "batchId": { "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" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "awaiting_credentials", "ready", "queued", "running", "connected", "human_action_required", "failed", "cancelled", "expired" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "credentialsReady": { "type": "boolean" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "setupPath": { "type": "string" }, "pollAfterSeconds": { "type": "integer" }, "attemptId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ], "patternProperties": { "^(?!(?:batchId|name|status|total|connected|credentialsReady|expiresAt|setupPath|pollAfterSeconds|attemptId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ] } }, { "type": "object", "properties": { "batch": { "type": "object", "properties": { "batchId": { "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" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "awaiting_credentials", "ready", "queued", "running", "connected", "human_action_required", "failed", "cancelled", "expired" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "credentialsReady": { "type": "boolean" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "setupPath": { "type": "string" }, "pollAfterSeconds": { "type": "integer" }, "attemptId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ], "patternProperties": { "^(?!(?:batchId|name|status|total|connected|credentialsReady|expiresAt|setupPath|pollAfterSeconds|attemptId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ] } }, "items": { "type": "array", "items": { "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" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365" ] }, "status": { "type": "string", "enum": [ "awaiting_credentials", "queued", "running", "connected", "failed", "human_action_required", "cancelled" ] }, "inboxId": { "anyOf": [ { "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" }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "emailAddress", "provider", "status", "inboxId", "stage", "error" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|inboxId|stage|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "inboxId", "stage", "error" ] } }, "maxItems": 100 }, "nextOffset": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "batch", "items", "nextOffset" ], "patternProperties": { "^(?!(?:batch|items|nextOffset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "batch", "items", "nextOffset" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "batchId": { "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" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "awaiting_credentials", "ready", "queued", "running", "connected", "human_action_required", "failed", "cancelled", "expired" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "credentialsReady": { "type": "boolean" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "setupPath": { "type": "string" }, "pollAfterSeconds": { "type": "integer" }, "attemptId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ], "patternProperties": { "^(?!(?:batchId|name|status|total|connected|credentialsReady|expiresAt|setupPath|pollAfterSeconds|attemptId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ] } }, "maxItems": 100 }, "nextOffset": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "items", "nextOffset" ], "patternProperties": { "^(?!(?:items|nextOffset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextOffset" ] } }, { "type": "object", "properties": { "batchId": { "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" }, "itemId": { "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" }, "handoffPath": { "type": "string" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "batchId", "itemId", "handoffPath", "expiresAt" ], "patternProperties": { "^(?!(?:batchId|itemId|handoffPath|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "batchId", "itemId", "handoffPath", "expiresAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "batchId": { "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" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "awaiting_credentials", "ready", "queued", "running", "connected", "human_action_required", "failed", "cancelled", "expired" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "credentialsReady": { "type": "boolean" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "setupPath": { "type": "string" }, "pollAfterSeconds": { "type": "integer" }, "attemptId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ], "patternProperties": { "^(?!(?:batchId|name|status|total|connected|credentialsReady|expiresAt|setupPath|pollAfterSeconds|attemptId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ] } }, { "type": "object", "properties": { "batch": { "type": "object", "properties": { "batchId": { "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" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "awaiting_credentials", "ready", "queued", "running", "connected", "human_action_required", "failed", "cancelled", "expired" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "credentialsReady": { "type": "boolean" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "setupPath": { "type": "string" }, "pollAfterSeconds": { "type": "integer" }, "attemptId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ], "patternProperties": { "^(?!(?:batchId|name|status|total|connected|credentialsReady|expiresAt|setupPath|pollAfterSeconds|attemptId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ] } }, "items": { "type": "array", "items": { "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" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365" ] }, "status": { "type": "string", "enum": [ "awaiting_credentials", "queued", "running", "connected", "failed", "human_action_required", "cancelled" ] }, "inboxId": { "anyOf": [ { "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" }, { "type": "null" } ] }, "stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "emailAddress", "provider", "status", "inboxId", "stage", "error" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|inboxId|stage|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "inboxId", "stage", "error" ] } }, "maxItems": 100 }, "nextOffset": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "batch", "items", "nextOffset" ], "patternProperties": { "^(?!(?:batch|items|nextOffset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "batch", "items", "nextOffset" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "batchId": { "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" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "awaiting_credentials", "ready", "queued", "running", "connected", "human_action_required", "failed", "cancelled", "expired" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "credentialsReady": { "type": "boolean" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "setupPath": { "type": "string" }, "pollAfterSeconds": { "type": "integer" }, "attemptId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ], "patternProperties": { "^(?!(?:batchId|name|status|total|connected|credentialsReady|expiresAt|setupPath|pollAfterSeconds|attemptId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "batchId", "name", "status", "total", "connected", "credentialsReady", "expiresAt", "setupPath", "pollAfterSeconds", "attemptId" ] } }, "maxItems": 100 }, "nextOffset": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "items", "nextOffset" ], "patternProperties": { "^(?!(?:items|nextOffset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextOffset" ] } }, { "type": "object", "properties": { "batchId": { "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" }, "itemId": { "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" }, "handoffPath": { "type": "string" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "batchId", "itemId", "handoffPath", "expiresAt" ], "patternProperties": { "^(?!(?:batchId|itemId|handoffPath|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "batchId", "itemId", "handoffPath", "expiresAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `inboxOAuthBatches.manage`: `POST /v1/workspaces/:workspaceId/inbox-oauth-batches/actions`