manage_mailbox_provider_import
Begins secure mailbox-supplier setup, returns a human handoff and status, browses saved connections and inventory, and starts/retries or inspects Playwright imports. Keys and local Chrome stay human-only.
# 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_mailbox_provider_import
Begins secure mailbox-supplier setup, returns a human handoff and status, browses saved connections and inventory, and starts/retries or inspects Playwright imports. Keys and local Chrome stay human-only.
When asked to import purchased inboxes or check a run. Start payload initialSendingMode=disabled creates new inboxes with zero campaign capacity and warmup off; retries inherit it and existing settings stay unchanged. Disconnect with disconnect_mailbox_provider.
To submit a vendor API key or run a local Chrome import — human-only.
Scopes: integration:create, integration:read, inbox:connect, inbox:read
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": {
"type": "string",
"enum": [
"begin_setup"
]
},
"payload": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"expectedWorkspaceId": {
"$ref": "#/$defs/OpaqueId"
}
},
"required": [
"provider"
],
"patternProperties": {
"^(?!(?:provider|expectedWorkspaceId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"provider",
"expectedWorkspaceId"
]
}
}
},
"required": [
"workspaceId",
"action",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId|action|payload)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"payload"
]
}
},
{
"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": {
"type": "string",
"enum": [
"setup_status"
]
},
"setupId": {
"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",
"setupId"
],
"patternProperties": {
"^(?!(?:workspaceId|action|setupId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"setupId"
]
}
},
{
"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": {
"type": "string",
"enum": [
"cancel_setup"
]
},
"setupId": {
"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",
"setupId"
],
"patternProperties": {
"^(?!(?:workspaceId|action|setupId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"setupId"
]
}
},
{
"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": {
"type": "string",
"enum": [
"connections"
]
}
},
"required": [
"workspaceId",
"action"
],
"patternProperties": {
"^(?!(?:workspaceId|action)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action"
]
}
},
{
"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": {
"type": "string",
"enum": [
"domains"
]
},
"connectionId": {
"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": {
"page": {
"type": "integer",
"minimum": 1
}
},
"patternProperties": {
"^(?!(?:page)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"page"
]
}
]
}
}
},
"required": [
"workspaceId",
"action",
"connectionId",
"query"
],
"patternProperties": {
"^(?!(?:workspaceId|action|connectionId|query)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"connectionId",
"query"
]
}
},
{
"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": {
"type": "string",
"enum": [
"mailboxes"
]
},
"connectionId": {
"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"
},
"filters": {
"type": "object",
"properties": {
"connectionStatus": {
"type": "string",
"enum": [
"",
"here",
"elsewhere",
"not_here",
"unconnected"
]
},
"limit": {
"type": "integer",
"minimum": 10,
"maximum": 100
},
"refresh": {
"type": "boolean"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"domainId": {
"$ref": "#/$defs/NonEmptyString"
},
"search": {
"$ref": "#/$defs/ShortText"
},
"status": {
"$ref": "#/$defs/ShortText"
},
"tag": {
"$ref": "#/$defs/ShortText"
},
"provider": {
"type": "string",
"enum": [
"",
"google_workspace",
"microsoft_365",
"unsupported"
]
},
"admin": {
"type": "string",
"enum": [
"",
"yes",
"no"
]
},
"sort": {
"type": "string",
"enum": [
"emailAddress",
"name",
"status",
"provider"
]
},
"descending": {
"type": "boolean"
}
},
"patternProperties": {
"^(?!(?:connectionStatus|limit|refresh|offset|domainId|search|status|tag|provider|admin|sort|descending)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"connectionStatus",
"limit",
"refresh",
"offset",
"domainId",
"search",
"status",
"tag",
"provider",
"admin",
"sort",
"descending"
]
}
}
},
"required": [
"workspaceId",
"action",
"connectionId",
"filters"
],
"patternProperties": {
"^(?!(?:workspaceId|action|connectionId|filters)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"connectionId",
"filters"
]
}
},
{
"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": {
"type": "string",
"enum": [
"select_mailboxes"
]
},
"connectionId": {
"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"
},
"filters": {
"type": "object",
"properties": {
"connectionStatus": {
"type": "string",
"enum": [
"",
"here",
"elsewhere",
"not_here",
"unconnected"
]
},
"limit": {
"type": "integer",
"minimum": 10,
"maximum": 100
},
"refresh": {
"type": "boolean"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"domainId": {
"$ref": "#/$defs/NonEmptyString"
},
"search": {
"$ref": "#/$defs/ShortText"
},
"status": {
"$ref": "#/$defs/ShortText"
},
"tag": {
"$ref": "#/$defs/ShortText"
},
"provider": {
"type": "string",
"enum": [
"",
"google_workspace",
"microsoft_365",
"unsupported"
]
},
"admin": {
"type": "string",
"enum": [
"",
"yes",
"no"
]
},
"sort": {
"type": "string",
"enum": [
"emailAddress",
"name",
"status",
"provider"
]
},
"descending": {
"type": "boolean"
}
},
"patternProperties": {
"^(?!(?:connectionStatus|limit|refresh|offset|domainId|search|status|tag|provider|admin|sort|descending)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"connectionStatus",
"limit",
"refresh",
"offset",
"domainId",
"search",
"status",
"tag",
"provider",
"admin",
"sort",
"descending"
]
}
}
},
"required": [
"workspaceId",
"action",
"connectionId",
"filters"
],
"patternProperties": {
"^(?!(?:workspaceId|action|connectionId|filters)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"connectionId",
"filters"
]
}
},
{
"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": {
"type": "string",
"enum": [
"start"
]
},
"payload": {
"type": "object",
"properties": {
"connectionId": {
"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"
},
"mailboxIds": {
"type": "array",
"items": {
"$ref": "#/$defs/NonEmptyString"
},
"minItems": 1,
"maxItems": 10000
},
"domainId": {
"$ref": "#/$defs/NonEmptyString"
},
"automation": {
"type": "string",
"enum": [
"playwright",
"local_chrome"
]
},
"initialSendingMode": {
"type": "string",
"enum": [
"default",
"disabled"
]
}
},
"required": [
"connectionId",
"mailboxIds"
],
"patternProperties": {
"^(?!(?:connectionId|mailboxIds|domainId|automation|initialSendingMode)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"connectionId",
"mailboxIds",
"domainId",
"automation",
"initialSendingMode"
]
}
}
},
"required": [
"workspaceId",
"action",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId|action|payload)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"payload"
]
}
},
{
"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": {
"type": "string",
"enum": [
"retry"
]
},
"importId": {
"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"
},
"payload": {
"type": "object",
"properties": {
"approvedClientId": {
"$ref": "#/$defs/NonEmptyString"
},
"automation": {
"type": "string",
"enum": [
"playwright",
"local_chrome"
]
}
},
"patternProperties": {
"^(?!(?:approvedClientId|automation)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"approvedClientId",
"automation"
]
}
}
},
"required": [
"workspaceId",
"action",
"importId",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId|action|importId|payload)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"importId",
"payload"
]
}
},
{
"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": {
"type": "string",
"enum": [
"imports"
]
},
"query": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"patternProperties": {
"^(?!(?:offset|limit)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit"
]
}
}
},
"required": [
"workspaceId",
"action",
"query"
],
"patternProperties": {
"^(?!(?:workspaceId|action|query)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"query"
]
}
},
{
"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": {
"type": "string",
"enum": [
"get"
]
},
"importId": {
"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": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"patternProperties": {
"^(?!(?:offset|limit)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit"
]
}
}
},
"required": [
"workspaceId",
"action",
"importId",
"query"
],
"patternProperties": {
"^(?!(?:workspaceId|action|importId|query)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"importId",
"query"
]
}
},
{
"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": {
"type": "string",
"enum": [
"google_approval"
]
},
"importId": {
"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",
"importId"
],
"patternProperties": {
"^(?!(?:workspaceId|action|importId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"importId"
]
}
},
{
"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": {
"type": "string",
"enum": [
"connect_link"
]
},
"importId": {
"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"
},
"payload": {
"type": "object",
"properties": {
"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": [
"itemId"
],
"patternProperties": {
"^(?!(?:itemId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"itemId"
]
}
]
}
}
},
"required": [
"workspaceId",
"action",
"importId",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId|action|importId|payload)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"importId",
"payload"
]
}
},
{
"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": {
"type": "string",
"enum": [
"cancel"
]
},
"importId": {
"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",
"importId"
],
"patternProperties": {
"^(?!(?:workspaceId|action|importId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"importId"
]
}
}
],
"$defs": {
"OpaqueId": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"NonEmptyString": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Target Workspace UUID. Call list_workspaces to enumerate the Workspaces this credential may access, then pass the chosen id here."
}
},
"required": [
"workspaceId"
],
"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": {
"type": "string",
"enum": [
"begin_setup"
]
},
"payload": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"expectedWorkspaceId": {
"$ref": "#/$defs/OpaqueId"
}
},
"required": [
"provider"
],
"patternProperties": {
"^(?!(?:provider|expectedWorkspaceId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"provider",
"expectedWorkspaceId"
]
}
}
},
"required": [
"workspaceId",
"action",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|payload)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"payload"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"setup_status"
]
},
"setupId": {
"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",
"setupId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|setupId)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"setupId"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"cancel_setup"
]
},
"setupId": {
"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",
"setupId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|setupId)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"setupId"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"connections"
]
}
},
"required": [
"workspaceId",
"action"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"domains"
]
},
"connectionId": {
"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": {
"page": {
"type": "integer",
"minimum": 1
}
},
"patternProperties": {
"^(?!(?:page)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"page"
]
}
]
}
}
},
"required": [
"workspaceId",
"action",
"connectionId",
"query"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|connectionId|query)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"connectionId",
"query"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"mailboxes"
]
},
"connectionId": {
"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"
},
"filters": {
"type": "object",
"properties": {
"connectionStatus": {
"type": "string",
"enum": [
"",
"here",
"elsewhere",
"not_here",
"unconnected"
]
},
"limit": {
"type": "integer",
"minimum": 10,
"maximum": 100
},
"refresh": {
"type": "boolean"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"domainId": {
"$ref": "#/$defs/NonEmptyString"
},
"search": {
"$ref": "#/$defs/ShortText"
},
"status": {
"$ref": "#/$defs/ShortText"
},
"tag": {
"$ref": "#/$defs/ShortText"
},
"provider": {
"type": "string",
"enum": [
"",
"google_workspace",
"microsoft_365",
"unsupported"
]
},
"admin": {
"type": "string",
"enum": [
"",
"yes",
"no"
]
},
"sort": {
"type": "string",
"enum": [
"emailAddress",
"name",
"status",
"provider"
]
},
"descending": {
"type": "boolean"
}
},
"patternProperties": {
"^(?!(?:connectionStatus|limit|refresh|offset|domainId|search|status|tag|provider|admin|sort|descending)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"connectionStatus",
"limit",
"refresh",
"offset",
"domainId",
"search",
"status",
"tag",
"provider",
"admin",
"sort",
"descending"
]
}
}
},
"required": [
"workspaceId",
"action",
"connectionId",
"filters"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|connectionId|filters)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"connectionId",
"filters"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"select_mailboxes"
]
},
"connectionId": {
"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"
},
"filters": {
"type": "object",
"properties": {
"connectionStatus": {
"type": "string",
"enum": [
"",
"here",
"elsewhere",
"not_here",
"unconnected"
]
},
"limit": {
"type": "integer",
"minimum": 10,
"maximum": 100
},
"refresh": {
"type": "boolean"
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"domainId": {
"$ref": "#/$defs/NonEmptyString"
},
"search": {
"$ref": "#/$defs/ShortText"
},
"status": {
"$ref": "#/$defs/ShortText"
},
"tag": {
"$ref": "#/$defs/ShortText"
},
"provider": {
"type": "string",
"enum": [
"",
"google_workspace",
"microsoft_365",
"unsupported"
]
},
"admin": {
"type": "string",
"enum": [
"",
"yes",
"no"
]
},
"sort": {
"type": "string",
"enum": [
"emailAddress",
"name",
"status",
"provider"
]
},
"descending": {
"type": "boolean"
}
},
"patternProperties": {
"^(?!(?:connectionStatus|limit|refresh|offset|domainId|search|status|tag|provider|admin|sort|descending)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"connectionStatus",
"limit",
"refresh",
"offset",
"domainId",
"search",
"status",
"tag",
"provider",
"admin",
"sort",
"descending"
]
}
}
},
"required": [
"workspaceId",
"action",
"connectionId",
"filters"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|connectionId|filters)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"connectionId",
"filters"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"start"
]
},
"payload": {
"type": "object",
"properties": {
"connectionId": {
"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"
},
"mailboxIds": {
"type": "array",
"items": {
"$ref": "#/$defs/NonEmptyString"
},
"minItems": 1,
"maxItems": 10000
},
"domainId": {
"$ref": "#/$defs/NonEmptyString"
},
"automation": {
"type": "string",
"enum": [
"playwright",
"local_chrome"
]
},
"initialSendingMode": {
"type": "string",
"enum": [
"default",
"disabled"
]
}
},
"required": [
"connectionId",
"mailboxIds"
],
"patternProperties": {
"^(?!(?:connectionId|mailboxIds|domainId|automation|initialSendingMode)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"connectionId",
"mailboxIds",
"domainId",
"automation",
"initialSendingMode"
]
}
}
},
"required": [
"workspaceId",
"action",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|payload)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"payload"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"retry"
]
},
"importId": {
"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"
},
"payload": {
"type": "object",
"properties": {
"approvedClientId": {
"$ref": "#/$defs/NonEmptyString"
},
"automation": {
"type": "string",
"enum": [
"playwright",
"local_chrome"
]
}
},
"patternProperties": {
"^(?!(?:approvedClientId|automation)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"approvedClientId",
"automation"
]
}
}
},
"required": [
"workspaceId",
"action",
"importId",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|importId|payload)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"importId",
"payload"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"imports"
]
},
"query": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"patternProperties": {
"^(?!(?:offset|limit)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit"
]
}
}
},
"required": [
"workspaceId",
"action",
"query"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|query)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"query"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"get"
]
},
"importId": {
"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": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"patternProperties": {
"^(?!(?:offset|limit)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit"
]
}
}
},
"required": [
"workspaceId",
"action",
"importId",
"query"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|importId|query)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"importId",
"query"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"google_approval"
]
},
"importId": {
"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",
"importId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|importId)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"importId"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"connect_link"
]
},
"importId": {
"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"
},
"payload": {
"type": "object",
"properties": {
"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": [
"itemId"
],
"patternProperties": {
"^(?!(?:itemId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"itemId"
]
}
]
}
}
},
"required": [
"workspaceId",
"action",
"importId",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|importId|payload)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"importId",
"payload"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"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": {
"type": "string",
"enum": [
"cancel"
]
},
"importId": {
"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",
"importId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|importId)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"importId"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
}
],
"$defs": {
"OpaqueId": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"NonEmptyString": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
}
}
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"OpaqueId": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"HttpUrl": {
"type": "string",
"minLength": 1,
"maxLength": 2048,
"pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$"
},
"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
},
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"EmailAddress": {
"type": "string",
"minLength": 3,
"maxLength": 320,
"pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
},
"LeadStoredText": {
"type": "string",
"maxLength": 65536
},
"HttpResourcePath": {
"type": "string",
"minLength": 1,
"maxLength": 2048,
"pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$"
}
},
"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"
},
"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"
},
"provider": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"expectedWorkspaceId": {
"anyOf": [
{
"$ref": "#/$defs/OpaqueId"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"waiting_for_user",
"saving",
"completed",
"expired",
"canceled",
"failed"
]
},
"handoffUrl": {
"$ref": "#/$defs/HttpUrl"
},
"expiresAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"connection": {
"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"
},
"provider": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"label": {
"$ref": "#/$defs/NonEmptyString"
},
"workspace": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/NonEmptyString"
},
"name": {
"$ref": "#/$defs/NonEmptyString"
}
},
"required": [
"id",
"name"
],
"patternProperties": {
"^(?!(?:id|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"provider",
"label",
"workspace"
],
"patternProperties": {
"^(?!(?:id|provider|label|workspace)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"provider",
"label",
"workspace"
]
}
},
{
"type": "null"
}
]
},
"message": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"id",
"workspaceId",
"provider",
"expectedWorkspaceId",
"status",
"handoffUrl",
"expiresAt",
"connection",
"message"
],
"patternProperties": {
"^(?!(?:id|workspaceId|provider|expectedWorkspaceId|status|handoffUrl|expiresAt|connection|message)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"workspaceId",
"provider",
"expectedWorkspaceId",
"status",
"handoffUrl",
"expiresAt",
"connection",
"message"
]
}
},
{
"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"
},
"provider": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"label": {
"$ref": "#/$defs/NonEmptyString"
},
"workspace": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/NonEmptyString"
},
"name": {
"$ref": "#/$defs/NonEmptyString"
}
},
"required": [
"id",
"name"
],
"patternProperties": {
"^(?!(?:id|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"provider",
"label",
"workspace"
],
"patternProperties": {
"^(?!(?:id|provider|label|workspace)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"provider",
"label",
"workspace"
]
}
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/NonEmptyString"
},
"name": {
"$ref": "#/$defs/NonEmptyString"
},
"status": {
"$ref": "#/$defs/NonEmptyString"
}
},
"required": [
"id",
"name",
"status"
],
"patternProperties": {
"^(?!(?:id|name|status)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"status"
]
}
}
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"items",
"hasMore"
],
"patternProperties": {
"^(?!(?:items|hasMore)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"hasMore"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/NonEmptyString"
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
},
"provider": {
"anyOf": [
{
"type": "string",
"enum": [
"google_workspace",
"microsoft_365"
]
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/$defs/NonEmptyString"
},
"ready": {
"type": "boolean"
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"isAdmin": {
"type": "boolean"
},
"dailyLimit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sourceProvider": {
"$ref": "#/$defs/ShortText"
},
"alreadyConnected": {
"type": "boolean"
},
"connection": {
"type": "object",
"properties": {
"here": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"elsewhere": {
"type": "boolean"
},
"workspaceNames": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"privateWorkspace": {
"type": "boolean"
}
},
"required": [
"here",
"elsewhere",
"workspaceNames",
"privateWorkspace"
],
"patternProperties": {
"^(?!(?:here|elsewhere|workspaceNames|privateWorkspace)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"here",
"elsewhere",
"workspaceNames",
"privateWorkspace"
]
}
}
},
"required": [
"id",
"emailAddress",
"provider",
"status",
"ready",
"firstName",
"lastName",
"alreadyConnected",
"connection"
],
"patternProperties": {
"^(?!(?:id|emailAddress|provider|status|ready|firstName|lastName|tags|isAdmin|dailyLimit|sourceProvider|alreadyConnected|connection)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress",
"provider",
"status",
"ready",
"firstName",
"lastName",
"tags",
"isAdmin",
"dailyLimit",
"sourceProvider",
"alreadyConnected",
"connection"
]
}
}
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"nextOffset": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"unavailableReason": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"workspace": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/NonEmptyString"
},
"name": {
"$ref": "#/$defs/NonEmptyString"
}
},
"required": [
"id",
"name"
],
"patternProperties": {
"^(?!(?:id|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name"
]
}
},
{
"type": "null"
}
]
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/$defs/NonEmptyString"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/$defs/NonEmptyString"
}
}
},
"required": [
"items",
"total",
"nextOffset",
"unavailableReason",
"workspace",
"statuses",
"tags"
],
"patternProperties": {
"^(?!(?:items|total|nextOffset|unavailableReason|workspace|statuses|tags)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"total",
"nextOffset",
"unavailableReason",
"workspace",
"statuses",
"tags"
]
}
},
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"$ref": "#/$defs/NonEmptyString"
}
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"ids",
"total"
],
"patternProperties": {
"^(?!(?:ids|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"ids",
"total"
]
}
},
{
"type": "object",
"properties": {
"cancelled": {
"anyOf": [
{
"type": "boolean",
"enum": [
true
]
}
]
}
},
"required": [
"cancelled"
],
"patternProperties": {
"^(?!(?:cancelled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"cancelled"
]
}
]
}
},
{
"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"
},
"source": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/NonEmptyString"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"discovering",
"ready",
"connecting",
"completed",
"failed",
"cancelled"
]
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"connected": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"hasPendingGoogle": {
"type": "boolean"
},
"busy": {
"type": "boolean"
},
"automation": {
"type": "string",
"enum": [
"playwright",
"local_chrome",
"kernel"
]
},
"initialSendingMode": {
"type": "string",
"enum": [
"default",
"disabled"
]
},
"attemptId": {
"anyOf": [
{
"$ref": "#/$defs/OpaqueId"
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"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": {
"$ref": "#/$defs/NonEmptyString"
},
"status": {
"$ref": "#/$defs/NonEmptyString"
},
"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"
}
]
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"emailAddress",
"provider",
"status",
"inboxId",
"error"
],
"patternProperties": {
"^(?!(?:id|emailAddress|provider|status|inboxId|error)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress",
"provider",
"status",
"inboxId",
"error"
]
}
}
}
},
"required": [
"id",
"source",
"name",
"status",
"total",
"connected",
"hasPendingGoogle",
"busy",
"automation",
"initialSendingMode",
"attemptId",
"error",
"items"
],
"patternProperties": {
"^(?!(?:id|source|name|status|total|connected|hasPendingGoogle|busy|automation|initialSendingMode|attemptId|error|items)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"source",
"name",
"status",
"total",
"connected",
"hasPendingGoogle",
"busy",
"automation",
"initialSendingMode",
"attemptId",
"error",
"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"
},
"source": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/NonEmptyString"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"discovering",
"ready",
"connecting",
"completed",
"failed",
"cancelled"
]
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"connected": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"source",
"name",
"status",
"count",
"connected"
],
"patternProperties": {
"^(?!(?:id|source|name|status|count|connected)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"source",
"name",
"status",
"count",
"connected"
]
}
}
},
{
"type": "object",
"properties": {
"clientId": {
"$ref": "#/$defs/NonEmptyString"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/$defs/NonEmptyString"
}
}
},
"required": [
"clientId",
"domains"
],
"patternProperties": {
"^(?!(?:clientId|domains)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"clientId",
"domains"
]
}
},
{
"type": "object",
"properties": {
"authorizationUrl": {
"$ref": "#/$defs/HttpUrl"
},
"expiresAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"googleClientId": {
"anyOf": [
{
"$ref": "#/$defs/NonEmptyString"
},
{
"type": "null"
}
]
}
},
"required": [
"authorizationUrl",
"expiresAt",
"googleClientId"
],
"patternProperties": {
"^(?!(?:authorizationUrl|expiresAt|googleClientId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"authorizationUrl",
"expiresAt",
"googleClientId"
]
}
},
{
"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"
},
"importId": {
"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": [
"id",
"statusUrl",
"state",
"acceptedAt",
"canCancel",
"importId"
],
"patternProperties": {
"^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel|importId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"statusUrl",
"state",
"acceptedAt",
"progress",
"canCancel",
"importId"
]
}
},
{
"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"
}
]
},
{
"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"
},
"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"
},
"provider": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"expectedWorkspaceId": {
"anyOf": [
{
"$ref": "#/$defs/OpaqueId"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"waiting_for_user",
"saving",
"completed",
"expired",
"canceled",
"failed"
]
},
"handoffUrl": {
"$ref": "#/$defs/HttpUrl"
},
"expiresAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"connection": {
"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"
},
"provider": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"label": {
"$ref": "#/$defs/NonEmptyString"
},
"workspace": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/NonEmptyString"
},
"name": {
"$ref": "#/$defs/NonEmptyString"
}
},
"required": [
"id",
"name"
],
"patternProperties": {
"^(?!(?:id|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"provider",
"label",
"workspace"
],
"patternProperties": {
"^(?!(?:id|provider|label|workspace)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"provider",
"label",
"workspace"
]
}
},
{
"type": "null"
}
]
},
"message": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"id",
"workspaceId",
"provider",
"expectedWorkspaceId",
"status",
"handoffUrl",
"expiresAt",
"connection",
"message"
],
"patternProperties": {
"^(?!(?:id|workspaceId|provider|expectedWorkspaceId|status|handoffUrl|expiresAt|connection|message)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"workspaceId",
"provider",
"expectedWorkspaceId",
"status",
"handoffUrl",
"expiresAt",
"connection",
"message"
]
}
},
{
"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"
},
"provider": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"label": {
"$ref": "#/$defs/NonEmptyString"
},
"workspace": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/NonEmptyString"
},
"name": {
"$ref": "#/$defs/NonEmptyString"
}
},
"required": [
"id",
"name"
],
"patternProperties": {
"^(?!(?:id|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"provider",
"label",
"workspace"
],
"patternProperties": {
"^(?!(?:id|provider|label|workspace)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"provider",
"label",
"workspace"
]
}
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/NonEmptyString"
},
"name": {
"$ref": "#/$defs/NonEmptyString"
},
"status": {
"$ref": "#/$defs/NonEmptyString"
}
},
"required": [
"id",
"name",
"status"
],
"patternProperties": {
"^(?!(?:id|name|status)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"status"
]
}
}
},
"hasMore": {
"type": "boolean"
}
},
"required": [
"items",
"hasMore"
],
"patternProperties": {
"^(?!(?:items|hasMore)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"hasMore"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/NonEmptyString"
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
},
"provider": {
"anyOf": [
{
"type": "string",
"enum": [
"google_workspace",
"microsoft_365"
]
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/$defs/NonEmptyString"
},
"ready": {
"type": "boolean"
},
"firstName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"lastName": {
"anyOf": [
{
"$ref": "#/$defs/LeadStoredText"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"isAdmin": {
"type": "boolean"
},
"dailyLimit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"sourceProvider": {
"$ref": "#/$defs/ShortText"
},
"alreadyConnected": {
"type": "boolean"
},
"connection": {
"type": "object",
"properties": {
"here": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"elsewhere": {
"type": "boolean"
},
"workspaceNames": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"privateWorkspace": {
"type": "boolean"
}
},
"required": [
"here",
"elsewhere",
"workspaceNames",
"privateWorkspace"
],
"patternProperties": {
"^(?!(?:here|elsewhere|workspaceNames|privateWorkspace)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"here",
"elsewhere",
"workspaceNames",
"privateWorkspace"
]
}
}
},
"required": [
"id",
"emailAddress",
"provider",
"status",
"ready",
"firstName",
"lastName",
"alreadyConnected",
"connection"
],
"patternProperties": {
"^(?!(?:id|emailAddress|provider|status|ready|firstName|lastName|tags|isAdmin|dailyLimit|sourceProvider|alreadyConnected|connection)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress",
"provider",
"status",
"ready",
"firstName",
"lastName",
"tags",
"isAdmin",
"dailyLimit",
"sourceProvider",
"alreadyConnected",
"connection"
]
}
}
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"nextOffset": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"unavailableReason": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"workspace": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/NonEmptyString"
},
"name": {
"$ref": "#/$defs/NonEmptyString"
}
},
"required": [
"id",
"name"
],
"patternProperties": {
"^(?!(?:id|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name"
]
}
},
{
"type": "null"
}
]
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/$defs/NonEmptyString"
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/$defs/NonEmptyString"
}
}
},
"required": [
"items",
"total",
"nextOffset",
"unavailableReason",
"workspace",
"statuses",
"tags"
],
"patternProperties": {
"^(?!(?:items|total|nextOffset|unavailableReason|workspace|statuses|tags)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"total",
"nextOffset",
"unavailableReason",
"workspace",
"statuses",
"tags"
]
}
},
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"items": {
"$ref": "#/$defs/NonEmptyString"
}
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"ids",
"total"
],
"patternProperties": {
"^(?!(?:ids|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"ids",
"total"
]
}
},
{
"type": "object",
"properties": {
"cancelled": {
"anyOf": [
{
"type": "boolean",
"enum": [
true
]
}
]
}
},
"required": [
"cancelled"
],
"patternProperties": {
"^(?!(?:cancelled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"cancelled"
]
}
]
}
},
{
"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"
},
"source": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/NonEmptyString"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"discovering",
"ready",
"connecting",
"completed",
"failed",
"cancelled"
]
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"connected": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"hasPendingGoogle": {
"type": "boolean"
},
"busy": {
"type": "boolean"
},
"automation": {
"type": "string",
"enum": [
"playwright",
"local_chrome",
"kernel"
]
},
"initialSendingMode": {
"type": "string",
"enum": [
"default",
"disabled"
]
},
"attemptId": {
"anyOf": [
{
"$ref": "#/$defs/OpaqueId"
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"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": {
"$ref": "#/$defs/NonEmptyString"
},
"status": {
"$ref": "#/$defs/NonEmptyString"
},
"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"
}
]
},
"error": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"emailAddress",
"provider",
"status",
"inboxId",
"error"
],
"patternProperties": {
"^(?!(?:id|emailAddress|provider|status|inboxId|error)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress",
"provider",
"status",
"inboxId",
"error"
]
}
}
}
},
"required": [
"id",
"source",
"name",
"status",
"total",
"connected",
"hasPendingGoogle",
"busy",
"automation",
"initialSendingMode",
"attemptId",
"error",
"items"
],
"patternProperties": {
"^(?!(?:id|source|name|status|total|connected|hasPendingGoogle|busy|automation|initialSendingMode|attemptId|error|items)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"source",
"name",
"status",
"total",
"connected",
"hasPendingGoogle",
"busy",
"automation",
"initialSendingMode",
"attemptId",
"error",
"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"
},
"source": {
"type": "string",
"enum": [
"cheap_inboxes",
"inboxing"
]
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/NonEmptyString"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"discovering",
"ready",
"connecting",
"completed",
"failed",
"cancelled"
]
},
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"connected": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"id",
"source",
"name",
"status",
"count",
"connected"
],
"patternProperties": {
"^(?!(?:id|source|name|status|count|connected)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"source",
"name",
"status",
"count",
"connected"
]
}
}
},
{
"type": "object",
"properties": {
"clientId": {
"$ref": "#/$defs/NonEmptyString"
},
"domains": {
"type": "array",
"items": {
"$ref": "#/$defs/NonEmptyString"
}
}
},
"required": [
"clientId",
"domains"
],
"patternProperties": {
"^(?!(?:clientId|domains)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"clientId",
"domains"
]
}
},
{
"type": "object",
"properties": {
"authorizationUrl": {
"$ref": "#/$defs/HttpUrl"
},
"expiresAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"googleClientId": {
"anyOf": [
{
"$ref": "#/$defs/NonEmptyString"
},
{
"type": "null"
}
]
}
},
"required": [
"authorizationUrl",
"expiresAt",
"googleClientId"
],
"patternProperties": {
"^(?!(?:authorizationUrl|expiresAt|googleClientId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"authorizationUrl",
"expiresAt",
"googleClientId"
]
}
},
{
"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"
},
"importId": {
"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": [
"id",
"statusUrl",
"state",
"acceptedAt",
"canCancel",
"importId"
],
"patternProperties": {
"^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel|importId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"statusUrl",
"state",
"acceptedAt",
"progress",
"canCancel",
"importId"
]
}
},
{
"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"
]
}
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `inboxProviderImports.beginSetup`: `POST /v1/workspaces/:workspaceId/inbox-providers/setups`
- `inboxProviderImports.getSetup`: `GET /v1/workspaces/:workspaceId/inbox-providers/setups/:setupId`
- `inboxProviderImports.cancelSetup`: `POST /v1/workspaces/:workspaceId/inbox-providers/setups/:setupId/cancel`
- `inboxProviderImports.listConnections`: `GET /v1/workspaces/:workspaceId/inbox-providers/connections`
- `inboxProviderImports.domains`: `GET /v1/workspaces/:workspaceId/inbox-providers/connections/:connectionId/domains`
- `inboxProviderImports.mailboxes`: `GET /v1/workspaces/:workspaceId/inbox-providers/connections/:connectionId/mailboxes`
- `inboxProviderImports.selectMailboxes`: `POST /v1/workspaces/:workspaceId/inbox-providers/connections/:connectionId/mailbox-selection`
- `inboxProviderImports.start`: `POST /v1/workspaces/:workspaceId/inbox-imports`
- `inboxProviderImports.retry`: `POST /v1/workspaces/:workspaceId/inbox-imports/:importId/retry`
- `inboxProviderImports.list`: `GET /v1/workspaces/:workspaceId/inbox-imports`
- `inboxProviderImports.get`: `GET /v1/workspaces/:workspaceId/inbox-imports/:importId`
- `inboxProviderImports.googleApproval`: `GET /v1/workspaces/:workspaceId/inbox-imports/:importId/google-approval`
- `inboxProviderImports.connectLink`: `POST /v1/workspaces/:workspaceId/inbox-imports/:importId/connect-link`
- `inboxProviderImports.cancel`: `POST /v1/workspaces/:workspaceId/inbox-imports/:importId/cancel`
Scheduler Zero