# MCP tool reference 213 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) ## add_heyreach_leads Push up to 100 leads into a HeyReach campaign (optionally pinned to a sender) or a HeyReach list, and report how many were added, updated, or failed. Use to enroll the leads a person chose into LinkedIn outreach. The server derives the replay key from the chosen leads and returns the first result on retry. Enrolling leads starts real LinkedIn actions and is refused on a frozen subscription. A reused key with DIFFERENT leads is a conflict, and a key whose first attempt never got an answer from HeyReach stays a conflict — check the campaign's leads before choosing a new key, because a blind retry could enroll everyone twice. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:update, campaign:launch Risk: costly; confirmation: explicit; 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" }, "target": { "type": "string", "enum": [ "campaign" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "campaignLeads": { "$ref": "#/$defs/AddHeyReachCampaignLeadsInput" } }, "required": [ "workspaceId", "target", "campaignId", "campaignLeads" ], "patternProperties": { "^(?!(?:workspaceId|target|campaignId|campaignLeads)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "campaignId", "campaignLeads" ] } }, { "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" }, "target": { "type": "string", "enum": [ "list" ] }, "listId": { "$ref": "#/$defs/HeyReachId" }, "listLeads": { "$ref": "#/$defs/AddHeyReachListLeadsInput" } }, "required": [ "workspaceId", "target", "listId", "listLeads" ], "patternProperties": { "^(?!(?:workspaceId|target|listId|listLeads)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "listId", "listLeads" ] } } ], "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "LinkedInProfileUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "HeyReachLeadInput": { "type": "object", "properties": { "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "firstName": { "type": "string", "minLength": 1, "maxLength": 200 }, "lastName": { "type": "string", "minLength": 1, "maxLength": 200 }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "companyName": { "type": "string", "minLength": 0, "maxLength": 500 }, "position": { "type": "string", "minLength": 0, "maxLength": 500 }, "location": { "type": "string", "minLength": 0, "maxLength": 500 }, "summary": { "type": "string", "minLength": 0, "maxLength": 10000 }, "about": { "type": "string", "minLength": 0, "maxLength": 10000 }, "customUserFields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z0-9_]+$", "maxLength": 100 }, "value": { "type": "string", "minLength": 0, "maxLength": 10000 } }, "required": [ "name", "value" ], "patternProperties": { "^(?!(?:name|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "value" ] } }, "maxItems": 100 } }, "required": [ "profileUrl", "firstName", "lastName" ], "patternProperties": { "^(?!(?:profileUrl|firstName|lastName|emailAddress|companyName|position|location|summary|about|customUserFields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileUrl", "firstName", "lastName", "emailAddress", "companyName", "position", "location", "summary", "about", "customUserFields" ] } }, "AddHeyReachCampaignLeadsInput": { "type": "object", "properties": { "accountLeadPairs": { "type": "array", "items": { "type": "object", "properties": { "linkedInAccountId": { "$ref": "#/$defs/HeyReachId" }, "lead": { "$ref": "#/$defs/HeyReachLeadInput" } }, "required": [ "lead" ], "patternProperties": { "^(?!(?:linkedInAccountId|lead)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "linkedInAccountId", "lead" ] } }, "minItems": 1, "maxItems": 100 }, "resumeFinishedCampaign": { "type": "boolean" }, "resumePausedCampaign": { "type": "boolean" } }, "required": [ "accountLeadPairs" ], "patternProperties": { "^(?!(?:accountLeadPairs|resumeFinishedCampaign|resumePausedCampaign)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "accountLeadPairs", "resumeFinishedCampaign", "resumePausedCampaign" ] } }, "AddHeyReachListLeadsInput": { "type": "object", "properties": { "leads": { "type": "array", "items": { "$ref": "#/$defs/HeyReachLeadInput" }, "minItems": 1, "maxItems": 100 } }, "required": [ "leads" ], "patternProperties": { "^(?!(?:leads)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "leads" ] } ] } } } } ``` ### 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" }, "target": { "type": "string", "enum": [ "campaign" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "campaignLeads": { "$ref": "#/$defs/AddHeyReachCampaignLeadsInput" } }, "required": [ "workspaceId", "target", "campaignId", "campaignLeads" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|campaignId|campaignLeads)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "campaignId", "campaignLeads" ] }, { "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" }, "target": { "type": "string", "enum": [ "list" ] }, "listId": { "$ref": "#/$defs/HeyReachId" }, "listLeads": { "$ref": "#/$defs/AddHeyReachListLeadsInput" } }, "required": [ "workspaceId", "target", "listId", "listLeads" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|listId|listLeads)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "listId", "listLeads" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "LinkedInProfileUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "HeyReachLeadInput": { "type": "object", "properties": { "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "firstName": { "type": "string", "minLength": 1, "maxLength": 200 }, "lastName": { "type": "string", "minLength": 1, "maxLength": 200 }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "companyName": { "type": "string", "minLength": 0, "maxLength": 500 }, "position": { "type": "string", "minLength": 0, "maxLength": 500 }, "location": { "type": "string", "minLength": 0, "maxLength": 500 }, "summary": { "type": "string", "minLength": 0, "maxLength": 10000 }, "about": { "type": "string", "minLength": 0, "maxLength": 10000 }, "customUserFields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z0-9_]+$", "maxLength": 100 }, "value": { "type": "string", "minLength": 0, "maxLength": 10000 } }, "required": [ "name", "value" ], "patternProperties": { "^(?!(?:name|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "value" ] } }, "maxItems": 100 } }, "required": [ "profileUrl", "firstName", "lastName" ], "patternProperties": { "^(?!(?:profileUrl|firstName|lastName|emailAddress|companyName|position|location|summary|about|customUserFields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileUrl", "firstName", "lastName", "emailAddress", "companyName", "position", "location", "summary", "about", "customUserFields" ] } }, "AddHeyReachCampaignLeadsInput": { "type": "object", "properties": { "accountLeadPairs": { "type": "array", "items": { "type": "object", "properties": { "linkedInAccountId": { "$ref": "#/$defs/HeyReachId" }, "lead": { "$ref": "#/$defs/HeyReachLeadInput" } }, "required": [ "lead" ], "patternProperties": { "^(?!(?:linkedInAccountId|lead)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "linkedInAccountId", "lead" ] } }, "minItems": 1, "maxItems": 100 }, "resumeFinishedCampaign": { "type": "boolean" }, "resumePausedCampaign": { "type": "boolean" } }, "required": [ "accountLeadPairs" ], "patternProperties": { "^(?!(?:accountLeadPairs|resumeFinishedCampaign|resumePausedCampaign)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "accountLeadPairs", "resumeFinishedCampaign", "resumePausedCampaign" ] } }, "AddHeyReachListLeadsInput": { "type": "object", "properties": { "leads": { "type": "array", "items": { "$ref": "#/$defs/HeyReachLeadInput" }, "minItems": 1, "maxItems": 100 } }, "required": [ "leads" ], "patternProperties": { "^(?!(?:leads)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "leads" ] } ] } } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "HeyReachLeadCounts": { "type": "object", "properties": { "addedLeadsCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedLeadsCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failedLeadsCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "addedLeadsCount", "updatedLeadsCount", "failedLeadsCount" ], "patternProperties": { "^(?!(?:addedLeadsCount|updatedLeadsCount|failedLeadsCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "addedLeadsCount", "updatedLeadsCount", "failedLeadsCount" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/HeyReachLeadCounts" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/HeyReachLeadCounts" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `heyreachCampaigns.addLeads`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/leads` - `heyreachLists.addLeads`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/lists/:listId/leads` ## adopt_gmail_warmup_label Adopts an existing Gmail S0 label as the inbox's warmup label. When asked to reuse an already-created Gmail warmup label. For non-Google inboxes. Scopes: inbox:update, inbox:warmup_manage Risk: write; confirmation: none; idempotency: required. ### 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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxId" ] } } ``` ### 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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "connectionId": { "$ref": "#/$defs/OpaqueId" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "imap_smtp" ] }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "state": { "type": "string", "enum": [ "connected", "needs_reauthorization", "quarantined", "alert", "disconnected" ] }, "grantedScopes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "tokenExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "watchExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "credentialRefId": { "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" } ] }, "lastSyncAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "connectionId", "inboxId", "provider", "emailAddress", "state", "tokenExpiresAt", "watchExpiresAt", "credentialRefId", "lastSyncAt" ], "patternProperties": { "^(?!(?:connectionId|inboxId|provider|emailAddress|state|grantedScopes|tokenExpiresAt|watchExpiresAt|credentialRefId|lastSyncAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connectionId", "inboxId", "provider", "emailAddress", "state", "grantedScopes", "tokenExpiresAt", "watchExpiresAt", "credentialRefId", "lastSyncAt" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `inboxConnections.adoptWarmupS0Label`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/google-warmup-label/adopt` ## approve_permission_request Approve a pending permission request, adding all (default) or a chosen subset of the requested permissions to the requester's direct grants in the workspace. Use only when the reviewer explicitly approved this request and the exact permissions; pass confirmed: true. You can grant only permissions the reviewer holds. Never approve on your own initiative or your own person's request. To grant access without a request, use manage_organization_members. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspaceMember:update Risk: security_admin; confirmation: explicit; 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" }, "requestId": { "$ref": "#/$defs/PermissionRequestId" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "minItems": 1, "maxItems": 100 }, "note": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "confirmed": { "type": "boolean", "enum": [ true ] } }, "required": [ "workspaceId", "requestId", "confirmed" ], "patternProperties": { "^(?!(?:workspaceId|requestId|permissions|note|confirmed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "requestId", "permissions", "note", "confirmed" ] }, "$defs": { "PermissionRequestId": { "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" } } } ``` ### 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" }, "requestId": { "$ref": "#/$defs/PermissionRequestId" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "minItems": 1, "maxItems": 100 }, "note": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "confirmed": { "type": "boolean", "enum": [ true ] } }, "required": [ "workspaceId", "requestId", "confirmed" ], "patternProperties": { "^(?!(?:workspaceId|requestId|permissions|note|confirmed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "requestId", "permissions", "note", "confirmed" ] }, "$defs": { "PermissionRequestId": { "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" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "PermissionRequestId": { "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" }, "PermissionRequestStatus": { "type": "string", "enum": [ "pending", "approved", "denied", "canceled", "expired" ] }, "PermissionRequestPerson": { "type": "object", "properties": { "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, "PermissionRequestContext": { "type": "object", "properties": { "attemptedOperation": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "attemptedTool": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "explanation": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:attemptedOperation|attemptedTool|explanation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attemptedOperation", "attemptedTool", "explanation" ] } }, "PermissionRequestSource": { "type": "string", "enum": [ "web", "api", "agent" ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "PermissionRequest": { "type": "object", "properties": { "id": { "$ref": "#/$defs/PermissionRequestId" }, "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" }, "status": { "$ref": "#/$defs/PermissionRequestStatus" }, "requester": { "$ref": "#/$defs/PermissionRequestPerson" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "grantedPermissions": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "context": { "$ref": "#/$defs/PermissionRequestContext" }, "source": { "$ref": "#/$defs/PermissionRequestSource" }, "agentName": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "decidedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "decidedBy": { "anyOf": [ { "$ref": "#/$defs/PermissionRequestPerson" }, { "type": "null" } ] }, "decisionNote": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "reviewable": { "type": "boolean" } }, "required": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ], "patternProperties": { "^(?!(?:id|workspaceId|status|requester|permissions|grantedPermissions|reason|context|source|agentName|createdAt|expiresAt|decidedAt|decidedBy|decisionNote|reviewable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ] } }, "PermissionRequestDecisionResult": { "type": "object", "properties": { "request": { "$ref": "#/$defs/PermissionRequest" }, "changed": { "type": "boolean" } }, "required": [ "request", "changed" ], "patternProperties": { "^(?!(?:request|changed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "request", "changed" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/PermissionRequestDecisionResult" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/PermissionRequestDecisionResult" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `permissionRequests.approve`: `POST /v1/workspaces/:workspaceId/permission-requests/:requestId/approve` ## assign_leads Assign a campaign contact to a workspace member (action=assign) or remove the assignment (action=remove). Use to route a campaign contact; assign requires a current member, remove deliberately does not. Removal is idempotent and never fails for stale assignments — do not pre-check membership. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: lead:update Risk: write; confirmation: explicit; 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" }, "action": { "type": "string", "enum": [ "assign", "remove" ] }, "campaignContactId": { "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" }, "assigneeUserId": { "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", "campaignContactId", "assigneeUserId" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignContactId|assigneeUserId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignContactId", "assigneeUserId" ] } } ``` ### 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" }, "action": { "type": "string", "enum": [ "assign", "remove" ] }, "campaignContactId": { "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" }, "assigneeUserId": { "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", "campaignContactId", "assigneeUserId" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignContactId|assigneeUserId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignContactId", "assigneeUserId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ``` ### Underlying API operations - `campaignContactAssignments.create`: `POST /v1/workspaces/:workspaceId/leads/:campaignContactId/assignees` - `campaignContactAssignments.remove`: `DELETE /v1/workspaces/:workspaceId/leads/:campaignContactId/assignees/:assigneeUserId` ## assign_task Replace a task's assignee set. Use to route work to current workspace members. A pending human request can never be left without a possible responder; the call fails instead. Scopes: task:update 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" }, "taskId": { "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" }, "userIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 20 } }, "required": [ "workspaceId", "taskId", "userIds" ], "patternProperties": { "^(?!(?:workspaceId|taskId|userIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "taskId", "userIds" ] } } ``` ### 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" }, "taskId": { "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" }, "userIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 20 } }, "required": [ "workspaceId", "taskId", "userIds" ], "patternProperties": { "^(?!(?:workspaceId|taskId|userIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "taskId", "userIds" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "title": { "type": "string", "minLength": 1, "maxLength": 2000 }, "description": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedBy": { "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" } ] }, "outcome": { "anyOf": [ { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] }, { "type": "null" } ] }, "leadId": { "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" } ] }, "campaignContactId": { "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" } ] }, "campaignStepId": { "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" } ] }, "workflowRunId": { "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" } ] }, "workflow": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] }, "humanRequest": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "approval", "text" ] }, "question": { "$ref": "#/$defs/Description" } }, "required": [ "type", "question" ], "patternProperties": { "^(?!(?:type|question)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "question" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "choice" ] } ] }, "question": { "$ref": "#/$defs/Description" }, "options": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" }, "maxItems": 20 } }, "required": [ "type", "question", "options" ], "patternProperties": { "^(?!(?:type|question|options)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "question", "options" ] } } ] }, { "type": "null" } ] }, "humanResponse": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "approval" ] } ] }, "approved": { "type": "boolean" }, "comment": { "$ref": "#/$defs/ShortText" } }, "required": [ "type", "approved" ], "patternProperties": { "^(?!(?:type|approved|comment)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "approved", "comment" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] } ] }, "text": { "$ref": "#/$defs/Description" } }, "required": [ "type", "text" ], "patternProperties": { "^(?!(?:type|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "text" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "choice" ] } ] }, "choice": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "type", "choice" ], "patternProperties": { "^(?!(?:type|choice)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "choice" ] } } ] }, { "type": "null" } ] }, "requestState": { "anyOf": [ { "type": "string", "enum": [ "pending", "answered", "expired", "cancelled" ] }, { "type": "null" } ] }, "responseExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "requestedByAgentRegistrationId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "operationId": { "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" } ] }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } } }, "createdBy": { "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" } ] }, "createdByUser": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } }, { "type": "null" } ] }, "completedByUser": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } }, { "type": "null" } ] }, "lead": { "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" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "firstName", "lastName", "companyName", "emailAddress", "phoneNumber" ], "patternProperties": { "^(?!(?:id|firstName|lastName|companyName|emailAddress|phoneNumber)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "firstName", "lastName", "companyName", "emailAddress", "phoneNumber" ] } }, { "type": "null" } ] }, "outcomeDetail": { "anyOf": [ { "type": "object", "properties": { "phoneOutcomes": { "type": "array", "items": { "type": "object", "properties": { "leadPhoneId": { "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" }, "outcome": { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] } }, "required": [ "leadPhoneId", "outcome" ], "patternProperties": { "^(?!(?:leadPhoneId|outcome)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadPhoneId", "outcome" ] } }, "maxItems": 50 } }, "required": [ "phoneOutcomes" ], "patternProperties": { "^(?!(?:phoneOutcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "phoneOutcomes" ] } ] } }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "title", "description", "dueDate", "completedAt", "completedBy", "outcome", "leadId", "campaignContactId", "campaignStepId", "workflowRunId", "workflow", "humanRequest", "humanResponse", "requestState", "responseExpiresAt", "requestedByAgentRegistrationId", "operationId", "assignees", "createdBy", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|title|description|dueDate|completedAt|completedBy|outcome|leadId|campaignContactId|campaignStepId|workflowRunId|workflow|humanRequest|humanResponse|requestState|responseExpiresAt|requestedByAgentRegistrationId|operationId|assignees|createdBy|createdByUser|completedByUser|lead|outcomeDetail|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "title", "description", "dueDate", "completedAt", "completedBy", "outcome", "leadId", "campaignContactId", "campaignStepId", "workflowRunId", "workflow", "humanRequest", "humanResponse", "requestState", "responseExpiresAt", "requestedByAgentRegistrationId", "operationId", "assignees", "createdBy", "createdByUser", "completedByUser", "lead", "outcomeDetail", "createdAt", "updatedAt" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } } } ``` ### Underlying API operations - `tasks.setAssignees`: `POST /v1/workspaces/:workspaceId/tasks/:taskId/assignees` ## block_organization_api_key Block a member's personal API key from one Organization (preview, then commit with the confirmation token), or lift that block. The key keeps working in the member's other Organizations. Use when an Organization owner wants a member's key out of this Organization without revoking the member's credential everywhere. Requires orgApiKey:manage. To stop a member's access entirely, remove the member; their keys lose access with them. Use the native preview first and pass its confirmation token unchanged to commit. A token does not bypass current permissions or Workspace checks. Scopes: orgApiKey:manage Risk: security_admin; confirmation: preview_token; idempotency: required. ### Input schema (personal API key) ```json { "type": "object", "properties": { "organizationId": { "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" }, "apiKeyId": { "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": [ "block", "unblock" ] }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "organizationId", "apiKeyId", "action" ], "patternProperties": { "^(?!(?:organizationId|apiKeyId|action|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "apiKeyId", "action", "confirmationToken" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "organizationId": { "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" }, "apiKeyId": { "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": [ "block", "unblock" ] }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "organizationId", "apiKeyId", "action" ], "patternProperties": { "^(?!(?:organizationId|apiKeyId|action|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "apiKeyId", "action", "confirmationToken" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Money": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XCG", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWG" ] } }, "required": [ "amountMinor", "currency" ], "patternProperties": { "^(?!(?:amountMinor|currency)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "amountMinor", "currency" ] } }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "preview", "confirmationToken" ] } }, { "type": "object", "properties": { "blocked": { "type": "boolean" } }, "required": [ "blocked" ], "patternProperties": { "^(?!(?:blocked)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "blocked" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "preview", "confirmationToken" ] } }, { "type": "object", "properties": { "blocked": { "type": "boolean" } }, "required": [ "blocked" ], "patternProperties": { "^(?!(?:blocked)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "blocked" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `organizationApiKeys.previewBlock`: `POST /v1/organizations/:organizationId/api-keys/:apiKeyId/block-preview` - `organizationApiKeys.block`: `POST /v1/organizations/:organizationId/api-keys/:apiKeyId/block` - `organizationApiKeys.unblock`: `DELETE /v1/organizations/:organizationId/api-keys/:apiKeyId/block` ## browse_partnerships List the published partner offers (discounts and perks) every Scheduler Zero customer can redeem. Use when a person asks which partner discounts exist or how to redeem one. Account-only offers are not listed here; a signed-in person sees those in the web app. Scopes: workspace:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/PartnershipOfferId" }, "companyName": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": { "type": "string", "minLength": 1, "maxLength": 2000 }, "category": { "type": "string", "minLength": 1, "maxLength": 200 }, "logoUrl": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2048 }, { "type": "null" } ] }, "pageSlug": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "details": { "type": "string", "minLength": 0, "maxLength": 6000 }, "offerUrl": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 2048 }, { "type": "null" } ] }, "discountCode": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "terms": { "type": "string", "minLength": 0, "maxLength": 2000 }, "requiresAccount": { "type": "boolean" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "companyName", "description", "category", "logoUrl", "pageSlug", "details", "offerUrl", "discountCode", "terms", "requiresAccount", "updatedAt" ], "patternProperties": { "^(?!(?:id|companyName|description|category|logoUrl|pageSlug|details|offerUrl|discountCode|terms|requiresAccount|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "companyName", "description", "category", "logoUrl", "pageSlug", "details", "offerUrl", "discountCode", "terms", "requiresAccount", "updatedAt" ] } }, "maxItems": 500 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] }, "$defs": { "PartnershipOfferId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `partnerships.list`: `GET /partnerships` ## browse_plusvibe_targets List the PlusVibe workspaces, campaigns, or lead labels the connected key can reach. Use to pick the workspace, campaign ids, or label events a PlusVibe workflow block should target. Campaigns page with an opaque cursor. Each call reads PlusVibe live; do not poll it. Use get_plusvibe_status for connection health. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "resource": { "type": "string", "enum": [ "workspaces" ] }, "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" }, "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" } }, "required": [ "resource", "workspaceId", "connectionId" ], "patternProperties": { "^(?!(?:resource|workspaceId|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resource", "workspaceId", "connectionId" ] } }, { "type": "object", "properties": { "resource": { "type": "string", "enum": [ "campaigns" ] }, "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" }, "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" }, "providerWorkspaceId": { "$ref": "#/$defs/PlusVibeRemoteId" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "resource", "workspaceId", "connectionId", "providerWorkspaceId" ], "patternProperties": { "^(?!(?:resource|workspaceId|connectionId|providerWorkspaceId|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resource", "workspaceId", "connectionId", "providerWorkspaceId", "cursor", "limit" ] } }, { "type": "object", "properties": { "resource": { "type": "string", "enum": [ "labels" ] }, "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" }, "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" }, "providerWorkspaceId": { "$ref": "#/$defs/PlusVibeRemoteId" } }, "required": [ "resource", "workspaceId", "connectionId", "providerWorkspaceId" ], "patternProperties": { "^(?!(?:resource|workspaceId|connectionId|providerWorkspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resource", "workspaceId", "connectionId", "providerWorkspaceId" ] } } ], "$defs": { "PlusVibeRemoteId": { "type": "string", "minLength": 1, "maxLength": 100 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### 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" }, "resource": { "type": "string", "enum": [ "workspaces" ] }, "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" } }, "required": [ "resource", "workspaceId", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:resource|workspaceId|connectionId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "resource", "workspaceId", "connectionId" ] }, { "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" }, "resource": { "type": "string", "enum": [ "campaigns" ] }, "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" }, "providerWorkspaceId": { "$ref": "#/$defs/PlusVibeRemoteId" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "resource", "workspaceId", "connectionId", "providerWorkspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:resource|workspaceId|connectionId|providerWorkspaceId|cursor|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "resource", "workspaceId", "connectionId", "providerWorkspaceId", "cursor", "limit" ] }, { "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" }, "resource": { "type": "string", "enum": [ "labels" ] }, "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" }, "providerWorkspaceId": { "$ref": "#/$defs/PlusVibeRemoteId" } }, "required": [ "resource", "workspaceId", "connectionId", "providerWorkspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:resource|workspaceId|connectionId|providerWorkspaceId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "resource", "workspaceId", "connectionId", "providerWorkspaceId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "PlusVibeRemoteId": { "type": "string", "minLength": 1, "maxLength": 100 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "PlusVibeRemoteId": { "type": "string", "minLength": 1, "maxLength": 100 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/PlusVibeRemoteId" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/PlusVibeRemoteId" }, "workspaceId": { "$ref": "#/$defs/PlusVibeRemoteId" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "active", "paused", "draft", "completed", "archived", "deleted", "unknown" ] }, "providerStatus": { "$ref": "#/$defs/ShortText" }, "type": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "name", "status", "providerStatus", "type" ], "patternProperties": { "^(?!(?:id|workspaceId|name|status|providerStatus|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "status", "providerStatus", "type" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ProviderId" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/PlusVibeRemoteId" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/PlusVibeRemoteId" }, "workspaceId": { "$ref": "#/$defs/PlusVibeRemoteId" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "active", "paused", "draft", "completed", "archived", "deleted", "unknown" ] }, "providerStatus": { "$ref": "#/$defs/ShortText" }, "type": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "name", "status", "providerStatus", "type" ], "patternProperties": { "^(?!(?:id|workspaceId|name|status|providerStatus|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "status", "providerStatus", "type" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ProviderId" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `plusvibe.workspaces`: `GET /v1/workspaces/:workspaceId/integrations/plusvibe/:connectionId/workspaces` - `plusvibe.campaigns`: `GET /v1/workspaces/:workspaceId/integrations/plusvibe/:connectionId/workspaces/:providerWorkspaceId/campaigns` - `plusvibe.labels`: `GET /v1/workspaces/:workspaceId/integrations/plusvibe/:connectionId/workspaces/:providerWorkspaceId/labels` ## browse_unibox_threads Read a filtered thread list, one thread, its message metadata, one message, its contacts, or a contact photo by choosing an explicit action. Choose list, thread, messages, message, contacts, or contact_photo. For list, filters are the native thread-list query fields. For contacts and photos, use the local thread ID from list_unibox_threads. This is a replacement for the old sz://unibox resource template; it does not make that legacy URI resolvable. It returns no message bodies or attachment bytes, which remain separate reads. Warmup traffic remains limited to the warmup folder. Scopes: unibox:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "filters": { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "sortBy": { "type": "string", "enum": [ "lastMessageAt", "createdAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "readStatus": { "type": "string", "enum": [ "all", "read", "unread" ] }, "folder": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] }, "showAllEmails": { "type": "boolean" }, "inboxIds": { "type": "string" }, "campaignIds": { "type": "string" }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "string" }, "assigneeUserIds": { "type": "string" }, "organizationIds": { "type": "string" } }, "patternProperties": { "^(?!(?:cursor|limit|search|sortBy|sortOrder|readStatus|folder|showAllEmails|inboxIds|campaignIds|campaignFilter|labelIds|assigneeUserIds|organizationIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit", "search", "sortBy", "sortOrder", "readStatus", "folder", "showAllEmails", "inboxIds", "campaignIds", "campaignFilter", "labelIds", "assigneeUserIds", "organizationIds" ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|filters)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "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": { "anyOf": [ { "type": "string", "enum": [ "thread" ] } ] }, "threadId": { "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", "threadId" ], "patternProperties": { "^(?!(?:workspaceId|action|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "messages" ] } ] }, "threadId": { "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" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action", "threadId" ], "patternProperties": { "^(?!(?:workspaceId|action|threadId|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadId", "cursor", "limit" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "message" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "contacts" ] } ] }, "threadId": { "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", "threadId" ], "patternProperties": { "^(?!(?:workspaceId|action|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "contact_photo" ] } ] }, "threadId": { "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" }, "email": { "$ref": "#/$defs/EmailAddress" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "threadId", "email" ], "patternProperties": { "^(?!(?:workspaceId|action|threadId|email|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadId", "email", "inboxId" ] } } ], "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "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", "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": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "filters": { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "sortBy": { "type": "string", "enum": [ "lastMessageAt", "createdAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "readStatus": { "type": "string", "enum": [ "all", "read", "unread" ] }, "folder": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] }, "showAllEmails": { "type": "boolean" }, "inboxIds": { "type": "string" }, "campaignIds": { "type": "string" }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "string" }, "assigneeUserIds": { "type": "string" }, "organizationIds": { "type": "string" } }, "patternProperties": { "^(?!(?:cursor|limit|search|sortBy|sortOrder|readStatus|folder|showAllEmails|inboxIds|campaignIds|campaignFilter|labelIds|assigneeUserIds|organizationIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit", "search", "sortBy", "sortOrder", "readStatus", "folder", "showAllEmails", "inboxIds", "campaignIds", "campaignFilter", "labelIds", "assigneeUserIds", "organizationIds" ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|filters)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "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": { "anyOf": [ { "type": "string", "enum": [ "thread" ] } ] }, "threadId": { "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", "threadId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|threadId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "threadId" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "messages" ] } ] }, "threadId": { "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" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action", "threadId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|threadId|cursor|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "threadId", "cursor", "limit" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "message" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|messageId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "messageId" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "contacts" ] } ] }, "threadId": { "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", "threadId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|threadId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "threadId" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "contact_photo" ] } ] }, "threadId": { "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" }, "email": { "$ref": "#/$defs/EmailAddress" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "threadId", "email" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|threadId|email|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "threadId", "email", "inboxId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ThreadLabelId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "AttachmentId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "ProfilePhotoSource": { "type": "string", "minLength": 1, "maxLength": 1048576, "pattern": "^(?:https:\\/\\/|data:image\\/)" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "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" } ] }, "organizationId": { "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" }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "contact": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "leadId": { "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" } ] } }, "required": [ "emailAddress", "name", "leadId" ], "patternProperties": { "^(?!(?:emailAddress|name|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "name", "leadId" ] } }, "providerThreadId": { "$ref": "#/$defs/OpaqueId" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "lastMessageAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "messageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ThreadLabelId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isFormerMember": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isFormerMember" ], "patternProperties": { "^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isFormerMember" ] } } }, "campaignId": { "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" } ] }, "campaignContactId": { "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" } ] }, "isRead": { "type": "boolean" }, "starredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "folders": { "type": "array", "items": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] } }, "recentMessages": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isRead": { "type": "boolean" }, "isFromInboxSender": { "type": "boolean" } }, "required": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ], "patternProperties": { "^(?!(?:id|providerInternalMessageId|from|to|cc|subject|snippet|receivedAt|isRead|isFromInboxSender)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ] } }, "maxItems": 20 } }, "required": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders" ], "patternProperties": { "^(?!(?:id|inboxId|organizationId|subject|snippet|contact|providerThreadId|provider|lastMessageAt|messageCount|labels|assignees|campaignId|campaignContactId|isRead|starredAt|archivedAt|deletedAt|folders|recentMessages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders", "recentMessages" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor", "total" ] } }, { "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" }, "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" } ] }, "organizationId": { "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" }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "contact": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "leadId": { "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" } ] } }, "required": [ "emailAddress", "name", "leadId" ], "patternProperties": { "^(?!(?:emailAddress|name|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "name", "leadId" ] } }, "providerThreadId": { "$ref": "#/$defs/OpaqueId" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "lastMessageAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "messageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ThreadLabelId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isFormerMember": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isFormerMember" ], "patternProperties": { "^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isFormerMember" ] } } }, "campaignId": { "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" } ] }, "campaignContactId": { "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" } ] }, "isRead": { "type": "boolean" }, "starredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "folders": { "type": "array", "items": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] } }, "recentMessages": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isRead": { "type": "boolean" }, "isFromInboxSender": { "type": "boolean" } }, "required": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ], "patternProperties": { "^(?!(?:id|providerInternalMessageId|from|to|cc|subject|snippet|receivedAt|isRead|isFromInboxSender)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ] } }, "maxItems": 20 } }, "required": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders" ], "patternProperties": { "^(?!(?:id|inboxId|organizationId|subject|snippet|contact|providerThreadId|provider|lastMessageAt|messageCount|labels|assignees|campaignId|campaignContactId|isRead|starredAt|archivedAt|deletedAt|folders|recentMessages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders", "recentMessages" ] } }, { "type": "object", "properties": { "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" }, "threadId": { "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" }, "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" } ] }, "organizationId": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "rfc2822MessageId": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "isFromInboxSender": { "type": "boolean" }, "sentFromUnibox": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttachmentId" }, "filename": { "$ref": "#/$defs/ShortText" }, "contentType": { "$ref": "#/$defs/ShortText" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inline": { "type": "boolean" } }, "required": [ "id", "filename", "contentType", "size", "inline" ], "patternProperties": { "^(?!(?:id|filename|contentType|size|inline)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "filename", "contentType", "size", "inline" ] } } }, "bodyState": { "type": "string", "enum": [ "available", "pending" ] }, "isRead": { "type": "boolean" }, "flaggedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "headers": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 16384 } }, "authoredByWorkflowRunId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt" ], "patternProperties": { "^(?!(?:id|threadId|inboxId|organizationId|providerInternalMessageId|rfc2822MessageId|provider|from|to|cc|bcc|subject|snippet|receivedAt|direction|isFromInboxSender|sentFromUnibox|attachments|bodyState|isRead|flaggedAt|deletedAt|headers|authoredByWorkflowRunId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt", "headers", "authoredByWorkflowRunId" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "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" }, "threadId": { "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" }, "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" } ] }, "organizationId": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "rfc2822MessageId": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "isFromInboxSender": { "type": "boolean" }, "sentFromUnibox": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttachmentId" }, "filename": { "$ref": "#/$defs/ShortText" }, "contentType": { "$ref": "#/$defs/ShortText" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inline": { "type": "boolean" } }, "required": [ "id", "filename", "contentType", "size", "inline" ], "patternProperties": { "^(?!(?:id|filename|contentType|size|inline)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "filename", "contentType", "size", "inline" ] } } }, "bodyState": { "type": "string", "enum": [ "available", "pending" ] }, "isRead": { "type": "boolean" }, "flaggedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "headers": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 16384 } }, "authoredByWorkflowRunId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt" ], "patternProperties": { "^(?!(?:id|threadId|inboxId|organizationId|providerInternalMessageId|rfc2822MessageId|provider|from|to|cc|bcc|subject|snippet|receivedAt|direction|isFromInboxSender|sentFromUnibox|attachments|bodyState|isRead|flaggedAt|deletedAt|headers|authoredByWorkflowRunId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt", "headers", "authoredByWorkflowRunId" ] } }, { "type": "object", "properties": { "threadId": { "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" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "contactId": { "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" }, "campaignId": { "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" } ] }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "leadId": { "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" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "company": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "city": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "status": { "type": "string", "enum": [ "not_contacted", "contacted", "completed", "task_pending", "task_failed", "paused", "out_of_office", "bounced", "unsubscribed", "ladder_queued", "moved_to_subsequence" ] }, "esp": { "anyOf": [ { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, { "type": "null" } ] }, "gateway": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "contactId", "campaignId", "campaignName", "leadId", "email", "firstName", "lastName", "company", "jobTitle", "phone", "city", "state", "country", "timezone", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "customFieldValues", "status", "esp", "gateway" ], "patternProperties": { "^(?!(?:contactId|campaignId|campaignName|leadId|email|firstName|lastName|company|jobTitle|phone|city|state|country|timezone|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|customFieldValues|status|esp|gateway)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "campaignId", "campaignName", "leadId", "email", "firstName", "lastName", "company", "jobTitle", "phone", "city", "state", "country", "timezone", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "customFieldValues", "status", "esp", "gateway" ] } }, "maxItems": 200 } }, "required": [ "threadId", "contacts" ], "patternProperties": { "^(?!(?:threadId|contacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "contacts" ] } }, { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "photoUrl": { "anyOf": [ { "$ref": "#/$defs/ProfilePhotoSource" }, { "type": "null" } ] } }, "required": [ "email", "photoUrl" ], "patternProperties": { "^(?!(?:email|photoUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "photoUrl" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "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" } ] }, "organizationId": { "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" }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "contact": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "leadId": { "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" } ] } }, "required": [ "emailAddress", "name", "leadId" ], "patternProperties": { "^(?!(?:emailAddress|name|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "name", "leadId" ] } }, "providerThreadId": { "$ref": "#/$defs/OpaqueId" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "lastMessageAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "messageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ThreadLabelId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isFormerMember": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isFormerMember" ], "patternProperties": { "^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isFormerMember" ] } } }, "campaignId": { "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" } ] }, "campaignContactId": { "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" } ] }, "isRead": { "type": "boolean" }, "starredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "folders": { "type": "array", "items": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] } }, "recentMessages": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isRead": { "type": "boolean" }, "isFromInboxSender": { "type": "boolean" } }, "required": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ], "patternProperties": { "^(?!(?:id|providerInternalMessageId|from|to|cc|subject|snippet|receivedAt|isRead|isFromInboxSender)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ] } }, "maxItems": 20 } }, "required": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders" ], "patternProperties": { "^(?!(?:id|inboxId|organizationId|subject|snippet|contact|providerThreadId|provider|lastMessageAt|messageCount|labels|assignees|campaignId|campaignContactId|isRead|starredAt|archivedAt|deletedAt|folders|recentMessages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders", "recentMessages" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor", "total" ] } }, { "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" }, "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" } ] }, "organizationId": { "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" }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "contact": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "leadId": { "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" } ] } }, "required": [ "emailAddress", "name", "leadId" ], "patternProperties": { "^(?!(?:emailAddress|name|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "name", "leadId" ] } }, "providerThreadId": { "$ref": "#/$defs/OpaqueId" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "lastMessageAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "messageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ThreadLabelId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isFormerMember": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isFormerMember" ], "patternProperties": { "^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isFormerMember" ] } } }, "campaignId": { "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" } ] }, "campaignContactId": { "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" } ] }, "isRead": { "type": "boolean" }, "starredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "folders": { "type": "array", "items": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] } }, "recentMessages": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isRead": { "type": "boolean" }, "isFromInboxSender": { "type": "boolean" } }, "required": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ], "patternProperties": { "^(?!(?:id|providerInternalMessageId|from|to|cc|subject|snippet|receivedAt|isRead|isFromInboxSender)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ] } }, "maxItems": 20 } }, "required": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders" ], "patternProperties": { "^(?!(?:id|inboxId|organizationId|subject|snippet|contact|providerThreadId|provider|lastMessageAt|messageCount|labels|assignees|campaignId|campaignContactId|isRead|starredAt|archivedAt|deletedAt|folders|recentMessages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders", "recentMessages" ] } }, { "type": "object", "properties": { "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" }, "threadId": { "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" }, "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" } ] }, "organizationId": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "rfc2822MessageId": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "isFromInboxSender": { "type": "boolean" }, "sentFromUnibox": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttachmentId" }, "filename": { "$ref": "#/$defs/ShortText" }, "contentType": { "$ref": "#/$defs/ShortText" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inline": { "type": "boolean" } }, "required": [ "id", "filename", "contentType", "size", "inline" ], "patternProperties": { "^(?!(?:id|filename|contentType|size|inline)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "filename", "contentType", "size", "inline" ] } } }, "bodyState": { "type": "string", "enum": [ "available", "pending" ] }, "isRead": { "type": "boolean" }, "flaggedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "headers": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 16384 } }, "authoredByWorkflowRunId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt" ], "patternProperties": { "^(?!(?:id|threadId|inboxId|organizationId|providerInternalMessageId|rfc2822MessageId|provider|from|to|cc|bcc|subject|snippet|receivedAt|direction|isFromInboxSender|sentFromUnibox|attachments|bodyState|isRead|flaggedAt|deletedAt|headers|authoredByWorkflowRunId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt", "headers", "authoredByWorkflowRunId" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "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" }, "threadId": { "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" }, "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" } ] }, "organizationId": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "rfc2822MessageId": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "isFromInboxSender": { "type": "boolean" }, "sentFromUnibox": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttachmentId" }, "filename": { "$ref": "#/$defs/ShortText" }, "contentType": { "$ref": "#/$defs/ShortText" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inline": { "type": "boolean" } }, "required": [ "id", "filename", "contentType", "size", "inline" ], "patternProperties": { "^(?!(?:id|filename|contentType|size|inline)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "filename", "contentType", "size", "inline" ] } } }, "bodyState": { "type": "string", "enum": [ "available", "pending" ] }, "isRead": { "type": "boolean" }, "flaggedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "headers": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 16384 } }, "authoredByWorkflowRunId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt" ], "patternProperties": { "^(?!(?:id|threadId|inboxId|organizationId|providerInternalMessageId|rfc2822MessageId|provider|from|to|cc|bcc|subject|snippet|receivedAt|direction|isFromInboxSender|sentFromUnibox|attachments|bodyState|isRead|flaggedAt|deletedAt|headers|authoredByWorkflowRunId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt", "headers", "authoredByWorkflowRunId" ] } }, { "type": "object", "properties": { "threadId": { "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" }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "contactId": { "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" }, "campaignId": { "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" } ] }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "leadId": { "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" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "company": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "city": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "status": { "type": "string", "enum": [ "not_contacted", "contacted", "completed", "task_pending", "task_failed", "paused", "out_of_office", "bounced", "unsubscribed", "ladder_queued", "moved_to_subsequence" ] }, "esp": { "anyOf": [ { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, { "type": "null" } ] }, "gateway": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "contactId", "campaignId", "campaignName", "leadId", "email", "firstName", "lastName", "company", "jobTitle", "phone", "city", "state", "country", "timezone", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "customFieldValues", "status", "esp", "gateway" ], "patternProperties": { "^(?!(?:contactId|campaignId|campaignName|leadId|email|firstName|lastName|company|jobTitle|phone|city|state|country|timezone|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|customFieldValues|status|esp|gateway)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "campaignId", "campaignName", "leadId", "email", "firstName", "lastName", "company", "jobTitle", "phone", "city", "state", "country", "timezone", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "customFieldValues", "status", "esp", "gateway" ] } }, "maxItems": 200 } }, "required": [ "threadId", "contacts" ], "patternProperties": { "^(?!(?:threadId|contacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "contacts" ] } }, { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "photoUrl": { "anyOf": [ { "$ref": "#/$defs/ProfilePhotoSource" }, { "type": "null" } ] } }, "required": [ "email", "photoUrl" ], "patternProperties": { "^(?!(?:email|photoUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "photoUrl" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `uniboxThreads.list`: `GET /v1/workspaces/:workspaceId/unibox/threads` - `uniboxThreads.get`: `GET /v1/workspaces/:workspaceId/unibox/threads/:threadId` - `uniboxThreads.listMessages`: `GET /v1/workspaces/:workspaceId/unibox/threads/:threadId/messages` - `uniboxMessages.get`: `GET /v1/workspaces/:workspaceId/unibox/messages/:messageId` - `uniboxContacts.get`: `GET /v1/workspaces/:workspaceId/unibox/threads/:threadId/contact` - `uniboxContacts.getPhoto`: `GET /v1/workspaces/:workspaceId/unibox/threads/:threadId/contact/photo` ## cancel_dialer_addon Schedule the dialer add-on to end at the close of the paid period, with the reason the workspace gave. Use when a workspace has decided to stop dialing. Service continues until the effective date, so nothing is cut off mid-call. Cancelling does not release numbers or revoke seats, and re-subscribing is a new purchase. Confirm with a human before running it. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: dialer:manage_billing Risk: destructive; confirmation: explicit; 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" }, "cancel": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "cost", "missing_features", "bugs_quality", "not_using", "switching", "other" ] }, "feedback": { "type": "string", "maxLength": 2000 }, "fairPrice": { "type": "string", "maxLength": 100 } }, "required": [ "reason" ], "patternProperties": { "^(?!(?:reason|feedback|fairPrice)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "feedback", "fairPrice" ] } } }, "required": [ "workspaceId", "cancel" ], "patternProperties": { "^(?!(?:workspaceId|cancel)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "cancel" ] } } ``` ### 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" }, "cancel": { "type": "object", "properties": { "reason": { "type": "string", "enum": [ "cost", "missing_features", "bugs_quality", "not_using", "switching", "other" ] }, "feedback": { "type": "string", "maxLength": 2000 }, "fairPrice": { "type": "string", "maxLength": 100 } }, "required": [ "reason" ], "patternProperties": { "^(?!(?:reason|feedback|fairPrice)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "feedback", "fairPrice" ] } } }, "required": [ "workspaceId", "cancel" ], "patternProperties": { "^(?!(?:workspaceId|cancel)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "cancel" ] } } ``` ### 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$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "canceled": { "type": "boolean" }, "effectiveAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "canceled", "effectiveAt" ], "patternProperties": { "^(?!(?:canceled|effectiveAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "canceled", "effectiveAt" ] } }, { "type": "object", "properties": { "active": { "type": "boolean" }, "cancelAtPeriodEnd": { "type": "boolean" }, "plan": { "anyOf": [ { "type": "string", "enum": [ "dialer_5", "dialer_10" ] }, { "type": "null" } ] }, "purchasedSeats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "assignedSeats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "numbersPerSeat": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "active", "cancelAtPeriodEnd", "plan", "purchasedSeats", "assignedSeats", "numbersPerSeat" ], "patternProperties": { "^(?!(?:active|cancelAtPeriodEnd|plan|purchasedSeats|assignedSeats|numbersPerSeat)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "active", "cancelAtPeriodEnd", "plan", "purchasedSeats", "assignedSeats", "numbersPerSeat" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "canceled": { "type": "boolean" }, "effectiveAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "canceled", "effectiveAt" ], "patternProperties": { "^(?!(?:canceled|effectiveAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "canceled", "effectiveAt" ] } }, { "type": "object", "properties": { "active": { "type": "boolean" }, "cancelAtPeriodEnd": { "type": "boolean" }, "plan": { "anyOf": [ { "type": "string", "enum": [ "dialer_5", "dialer_10" ] }, { "type": "null" } ] }, "purchasedSeats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "assignedSeats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "numbersPerSeat": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "active", "cancelAtPeriodEnd", "plan", "purchasedSeats", "assignedSeats", "numbersPerSeat" ], "patternProperties": { "^(?!(?:active|cancelAtPeriodEnd|plan|purchasedSeats|assignedSeats|numbersPerSeat)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "active", "cancelAtPeriodEnd", "plan", "purchasedSeats", "assignedSeats", "numbersPerSeat" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `dialerBilling.cancel`: `POST /v1/workspaces/:workspaceId/dialer/billing/cancel` - `dialerBilling.status`: `GET /v1/workspaces/:workspaceId/dialer/billing/status` ## cancel_operation Request cancellation of a durable operation where its kind supports cancellation. Use to stop queued or running work the agent no longer needs; the result reports whether cancellation took. Cancellation is not a rollback; completed work and already-sent side effects stay done. Scopes: agent:operations:cancel, agent:operations:read Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "operationId": { "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": [ "operationId" ], "patternProperties": { "^(?!(?:operationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "operationId" ] } ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "operationId": { "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": [ "operationId" ], "patternProperties": { "^(?!(?:operationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "operationId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "cancellation": { "type": "string", "enum": [ "supported", "requested", "terminal" ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] } }, "required": [ "id", "cancellation", "state" ], "patternProperties": { "^(?!(?:id|cancellation|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "cancellation", "state" ] } } ``` ### Underlying API operations - `agent.cancelOperation`: `POST /agent/operations/:operationId/cancel` - `agent.getOperation`: `GET /agent/operations/:operationId` ## cancel_permission_request Withdraw the person's own pending permission request. Use when the person no longer needs the access they asked for. Cancelling a request that is no longer pending is a no-op. It cannot cancel someone else's request. Scopes: workspace: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" }, "requestId": { "$ref": "#/$defs/PermissionRequestId" } }, "required": [ "workspaceId", "requestId" ], "patternProperties": { "^(?!(?:workspaceId|requestId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "requestId" ] }, "$defs": { "PermissionRequestId": { "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" } } } ``` ### 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" }, "requestId": { "$ref": "#/$defs/PermissionRequestId" } }, "required": [ "workspaceId", "requestId" ], "patternProperties": { "^(?!(?:workspaceId|requestId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "requestId" ] }, "$defs": { "PermissionRequestId": { "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" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "PermissionRequestId": { "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" }, "PermissionRequestStatus": { "type": "string", "enum": [ "pending", "approved", "denied", "canceled", "expired" ] }, "PermissionRequestPerson": { "type": "object", "properties": { "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, "PermissionRequestContext": { "type": "object", "properties": { "attemptedOperation": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "attemptedTool": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "explanation": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:attemptedOperation|attemptedTool|explanation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attemptedOperation", "attemptedTool", "explanation" ] } }, "PermissionRequestSource": { "type": "string", "enum": [ "web", "api", "agent" ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "PermissionRequest": { "type": "object", "properties": { "id": { "$ref": "#/$defs/PermissionRequestId" }, "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" }, "status": { "$ref": "#/$defs/PermissionRequestStatus" }, "requester": { "$ref": "#/$defs/PermissionRequestPerson" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "grantedPermissions": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "context": { "$ref": "#/$defs/PermissionRequestContext" }, "source": { "$ref": "#/$defs/PermissionRequestSource" }, "agentName": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "decidedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "decidedBy": { "anyOf": [ { "$ref": "#/$defs/PermissionRequestPerson" }, { "type": "null" } ] }, "decisionNote": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "reviewable": { "type": "boolean" } }, "required": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ], "patternProperties": { "^(?!(?:id|workspaceId|status|requester|permissions|grantedPermissions|reason|context|source|agentName|createdAt|expiresAt|decidedAt|decidedBy|decisionNote|reviewable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ] } }, "PermissionRequestDecisionResult": { "type": "object", "properties": { "request": { "$ref": "#/$defs/PermissionRequest" }, "changed": { "type": "boolean" } }, "required": [ "request", "changed" ], "patternProperties": { "^(?!(?:request|changed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "request", "changed" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/PermissionRequestDecisionResult" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/PermissionRequestDecisionResult" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `permissionRequests.cancel`: `POST /v1/workspaces/:workspaceId/permission-requests/:requestId/cancel` ## cancel_reminder Cancel a pending reminder and release its scheduled send. Use when a follow-up is no longer needed; cancellation works even when the subscription is frozen. Cancellation cannot resurrect a sent reminder; check status first. Scopes: unibox:reply Risk: write; confirmation: none; idempotency: required. ### 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" }, "reminderId": { "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", "reminderId" ], "patternProperties": { "^(?!(?:workspaceId|reminderId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "reminderId" ] } } ``` ### 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" }, "reminderId": { "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", "reminderId" ], "patternProperties": { "^(?!(?:workspaceId|reminderId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "reminderId" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "threadId": { "$ref": "#/$defs/ProviderId" }, "remindAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isAutomatic": { "type": "boolean" }, "status": { "type": "string", "enum": [ "pending", "sent", "cancelled" ] }, "sentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "jobRunId": { "anyOf": [ { "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": "string", "pattern": "^run_[a-zA-Z0-9]{1,200}$" } ] }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "threadId", "remindAt", "isAutomatic", "status", "sentAt", "cancelledAt", "jobRunId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|threadId|remindAt|isAutomatic|status|sentAt|cancelledAt|jobRunId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "threadId", "remindAt", "isAutomatic", "status", "sentAt", "cancelledAt", "jobRunId", "createdAt", "updatedAt" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `reminders.cancel`: `POST /v1/workspaces/:workspaceId/reminders/:reminderId/cancel` ## complete_task Mark an ordinary task complete or reopen it. Use for ordinary tasks; campaign-linked tasks also record an outcome. A pending human request must be answered through its respond flow — completion never bypasses it. Scopes: task:update 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" }, "taskId": { "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" }, "completed": { "type": "boolean" }, "outcome": { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] }, "phoneOutcomes": { "type": "array", "items": { "type": "object", "properties": { "leadPhoneId": { "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" }, "outcome": { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] } }, "required": [ "leadPhoneId", "outcome" ], "patternProperties": { "^(?!(?:leadPhoneId|outcome)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadPhoneId", "outcome" ] } }, "maxItems": 50 } }, "required": [ "workspaceId", "taskId", "completed" ], "patternProperties": { "^(?!(?:workspaceId|taskId|completed|outcome|phoneOutcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "taskId", "completed", "outcome", "phoneOutcomes" ] } } ``` ### 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" }, "taskId": { "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" }, "completed": { "type": "boolean" }, "outcome": { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] }, "phoneOutcomes": { "type": "array", "items": { "type": "object", "properties": { "leadPhoneId": { "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" }, "outcome": { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] } }, "required": [ "leadPhoneId", "outcome" ], "patternProperties": { "^(?!(?:leadPhoneId|outcome)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadPhoneId", "outcome" ] } }, "maxItems": 50 } }, "required": [ "workspaceId", "taskId", "completed" ], "patternProperties": { "^(?!(?:workspaceId|taskId|completed|outcome|phoneOutcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "taskId", "completed", "outcome", "phoneOutcomes" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "title": { "type": "string", "minLength": 1, "maxLength": 2000 }, "description": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedBy": { "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" } ] }, "outcome": { "anyOf": [ { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] }, { "type": "null" } ] }, "leadId": { "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" } ] }, "campaignContactId": { "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" } ] }, "campaignStepId": { "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" } ] }, "workflowRunId": { "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" } ] }, "workflow": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] }, "humanRequest": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "approval", "text" ] }, "question": { "$ref": "#/$defs/Description" } }, "required": [ "type", "question" ], "patternProperties": { "^(?!(?:type|question)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "question" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "choice" ] } ] }, "question": { "$ref": "#/$defs/Description" }, "options": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" }, "maxItems": 20 } }, "required": [ "type", "question", "options" ], "patternProperties": { "^(?!(?:type|question|options)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "question", "options" ] } } ] }, { "type": "null" } ] }, "humanResponse": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "approval" ] } ] }, "approved": { "type": "boolean" }, "comment": { "$ref": "#/$defs/ShortText" } }, "required": [ "type", "approved" ], "patternProperties": { "^(?!(?:type|approved|comment)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "approved", "comment" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] } ] }, "text": { "$ref": "#/$defs/Description" } }, "required": [ "type", "text" ], "patternProperties": { "^(?!(?:type|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "text" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "choice" ] } ] }, "choice": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "type", "choice" ], "patternProperties": { "^(?!(?:type|choice)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "choice" ] } } ] }, { "type": "null" } ] }, "requestState": { "anyOf": [ { "type": "string", "enum": [ "pending", "answered", "expired", "cancelled" ] }, { "type": "null" } ] }, "responseExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "requestedByAgentRegistrationId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "operationId": { "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" } ] }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } } }, "createdBy": { "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" } ] }, "createdByUser": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } }, { "type": "null" } ] }, "completedByUser": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } }, { "type": "null" } ] }, "lead": { "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" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "firstName", "lastName", "companyName", "emailAddress", "phoneNumber" ], "patternProperties": { "^(?!(?:id|firstName|lastName|companyName|emailAddress|phoneNumber)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "firstName", "lastName", "companyName", "emailAddress", "phoneNumber" ] } }, { "type": "null" } ] }, "outcomeDetail": { "anyOf": [ { "type": "object", "properties": { "phoneOutcomes": { "type": "array", "items": { "type": "object", "properties": { "leadPhoneId": { "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" }, "outcome": { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] } }, "required": [ "leadPhoneId", "outcome" ], "patternProperties": { "^(?!(?:leadPhoneId|outcome)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadPhoneId", "outcome" ] } }, "maxItems": 50 } }, "required": [ "phoneOutcomes" ], "patternProperties": { "^(?!(?:phoneOutcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "phoneOutcomes" ] } ] } }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "title", "description", "dueDate", "completedAt", "completedBy", "outcome", "leadId", "campaignContactId", "campaignStepId", "workflowRunId", "workflow", "humanRequest", "humanResponse", "requestState", "responseExpiresAt", "requestedByAgentRegistrationId", "operationId", "assignees", "createdBy", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|title|description|dueDate|completedAt|completedBy|outcome|leadId|campaignContactId|campaignStepId|workflowRunId|workflow|humanRequest|humanResponse|requestState|responseExpiresAt|requestedByAgentRegistrationId|operationId|assignees|createdBy|createdByUser|completedByUser|lead|outcomeDetail|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "title", "description", "dueDate", "completedAt", "completedBy", "outcome", "leadId", "campaignContactId", "campaignStepId", "workflowRunId", "workflow", "humanRequest", "humanResponse", "requestState", "responseExpiresAt", "requestedByAgentRegistrationId", "operationId", "assignees", "createdBy", "createdByUser", "completedByUser", "lead", "outcomeDetail", "createdAt", "updatedAt" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } } } ``` ### Underlying API operations - `tasks.setCompleted`: `POST /v1/workspaces/:workspaceId/tasks/:taskId/completed` ## configure_getleads_rate_limit Set how many GetLeads requests per minute this workspace may start (1–100). Use to slow the workspace down when GetLeads answers with rate limits, or to raise the pace for a planned run. The gate is shared by every caller using the same key; it cannot exceed GetLeads' own limits. Scopes: integration:update 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" }, "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" }, "requestsPerMinute": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "connectionId", "requestsPerMinute" ], "patternProperties": { "^(?!(?:workspaceId|connectionId|requestsPerMinute)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId", "requestsPerMinute" ] } } ``` ### 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" }, "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" }, "requestsPerMinute": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "connectionId", "requestsPerMinute" ], "patternProperties": { "^(?!(?:workspaceId|connectionId|requestsPerMinute)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId", "requestsPerMinute" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "status": { "type": "string", "enum": [ "connected", "needs_reauthorization", "disabled", "disconnected" ] }, "keyLastFour": { "type": "string", "pattern": "^.{4}$" }, "requestsPerMinute": { "type": "integer", "minimum": 1, "maximum": 100 }, "webhookEnabled": { "type": "boolean" }, "lastWebhookAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "connectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "status", "keyLastFour", "requestsPerMinute", "webhookEnabled", "lastWebhookAt", "lastValidatedAt", "connectedAt" ], "patternProperties": { "^(?!(?:id|status|keyLastFour|requestsPerMinute|webhookEnabled|lastWebhookAt|lastValidatedAt|connectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "status", "keyLastFour", "requestsPerMinute", "webhookEnabled", "lastWebhookAt", "lastValidatedAt", "connectedAt" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `getleads.setRateLimit`: `PATCH /v1/workspaces/:workspaceId/integrations/getleads/:connectionId/rate-limit` ## connect_attio Start the Attio OAuth connection for a workspace by returning a signed-state authorization URL. Use when the workspace needs an Attio connection; hand the URL to a human and poll getStatus. Agents never transmit the authorization code or tokens; do not attempt the callback directly. Return the authorization or checkout handoff to the person. The agent may initiate and inspect status, but must not complete the human approval. Scopes: integration:create, integration:read Risk: write; confirmation: human_completion; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "authorizationUrl": { "$ref": "#/$defs/HttpUrl" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "authorizationUrl", "expiresAt" ], "patternProperties": { "^(?!(?:authorizationUrl|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authorizationUrl", "expiresAt" ] }, "$defs": { "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$" } } } ``` ### Underlying API operations - `attio.getAuthUrl`: `POST /v1/workspaces/:workspaceId/integrations/attio/oauth` - `attio.getStatus`: `GET /v1/workspaces/:workspaceId/integrations/attio` ## connect_calendly Start the Calendly OAuth connection for a workspace by returning a signed-state authorization URL. Use when the workspace needs a calendar connection; hand the URL to a human and poll getStatus. Agents never transmit the authorization code or tokens; do not attempt the callback directly. Return the authorization or checkout handoff to the person. The agent may initiate and inspect status, but must not complete the human approval. Scopes: integration:create, integration:read Risk: write; confirmation: human_completion; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "authorizationUrl": { "$ref": "#/$defs/HttpUrl" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "authorizationUrl", "expiresAt" ], "patternProperties": { "^(?!(?:authorizationUrl|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authorizationUrl", "expiresAt" ] }, "$defs": { "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$" } } } ``` ### Underlying API operations - `booking.calendly.getAuthUrl`: `POST /v1/workspaces/:workspaceId/booking/calendly/oauth` - `booking.calendly.getStatus`: `GET /v1/workspaces/:workspaceId/booking/calendly` ## connect_google_inbox Mints a signed-state Google authorization URL; a human completes consent in the browser and the inbox appears on the next sync. When asked to connect a new Google Workspace/Gmail inbox. For Microsoft or IMAP/SMTP inboxes, or for reconnecting an existing inbox. Return the authorization or checkout handoff to the person. The agent may initiate and inspect status, but must not complete the human approval. Scopes: inbox:connect, inbox:read Risk: write; confirmation: human_completion; 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "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" ] }, "$defs": { "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 } } } ``` ### Underlying API operations - `inboxConnections.startGoogleOAuth`: `POST /v1/workspaces/:workspaceId/inbox-connections/google/oauth` - `inboxes.list`: `GET /v1/workspaces/:workspaceId/inboxes` ## connect_mailbox_provider Starts a human handoff so a workspace member can enter a Cheap Inboxes or Inboxing API key. The agent receives the workspace inboxes URL, which does not expire. Initiating this handoff requires only integration:create. When asked to connect a mailbox vendor. Hand the URL to a member. Poll saved connections with manage_mailbox_provider_import, which requires integration:read. Do not treat the URL as time-limited. Do not collect, transmit, or guess the vendor API key. identify and connect stay on the human page. Do not request integration:read just to start this handoff. Return the authorization or checkout handoff to the person. The agent may initiate and inspect status, but must not complete the human approval. Scopes: integration:create Risk: write; confirmation: human_completion; idempotency: none. ### 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" }, "provider": { "type": "string", "enum": [ "cheap_inboxes", "inboxing" ] } }, "required": [ "workspaceId", "provider" ], "patternProperties": { "^(?!(?:workspaceId|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider" ] } } ``` ### 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" }, "provider": { "type": "string", "enum": [ "cheap_inboxes", "inboxing" ] } }, "required": [ "workspaceId", "provider" ], "patternProperties": { "^(?!(?:workspaceId|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "cheap_inboxes", "inboxing" ] }, "handoffUrl": { "$ref": "#/$defs/HttpUrl" }, "status": { "anyOf": [ { "type": "string", "enum": [ "awaiting_human" ] } ] } }, "required": [ "provider", "handoffUrl", "status" ], "patternProperties": { "^(?!(?:provider|handoffUrl|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "handoffUrl", "status" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } } } ``` ### Underlying API operations - `inboxProviderImports.prepareConnect`: `POST /v1/workspaces/:workspaceId/inbox-providers/connections/handoff` ## connect_microsoft_inbox Mints a signed-state Microsoft authorization URL; a human completes consent in the browser. When asked to connect a Microsoft 365 / Outlook inbox. For Google or IMAP/SMTP inboxes. Return the authorization or checkout handoff to the person. The agent may initiate and inspect status, but must not complete the human approval. Scopes: inbox:connect, inbox:read Risk: write; confirmation: human_completion; 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "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" ] }, "$defs": { "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 } } } ``` ### Underlying API operations - `inboxConnections.startMicrosoftOAuth`: `POST /v1/workspaces/:workspaceId/inbox-connections/microsoft/oauth` - `inboxes.list`: `GET /v1/workspaces/:workspaceId/inboxes` ## connect_workflow_integration Start connecting an app — or a customer's own MCP server — that an agent block may later call, and hand back the authorization URL a person opens to finish it. Use when a graph needs an app this workspace has not authorized yet. The agent proposes the connection and the person authorizes it; poll the MCP server list to see when the authorization lands. The agent never sees or carries the authorization itself — the provider issues it to the person who opens the URL. A no-auth toolkit finishes without a URL, which the result states rather than leaving you to infer from a null. Connecting is disabled on preview deployments, which share real customer accounts. Return the authorization or checkout handoff to the person. The agent may initiate and inspect status, but must not complete the human approval. Scopes: integration:create, integration:read Risk: security_admin; confirmation: human_completion; 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" }, "connect": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "app" ] }, "name": { "$ref": "#/$defs/ShortText" }, "toolkitSlug": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } }, "required": [ "kind", "name", "toolkitSlug" ], "patternProperties": { "^(?!(?:kind|name|toolkitSlug)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "name", "toolkitSlug" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "custom" ] }, "name": { "$ref": "#/$defs/ShortText" }, "url": { "$ref": "#/$defs/HttpsUrl" }, "auth": { "type": "string", "enum": [ "no_auth", "api_key", "dcr_oauth" ] }, "discoveryUrl": { "$ref": "#/$defs/HttpsUrl" }, "headerName": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[A-Za-z0-9-]+$" }, "headerPrefix": { "type": "string", "maxLength": 50, "pattern": "^[^\\r\\n]*$" } }, "required": [ "kind", "name", "url", "auth" ], "patternProperties": { "^(?!(?:kind|name|url|auth|discoveryUrl|headerName|headerPrefix)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "name", "url", "auth", "discoveryUrl", "headerName", "headerPrefix" ] } } ] } }, "required": [ "workspaceId", "connect" ], "patternProperties": { "^(?!(?:workspaceId|connect)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connect" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HttpsUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\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" }, "connect": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "app" ] }, "name": { "$ref": "#/$defs/ShortText" }, "toolkitSlug": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-zA-Z0-9_-]+$" } }, "required": [ "kind", "name", "toolkitSlug" ], "patternProperties": { "^(?!(?:kind|name|toolkitSlug)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "name", "toolkitSlug" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "custom" ] }, "name": { "$ref": "#/$defs/ShortText" }, "url": { "$ref": "#/$defs/HttpsUrl" }, "auth": { "type": "string", "enum": [ "no_auth", "api_key", "dcr_oauth" ] }, "discoveryUrl": { "$ref": "#/$defs/HttpsUrl" }, "headerName": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[A-Za-z0-9-]+$" }, "headerPrefix": { "type": "string", "maxLength": 50, "pattern": "^[^\\r\\n]*$" } }, "required": [ "kind", "name", "url", "auth" ], "patternProperties": { "^(?!(?:kind|name|url|auth|discoveryUrl|headerName|headerPrefix)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "name", "url", "auth", "discoveryUrl", "headerName", "headerPrefix" ] } } ] } }, "required": [ "workspaceId", "connect" ], "patternProperties": { "^(?!(?:workspaceId|connect)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connect" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HttpsUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "WorkflowMcpServerId": { "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" }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "requiresAuthorization": { "type": "boolean" }, "redirectUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] } }, "required": [ "id", "requiresAuthorization", "redirectUrl" ], "patternProperties": { "^(?!(?:id|requiresAuthorization|redirectUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "requiresAuthorization", "redirectUrl" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "name": { "$ref": "#/$defs/ShortText" }, "url": { "$ref": "#/$defs/HttpUrl" }, "composio": { "anyOf": [ { "type": "object", "properties": { "toolkitSlug": { "$ref": "#/$defs/ShortText" }, "custom": { "type": "boolean" }, "noAuth": { "type": "boolean" }, "authorizationPending": { "type": "boolean" } }, "required": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ], "patternProperties": { "^(?!(?:toolkitSlug|custom|noAuth|authorizationPending)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ] } }, { "type": "null" } ] }, "allowedToolNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 40 }, "active": { "type": "boolean" }, "authorizationConfigured": { "type": "boolean" }, "credentialRefId": { "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" } ] }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|composio|allowedToolNames|active|authorizationConfigured|credentialRefId|lastValidatedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ] } }, "maxItems": 200 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "requiresAuthorization": { "type": "boolean" }, "redirectUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] } }, "required": [ "id", "requiresAuthorization", "redirectUrl" ], "patternProperties": { "^(?!(?:id|requiresAuthorization|redirectUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "requiresAuthorization", "redirectUrl" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "name": { "$ref": "#/$defs/ShortText" }, "url": { "$ref": "#/$defs/HttpUrl" }, "composio": { "anyOf": [ { "type": "object", "properties": { "toolkitSlug": { "$ref": "#/$defs/ShortText" }, "custom": { "type": "boolean" }, "noAuth": { "type": "boolean" }, "authorizationPending": { "type": "boolean" } }, "required": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ], "patternProperties": { "^(?!(?:toolkitSlug|custom|noAuth|authorizationPending)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ] } }, { "type": "null" } ] }, "allowedToolNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 40 }, "active": { "type": "boolean" }, "authorizationConfigured": { "type": "boolean" }, "credentialRefId": { "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" } ] }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|composio|allowedToolNames|active|authorizationConfigured|credentialRefId|lastValidatedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ] } }, "maxItems": 200 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `workflowIntegrations.connect`: `POST /v1/workspaces/:workspaceId/workflows/integrations/apps` - `workflowMcpServers.list`: `GET /v1/workspaces/:workspaceId/workflows/mcp-servers` ## create_organization Create a new Organization owned by the caller's person (ADR-075 §5). It starts on the Free plan with no Workspaces; add one with create_workspace. Use when the person asks to set up a separate Organization (for example a new client or brand with its own billing). Creation is rate-limited per person for agents and API keys. Deleting or transferring an Organization stays with the person in the web app. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspace:create Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "name" ] } ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "name" ] } ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isOwner": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] } }, "visibleWorkspaceCount": { "type": "integer" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "slug": { "$ref": "#/$defs/ShortText" }, "owner": { "anyOf": [ { "type": "object", "properties": { "userId": { "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" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, { "type": "null" } ] } }, "required": [ "id", "name", "logo", "isOwner", "permissions", "visibleWorkspaceCount", "createdAt", "slug", "owner" ], "patternProperties": { "^(?!(?:id|name|logo|isOwner|permissions|visibleWorkspaceCount|createdAt|slug|owner)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "logo", "isOwner", "permissions", "visibleWorkspaceCount", "createdAt", "slug", "owner" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "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$" } } } ``` ### Underlying API operations - `organizations.create`: `POST /v1/organizations` ## create_reminder Schedule a reminder on a Unibox thread and durably enqueue its send. Use when a thread needs a future follow-up nudge; the response carries the job run acknowledgement. Creating a reminder replaces any pending one on the same thread; do not stack reminders. Scopes: unibox:reply 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" }, "threadId": { "$ref": "#/$defs/ProviderId" }, "remindAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "workspaceId", "threadId", "remindAt" ], "patternProperties": { "^(?!(?:workspaceId|threadId|remindAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "threadId", "remindAt" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### 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" }, "threadId": { "$ref": "#/$defs/ProviderId" }, "remindAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "workspaceId", "threadId", "remindAt" ], "patternProperties": { "^(?!(?:workspaceId|threadId|remindAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "threadId", "remindAt" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Output schema (structuredContent) ```json { "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" }, "threadId": { "$ref": "#/$defs/ProviderId" }, "remindAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isAutomatic": { "type": "boolean" }, "status": { "type": "string", "enum": [ "pending", "sent", "cancelled" ] }, "sentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "jobRunId": { "anyOf": [ { "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": "string", "pattern": "^run_[a-zA-Z0-9]{1,200}$" } ] }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "threadId", "remindAt", "isAutomatic", "status", "sentAt", "cancelledAt", "jobRunId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|threadId|remindAt|isAutomatic|status|sentAt|cancelledAt|jobRunId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "threadId", "remindAt", "isAutomatic", "status", "sentAt", "cancelledAt", "jobRunId", "createdAt", "updatedAt" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `reminders.create`: `POST /v1/workspaces/:workspaceId/reminders` ## create_support_attachment_upload Issue a signed, expiring upload capability for one support attachment. Use before submit_support_feedback when the report needs a screenshot or log. The upload URL is one-shot and expires quickly; do not reuse or share it. Scopes: support:create 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" }, "fileName": { "type": "string", "minLength": 1, "maxLength": 255 }, "sizeBytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 52428800 } }, "required": [ "workspaceId", "fileName", "sizeBytes" ], "patternProperties": { "^(?!(?:workspaceId|fileName|sizeBytes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "fileName", "sizeBytes" ] } } ``` ### 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" }, "fileName": { "type": "string", "minLength": 1, "maxLength": 255 }, "sizeBytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 52428800 } }, "required": [ "workspaceId", "fileName", "sizeBytes" ], "patternProperties": { "^(?!(?:workspaceId|fileName|sizeBytes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "fileName", "sizeBytes" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "uploadToken": { "$ref": "#/$defs/SupportCapabilityToken" }, "uploadUrl": { "$ref": "#/$defs/HttpUrl" }, "method": { "anyOf": [ { "type": "string", "enum": [ "PUT" ] } ] }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "uploadToken", "uploadUrl", "method", "headers", "expiresAt" ], "patternProperties": { "^(?!(?:uploadToken|uploadUrl|method|headers|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "uploadToken", "uploadUrl", "method", "headers", "expiresAt" ] }, "$defs": { "SupportCapabilityToken": { "type": "string", "minLength": 1, "maxLength": 4096 }, "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$" } } } ``` ### Underlying API operations - `support.createAttachmentUpload`: `POST /v1/workspaces/:workspaceId/support/attachments/uploads` ## create_task Create an ordinary workspace task. Use for ad-hoc work items; workflow requests are created by workflow runs only. Cannot create a human request; those are created by workflow human-input nodes, not a standalone MCP call. Scopes: task:create 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" }, "title": { "type": "string", "minLength": 1, "maxLength": 2000 }, "description": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "leadId": { "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" } ] }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 20 } }, "required": [ "workspaceId", "title" ], "patternProperties": { "^(?!(?:workspaceId|title|description|dueDate|leadId|assigneeUserIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "title", "description", "dueDate", "leadId", "assigneeUserIds" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### 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" }, "title": { "type": "string", "minLength": 1, "maxLength": 2000 }, "description": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "leadId": { "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" } ] }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 20 } }, "required": [ "workspaceId", "title" ], "patternProperties": { "^(?!(?:workspaceId|title|description|dueDate|leadId|assigneeUserIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "title", "description", "dueDate", "leadId", "assigneeUserIds" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Output schema (structuredContent) ```json { "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" }, "title": { "type": "string", "minLength": 1, "maxLength": 2000 }, "description": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedBy": { "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" } ] }, "outcome": { "anyOf": [ { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] }, { "type": "null" } ] }, "leadId": { "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" } ] }, "campaignContactId": { "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" } ] }, "campaignStepId": { "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" } ] }, "workflowRunId": { "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" } ] }, "workflow": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] }, "humanRequest": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "approval", "text" ] }, "question": { "$ref": "#/$defs/Description" } }, "required": [ "type", "question" ], "patternProperties": { "^(?!(?:type|question)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "question" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "choice" ] } ] }, "question": { "$ref": "#/$defs/Description" }, "options": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" }, "maxItems": 20 } }, "required": [ "type", "question", "options" ], "patternProperties": { "^(?!(?:type|question|options)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "question", "options" ] } } ] }, { "type": "null" } ] }, "humanResponse": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "approval" ] } ] }, "approved": { "type": "boolean" }, "comment": { "$ref": "#/$defs/ShortText" } }, "required": [ "type", "approved" ], "patternProperties": { "^(?!(?:type|approved|comment)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "approved", "comment" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] } ] }, "text": { "$ref": "#/$defs/Description" } }, "required": [ "type", "text" ], "patternProperties": { "^(?!(?:type|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "text" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "choice" ] } ] }, "choice": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "type", "choice" ], "patternProperties": { "^(?!(?:type|choice)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "choice" ] } } ] }, { "type": "null" } ] }, "requestState": { "anyOf": [ { "type": "string", "enum": [ "pending", "answered", "expired", "cancelled" ] }, { "type": "null" } ] }, "responseExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "requestedByAgentRegistrationId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "operationId": { "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" } ] }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } } }, "createdBy": { "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" } ] }, "createdByUser": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } }, { "type": "null" } ] }, "completedByUser": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } }, { "type": "null" } ] }, "lead": { "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" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "firstName", "lastName", "companyName", "emailAddress", "phoneNumber" ], "patternProperties": { "^(?!(?:id|firstName|lastName|companyName|emailAddress|phoneNumber)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "firstName", "lastName", "companyName", "emailAddress", "phoneNumber" ] } }, { "type": "null" } ] }, "outcomeDetail": { "anyOf": [ { "type": "object", "properties": { "phoneOutcomes": { "type": "array", "items": { "type": "object", "properties": { "leadPhoneId": { "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" }, "outcome": { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] } }, "required": [ "leadPhoneId", "outcome" ], "patternProperties": { "^(?!(?:leadPhoneId|outcome)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadPhoneId", "outcome" ] } }, "maxItems": 50 } }, "required": [ "phoneOutcomes" ], "patternProperties": { "^(?!(?:phoneOutcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "phoneOutcomes" ] } ] } }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "title", "description", "dueDate", "completedAt", "completedBy", "outcome", "leadId", "campaignContactId", "campaignStepId", "workflowRunId", "workflow", "humanRequest", "humanResponse", "requestState", "responseExpiresAt", "requestedByAgentRegistrationId", "operationId", "assignees", "createdBy", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|title|description|dueDate|completedAt|completedBy|outcome|leadId|campaignContactId|campaignStepId|workflowRunId|workflow|humanRequest|humanResponse|requestState|responseExpiresAt|requestedByAgentRegistrationId|operationId|assignees|createdBy|createdByUser|completedByUser|lead|outcomeDetail|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "title", "description", "dueDate", "completedAt", "completedBy", "outcome", "leadId", "campaignContactId", "campaignStepId", "workflowRunId", "workflow", "humanRequest", "humanResponse", "requestState", "responseExpiresAt", "requestedByAgentRegistrationId", "operationId", "assignees", "createdBy", "createdByUser", "completedByUser", "lead", "outcomeDetail", "createdAt", "updatedAt" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } } } ``` ### Underlying API operations - `tasks.create`: `POST /v1/workspaces/:workspaceId/tasks` ## create_workspace Create a Workspace in a named Organization (ADR-075 §5). The caller's person becomes its Workspace Admin. Use after create_organization, or when the person asks for a new Workspace in an Organization where they hold workspace:create. Available to personal API keys and signed-in people; interactive MCP grants hand the person to Organization settings instead. Deleting or moving a Workspace stays human-only. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspace:create Risk: write; confirmation: explicit; idempotency: required. ### Input schema (personal API key) ```json { "type": "object", "properties": { "organizationId": { "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": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/ShortText" } }, "required": [ "organizationId", "name" ], "patternProperties": { "^(?!(?:organizationId|name|slug)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "name", "slug" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "organizationId": { "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": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/ShortText" } }, "required": [ "organizationId", "name" ], "patternProperties": { "^(?!(?:organizationId|name|slug)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "name", "slug" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "slug", "logo", "createdAt" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "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$" } } } ``` ### Underlying API operations - `organizationWorkspaces.create`: `POST /v1/organizations/:organizationId/workspaces` ## delete_dashboard Delete a saved dashboard or query at its expected revision. Read the latest revision first. Deletion leaves a tombstone; reusing its ID cannot restore it. Repeat the same deletion safely. Requires the Workspace SQL feature and the stated permission. This does not grant access to another Workspace or execute stored SQL automatically. Scopes: sql:manage_dashboards 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" }, "dashboardId": { "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" }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "workspaceId", "dashboardId", "expectedRevision" ], "patternProperties": { "^(?!(?:workspaceId|dashboardId|expectedRevision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "dashboardId", "expectedRevision" ] } } ``` ### 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" }, "dashboardId": { "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" }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "workspaceId", "dashboardId", "expectedRevision" ], "patternProperties": { "^(?!(?:workspaceId|dashboardId|expectedRevision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "dashboardId", "expectedRevision" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ``` ### Underlying API operations - `dashboards.delete`: `DELETE /v1/workspaces/:workspaceId/dashboards/:dashboardId` ## delete_inboxes Disconnects selected inboxes and removes stored credentials while retaining inbox, message, send, warmup and diagnostic history; campaign-attached inboxes are skipped with per-item outcomes. When asked to remove inboxes from the workspace. For moving inboxes — use manage_inbox_settings. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: inbox:delete Risk: destructive; confirmation: explicit; idempotency: required. ### 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" }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "workspaceId", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxIds" ] } } ``` ### 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" }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "workspaceId", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxIds" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "outcomes": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "status": { "type": "string", "enum": [ "updated", "skipped", "failed" ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "inboxId", "status", "reason" ], "patternProperties": { "^(?!(?:inboxId|status|reason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "status", "reason" ] } } } }, "required": [ "outcomes" ], "patternProperties": { "^(?!(?:outcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "outcomes" ] } ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `inboxBulk.remove`: `POST /v1/workspaces/:workspaceId/inboxes/bulk/delete` ## delete_organization_dashboard Delete a saved dashboard or query at its expected revision. Read the latest revision first. Deletion leaves a tombstone; reusing its ID cannot restore it. Repeat the same deletion safely. Requires the stated Organization analytics permission. Reading a document never executes its SQL; saving validates every selected child, and execution always requires live child SQL access and feature eligibility. Scopes: orgAnalytics:manage Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "organizationId": { "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" }, "dashboardId": { "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" }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "organizationId", "dashboardId", "expectedRevision" ], "patternProperties": { "^(?!(?:organizationId|dashboardId|expectedRevision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "dashboardId", "expectedRevision" ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "organizationId": { "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" }, "dashboardId": { "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" }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "organizationId", "dashboardId", "expectedRevision" ], "patternProperties": { "^(?!(?:organizationId|dashboardId|expectedRevision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "dashboardId", "expectedRevision" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ``` ### Underlying API operations - `organizationDashboards.delete`: `DELETE /v1/organizations/:organizationId/dashboards/:dashboardId` ## delete_task Soft-delete an ordinary task. Use to remove ad-hoc tasks; deletion is a retained soft delete. Workflow requests are audit-retained and cannot be deleted; the call fails instead. Scopes: task:delete Risk: write; confirmation: none; idempotency: required. ### 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" }, "taskId": { "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", "taskId" ], "patternProperties": { "^(?!(?:workspaceId|taskId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "taskId" ] } } ``` ### 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" }, "taskId": { "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", "taskId" ], "patternProperties": { "^(?!(?:workspaceId|taskId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "taskId" ] } } ``` ### Output schema (structuredContent) ```json { "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" } }, "required": [ "id" ], "patternProperties": { "^(?!(?:id)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "id" ] } ] } } ``` ### Underlying API operations - `tasks.delete`: `DELETE /v1/workspaces/:workspaceId/tasks/:taskId` ## delete_unibox_threads Move one conversation, a batch of conversations, or one message to the trash, where retention eventually removes it for good. Select thread, threads, or message explicitly. Use only when the customer has asked for mail to be removed from the product's view. Prefer archiving: it hides a conversation without starting a purge clock. Deletion here does not delete the copy in the mailbox provider, so it is not a way to honour an erasure request on its own. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: unibox:archive Risk: destructive; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "thread" ] } ] }, "threadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 1 } }, "required": [ "workspaceId", "action", "threadIds" ], "patternProperties": { "^(?!(?:workspaceId|action|threadIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "threads" ] } ] }, "threadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 } }, "required": [ "workspaceId", "action", "threadIds" ], "patternProperties": { "^(?!(?:workspaceId|action|threadIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "message" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId" ] } } ] } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "thread" ] } ] }, "threadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 1 } }, "required": [ "workspaceId", "action", "threadIds" ], "patternProperties": { "^(?!(?:workspaceId|action|threadIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "threads" ] } ] }, "threadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 } }, "required": [ "workspaceId", "action", "threadIds" ], "patternProperties": { "^(?!(?:workspaceId|action|threadIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "message" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId" ] } } ] } ``` ### Output schema (structuredContent) ```json { "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ThreadLabelId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "AttachmentId": { "type": "string", "minLength": 1, "maxLength": 512 } }, "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" }, "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" } ] }, "organizationId": { "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" }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "contact": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "leadId": { "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" } ] } }, "required": [ "emailAddress", "name", "leadId" ], "patternProperties": { "^(?!(?:emailAddress|name|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "name", "leadId" ] } }, "providerThreadId": { "$ref": "#/$defs/OpaqueId" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "lastMessageAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "messageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ThreadLabelId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isFormerMember": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isFormerMember" ], "patternProperties": { "^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isFormerMember" ] } } }, "campaignId": { "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" } ] }, "campaignContactId": { "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" } ] }, "isRead": { "type": "boolean" }, "starredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "folders": { "type": "array", "items": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] } }, "recentMessages": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isRead": { "type": "boolean" }, "isFromInboxSender": { "type": "boolean" } }, "required": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ], "patternProperties": { "^(?!(?:id|providerInternalMessageId|from|to|cc|subject|snippet|receivedAt|isRead|isFromInboxSender)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ] } }, "maxItems": 20 } }, "required": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders" ], "patternProperties": { "^(?!(?:id|inboxId|organizationId|subject|snippet|contact|providerThreadId|provider|lastMessageAt|messageCount|labels|assignees|campaignId|campaignContactId|isRead|starredAt|archivedAt|deletedAt|folders|recentMessages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders", "recentMessages" ] } }, { "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" }, "threadId": { "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" }, "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" } ] }, "organizationId": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "rfc2822MessageId": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "isFromInboxSender": { "type": "boolean" }, "sentFromUnibox": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttachmentId" }, "filename": { "$ref": "#/$defs/ShortText" }, "contentType": { "$ref": "#/$defs/ShortText" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inline": { "type": "boolean" } }, "required": [ "id", "filename", "contentType", "size", "inline" ], "patternProperties": { "^(?!(?:id|filename|contentType|size|inline)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "filename", "contentType", "size", "inline" ] } } }, "bodyState": { "type": "string", "enum": [ "available", "pending" ] }, "isRead": { "type": "boolean" }, "flaggedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "headers": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 16384 } }, "authoredByWorkflowRunId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt" ], "patternProperties": { "^(?!(?:id|threadId|inboxId|organizationId|providerInternalMessageId|rfc2822MessageId|provider|from|to|cc|bcc|subject|snippet|receivedAt|direction|isFromInboxSender|sentFromUnibox|attachments|bodyState|isRead|flaggedAt|deletedAt|headers|authoredByWorkflowRunId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt", "headers", "authoredByWorkflowRunId" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "threadId": { "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" }, "ok": { "type": "boolean" }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "threadId", "ok", "error" ], "patternProperties": { "^(?!(?:threadId|ok|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "ok", "error" ] } }, "maxItems": 100 }, "succeeded": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "succeeded", "failed" ], "patternProperties": { "^(?!(?:items|succeeded|failed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "succeeded", "failed" ] } } ] }, { "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" }, "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" } ] }, "organizationId": { "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" }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "contact": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "leadId": { "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" } ] } }, "required": [ "emailAddress", "name", "leadId" ], "patternProperties": { "^(?!(?:emailAddress|name|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "name", "leadId" ] } }, "providerThreadId": { "$ref": "#/$defs/OpaqueId" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "lastMessageAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "messageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ThreadLabelId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isFormerMember": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isFormerMember" ], "patternProperties": { "^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isFormerMember" ] } } }, "campaignId": { "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" } ] }, "campaignContactId": { "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" } ] }, "isRead": { "type": "boolean" }, "starredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "folders": { "type": "array", "items": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] } }, "recentMessages": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isRead": { "type": "boolean" }, "isFromInboxSender": { "type": "boolean" } }, "required": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ], "patternProperties": { "^(?!(?:id|providerInternalMessageId|from|to|cc|subject|snippet|receivedAt|isRead|isFromInboxSender)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ] } }, "maxItems": 20 } }, "required": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders" ], "patternProperties": { "^(?!(?:id|inboxId|organizationId|subject|snippet|contact|providerThreadId|provider|lastMessageAt|messageCount|labels|assignees|campaignId|campaignContactId|isRead|starredAt|archivedAt|deletedAt|folders|recentMessages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders", "recentMessages" ] } }, { "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" }, "threadId": { "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" }, "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" } ] }, "organizationId": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "rfc2822MessageId": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "isFromInboxSender": { "type": "boolean" }, "sentFromUnibox": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttachmentId" }, "filename": { "$ref": "#/$defs/ShortText" }, "contentType": { "$ref": "#/$defs/ShortText" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inline": { "type": "boolean" } }, "required": [ "id", "filename", "contentType", "size", "inline" ], "patternProperties": { "^(?!(?:id|filename|contentType|size|inline)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "filename", "contentType", "size", "inline" ] } } }, "bodyState": { "type": "string", "enum": [ "available", "pending" ] }, "isRead": { "type": "boolean" }, "flaggedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "headers": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 16384 } }, "authoredByWorkflowRunId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt" ], "patternProperties": { "^(?!(?:id|threadId|inboxId|organizationId|providerInternalMessageId|rfc2822MessageId|provider|from|to|cc|bcc|subject|snippet|receivedAt|direction|isFromInboxSender|sentFromUnibox|attachments|bodyState|isRead|flaggedAt|deletedAt|headers|authoredByWorkflowRunId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt", "headers", "authoredByWorkflowRunId" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "threadId": { "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" }, "ok": { "type": "boolean" }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "threadId", "ok", "error" ], "patternProperties": { "^(?!(?:threadId|ok|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "ok", "error" ] } }, "maxItems": 100 }, "succeeded": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "succeeded", "failed" ], "patternProperties": { "^(?!(?:items|succeeded|failed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "succeeded", "failed" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `uniboxThreads.delete`: `DELETE /v1/workspaces/:workspaceId/unibox/threads/:threadId` - `uniboxThreads.batchDelete`: `POST /v1/workspaces/:workspaceId/unibox/threads/batch/delete` - `uniboxMessages.delete`: `DELETE /v1/workspaces/:workspaceId/unibox/messages/:messageId` ## delete_webhook Delete an outbound webhook subscription: preview binds the target and issues a confirmation token, commit removes the subscription and tombstones its secret. Use only when the subscription should be permanently removed; commit requires the preview token. Never commit without a fresh preview token, and never reuse a token after the webhook changed. Use the native preview first and pass its confirmation token unchanged to commit. A token does not bypass current permissions or Workspace checks. Scopes: webhook:delete Risk: destructive; confirmation: preview_token; idempotency: required. ### 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" }, "webhookId": { "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" }, "confirmationToken": { "type": "string" } }, "required": [ "workspaceId", "webhookId" ], "patternProperties": { "^(?!(?:workspaceId|webhookId|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "webhookId", "confirmationToken" ] } } ``` ### 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" }, "webhookId": { "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" }, "confirmationToken": { "type": "string" } }, "required": [ "workspaceId", "webhookId" ], "patternProperties": { "^(?!(?:workspaceId|webhookId|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "webhookId", "confirmationToken" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Money": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XCG", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWG" ] } }, "required": [ "amountMinor", "currency" ], "patternProperties": { "^(?!(?:amountMinor|currency)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "amountMinor", "currency" ] } }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } }, { "type": "object", "properties": { "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "preview", "confirmationToken" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } }, { "type": "object", "properties": { "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "preview", "confirmationToken" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `webhooks.previewDelete`: `POST /v1/workspaces/:workspaceId/webhooks/:webhookId/deletion-preview` - `webhooks.delete`: `DELETE /v1/workspaces/:workspaceId/webhooks/:webhookId` ## deny_permission_request Deny a pending permission request with an optional note to the requester. Use when the reviewer decided not to grant the request. The requester is notified. It does not remove permissions the person already holds; use manage_organization_members. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspaceMember:update Risk: write; confirmation: explicit; 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" }, "requestId": { "$ref": "#/$defs/PermissionRequestId" }, "note": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "workspaceId", "requestId" ], "patternProperties": { "^(?!(?:workspaceId|requestId|note)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "requestId", "note" ] }, "$defs": { "PermissionRequestId": { "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" } } } ``` ### 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" }, "requestId": { "$ref": "#/$defs/PermissionRequestId" }, "note": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "workspaceId", "requestId" ], "patternProperties": { "^(?!(?:workspaceId|requestId|note)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "requestId", "note" ] }, "$defs": { "PermissionRequestId": { "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" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "PermissionRequestId": { "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" }, "PermissionRequestStatus": { "type": "string", "enum": [ "pending", "approved", "denied", "canceled", "expired" ] }, "PermissionRequestPerson": { "type": "object", "properties": { "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, "PermissionRequestContext": { "type": "object", "properties": { "attemptedOperation": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "attemptedTool": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "explanation": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:attemptedOperation|attemptedTool|explanation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attemptedOperation", "attemptedTool", "explanation" ] } }, "PermissionRequestSource": { "type": "string", "enum": [ "web", "api", "agent" ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "PermissionRequest": { "type": "object", "properties": { "id": { "$ref": "#/$defs/PermissionRequestId" }, "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" }, "status": { "$ref": "#/$defs/PermissionRequestStatus" }, "requester": { "$ref": "#/$defs/PermissionRequestPerson" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "grantedPermissions": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "context": { "$ref": "#/$defs/PermissionRequestContext" }, "source": { "$ref": "#/$defs/PermissionRequestSource" }, "agentName": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "decidedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "decidedBy": { "anyOf": [ { "$ref": "#/$defs/PermissionRequestPerson" }, { "type": "null" } ] }, "decisionNote": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "reviewable": { "type": "boolean" } }, "required": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ], "patternProperties": { "^(?!(?:id|workspaceId|status|requester|permissions|grantedPermissions|reason|context|source|agentName|createdAt|expiresAt|decidedAt|decidedBy|decisionNote|reviewable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ] } }, "PermissionRequestDecisionResult": { "type": "object", "properties": { "request": { "$ref": "#/$defs/PermissionRequest" }, "changed": { "type": "boolean" } }, "required": [ "request", "changed" ], "patternProperties": { "^(?!(?:request|changed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "request", "changed" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/PermissionRequestDecisionResult" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/PermissionRequestDecisionResult" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `permissionRequests.deny`: `POST /v1/workspaces/:workspaceId/permission-requests/:requestId/deny` ## detach_integration_share Detach a connection shared into this workspace; the source workspace and other targets keep working. Use when this workspace should stop using a connection another workspace shared with it. Dependent workflows pause. Do not use on the source workspace — use revoke_integration_share there. A detached workspace is never re-added automatically. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:delete Risk: destructive; confirmation: explicit; 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" }, "shareId": { "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", "shareId" ], "patternProperties": { "^(?!(?:workspaceId|shareId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "shareId" ] } } ``` ### 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" }, "shareId": { "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", "shareId" ], "patternProperties": { "^(?!(?:workspaceId|shareId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "shareId" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "adapter": { "$ref": "#/$defs/IntegrationShareAdapter" }, "provider": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,63}$" }, "displayName": { "$ref": "#/$defs/ShortText" }, "role": { "type": "string", "enum": [ "source", "target" ] }, "sourceWorkspaceId": { "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" }, "sourceWorkspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "sourceConnectionId": { "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" }, "sourceConnected": { "type": "boolean" }, "includeFutureWorkspaces": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "attaching", "attached", "detached", "failed" ] }, "connectionId": { "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" } ] }, "failureReason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "attachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "detachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|state|connectionId|failureReason|attachedAt|detachedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ] } }, "maxItems": 500 } }, "required": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ], "patternProperties": { "^(?!(?:id|adapter|provider|displayName|role|sourceWorkspaceId|sourceWorkspaceName|sourceConnectionId|sourceConnected|includeFutureWorkspaces|createdAt|revokedAt|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ] }, "$defs": { "IntegrationShareAdapter": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer", "heyreach", "getleads", "plusvibe", "calendly", "cal_com", "attio", "email_verifier", "phone_verifier", "warmup_provider", "mcp_server", "app_connection" ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `integrationShares.detach`: `POST /v1/workspaces/:workspaceId/integration-shares/:shareId/detach` ## disconnect_attio Disconnect the workspace's Attio connection. Use to detach Attio; idempotent — the result reports disconnected either way. Disconnecting does not unseal or delete retained credential envelopes. Scopes: integration:delete Risk: write; confirmation: none; idempotency: required. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "attio", "heyreach", "plusvibe", "getleads" ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "disconnected" ] } ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "provider", "status", "disconnectedAt" ], "patternProperties": { "^(?!(?:provider|status|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "status", "disconnectedAt" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `attio.disconnect`: `POST /v1/workspaces/:workspaceId/integrations/attio/disconnect` ## disconnect_booking_connection Disconnect a booking provider: preview binds the target and issues a confirmation token, commit retires the connection. Use only when the workspace should stop using that calendar; commit requires a fresh preview token. Never commit without a preview token, and never reuse a token after the connection changed. Use the native preview first and pass its confirmation token unchanged to commit. A token does not bypass current permissions or Workspace checks. Scopes: integration:delete Risk: security_admin; confirmation: preview_token; idempotency: required. ### 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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "action": { "type": "string", "enum": [ "preview" ] } }, "required": [ "workspaceId", "provider", "action" ], "patternProperties": { "^(?!(?:workspaceId|provider|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider", "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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "action": { "type": "string", "enum": [ "commit" ] }, "confirmationToken": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "workspaceId", "provider", "action", "confirmationToken" ], "patternProperties": { "^(?!(?:workspaceId|provider|action|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider", "action", "confirmationToken" ] } } ], "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### 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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "action": { "type": "string", "enum": [ "preview" ] } }, "required": [ "workspaceId", "provider", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|provider|action)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "provider", "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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "action": { "type": "string", "enum": [ "commit" ] }, "confirmationToken": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "workspaceId", "provider", "action", "confirmationToken" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|provider|action|confirmationToken)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "provider", "action", "confirmationToken" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Money": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XCG", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWG" ] } }, "required": [ "amountMinor", "currency" ], "patternProperties": { "^(?!(?:amountMinor|currency)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "amountMinor", "currency" ] } }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "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" }, "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "provider", "connectionId", "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:provider|connectionId|preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connectionId", "preview", "confirmationToken" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "disconnected" ] } ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "provider", "status", "disconnectedAt" ], "patternProperties": { "^(?!(?:provider|status|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "status", "disconnectedAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "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" }, "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "provider", "connectionId", "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:provider|connectionId|preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connectionId", "preview", "confirmationToken" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "disconnected" ] } ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "provider", "status", "disconnectedAt" ], "patternProperties": { "^(?!(?:provider|status|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "status", "disconnectedAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `booking.calendly.previewDisconnect`: `POST /v1/workspaces/:workspaceId/booking/calendly/disconnect/preview` - `booking.calendly.disconnect`: `POST /v1/workspaces/:workspaceId/booking/calendly/disconnect` - `booking.calCom.previewDisconnect`: `POST /v1/workspaces/:workspaceId/booking/cal-com/disconnect/preview` - `booking.calCom.disconnect`: `POST /v1/workspaces/:workspaceId/booking/cal-com/disconnect` ## disconnect_getleads Disconnect GetLeads: disarm the webhook, deactivate the key, and tombstone its sealed envelope. Use when the workspace should stop spending or receiving through GetLeads. Safe to repeat. Workflows with GetLeads blocks stop working until a human reconnects a key. Scopes: integration:delete Risk: destructive; confirmation: none; idempotency: required. ### 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" }, "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" } }, "required": [ "workspaceId", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId" ] } } ``` ### 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" }, "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" } }, "required": [ "workspaceId", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "getleads" ] }, "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" }, "status": { "type": "string", "enum": [ "disconnected" ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "provider", "connectionId", "status", "disconnectedAt" ], "patternProperties": { "^(?!(?:provider|connectionId|status|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connectionId", "status", "disconnectedAt" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `getleads.disconnect`: `DELETE /v1/workspaces/:workspaceId/integrations/getleads/:connectionId` ## disconnect_inbox Disconnects an inbox, tombstones its credential ref, and reports provider cleanup honestly. When asked to disconnect or unlink an inbox. For deleting inbox history — disconnect keeps the row. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: inbox:delete Risk: destructive; confirmation: explicit; idempotency: required. ### 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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxId" ] } } ``` ### 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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "status": { "type": "string", "enum": [ "disconnected", "ambiguous" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "providerCleanup": { "type": "string", "enum": [ "verified", "failed", "skipped", "not_applicable" ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "status", "inboxId", "providerCleanup", "disconnectedAt" ], "patternProperties": { "^(?!(?:status|inboxId|providerCleanup|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "inboxId", "providerCleanup", "disconnectedAt" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `inboxConnections.disconnect`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/disconnect` ## disconnect_mailbox_provider Disconnect a saved mailbox vendor: preview binds the connection and issues a confirmation token, commit deletes the stored copy of the API key, removes the local connection, and cancels active imports. The vendor-issued key is not invalidated. When asked to remove a saved mailbox vendor connection. Commit requires the token from a fresh preview. Do not commit without a preview token, and do not reuse a token. A repeated token is rejected; it is not a cached success. The token is consumed before the connection delete. If that delete fails or the response is lost, list connections: a remaining row means the delete did not commit, and a missing row means it did. Mint a fresh preview to finish a delete that did not commit. This deletes the stored copy and the local connection. It does not invalidate the vendor-issued key, and it does not delete inboxes already imported. Use the native preview first and pass its confirmation token unchanged to commit. A token does not bypass current permissions or Workspace checks. Scopes: integration:delete Risk: destructive; confirmation: preview_token; idempotency: none. ### 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" }, "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" }, "action": { "type": "string", "enum": [ "preview" ] } }, "required": [ "workspaceId", "connectionId", "action" ], "patternProperties": { "^(?!(?:workspaceId|connectionId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId", "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" }, "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" }, "action": { "type": "string", "enum": [ "commit" ] }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "workspaceId", "connectionId", "action", "confirmationToken" ], "patternProperties": { "^(?!(?:workspaceId|connectionId|action|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId", "action", "confirmationToken" ] } } ], "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### 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" }, "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" }, "action": { "type": "string", "enum": [ "preview" ] } }, "required": [ "workspaceId", "connectionId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|connectionId|action)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "connectionId", "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" }, "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" }, "action": { "type": "string", "enum": [ "commit" ] }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "workspaceId", "connectionId", "action", "confirmationToken" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|connectionId|action|confirmationToken)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "connectionId", "action", "confirmationToken" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Money": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XCG", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWG" ] } }, "required": [ "amountMinor", "currency" ], "patternProperties": { "^(?!(?:amountMinor|currency)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "amountMinor", "currency" ] } }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "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" }, "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "connectionId", "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:connectionId|preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connectionId", "preview", "confirmationToken" ] } }, { "type": "object", "properties": { "disconnected": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "disconnected" ], "patternProperties": { "^(?!(?:disconnected)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "disconnected" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "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" }, "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "connectionId", "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:connectionId|preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connectionId", "preview", "confirmationToken" ] } }, { "type": "object", "properties": { "disconnected": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "disconnected" ], "patternProperties": { "^(?!(?:disconnected)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "disconnected" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `inboxProviderImports.previewDisconnect`: `POST /v1/workspaces/:workspaceId/inbox-providers/connections/:connectionId/disconnect/preview` - `inboxProviderImports.disconnect`: `POST /v1/workspaces/:workspaceId/inbox-providers/connections/:connectionId/disconnect` ## disconnect_plusvibe Disconnect PlusVibe: stop webhook intake, remove the remote hooks, and tombstone the sealed key. Use when the workspace should stop receiving PlusVibe events and stop using the key. Safe to repeat. Workflows with PlusVibe blocks stop working until a human reconnects a key. Scopes: integration:delete Risk: destructive; confirmation: none; idempotency: required. ### 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" }, "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" } }, "required": [ "workspaceId", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId" ] } } ``` ### 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" }, "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" } }, "required": [ "workspaceId", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "plusvibe" ] }, "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" }, "status": { "type": "string", "enum": [ "disconnected" ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "pendingRemoteCleanup": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 } }, "required": [ "provider", "connectionId", "status", "disconnectedAt", "pendingRemoteCleanup" ], "patternProperties": { "^(?!(?:provider|connectionId|status|disconnectedAt|pendingRemoteCleanup)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connectionId", "status", "disconnectedAt", "pendingRemoteCleanup" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `plusvibe.disconnect`: `POST /v1/workspaces/:workspaceId/integrations/plusvibe/:connectionId/disconnect` ## download_unibox_attachment Mint a short-lived download URL for one attachment on one message. Use when the attachment's contents are needed. Fetch it immediately: the URL expires, and it is deliberately not stored anywhere. Do not pass the URL on or persist it — it is a bearer credential for customer mail with no further check behind it. Scopes: unibox:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "attachmentId": { "$ref": "#/$defs/AttachmentId" } }, "required": [ "workspaceId", "messageId", "attachmentId" ], "patternProperties": { "^(?!(?:workspaceId|messageId|attachmentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "messageId", "attachmentId" ] }, "$defs": { "AttachmentId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### 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" }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "attachmentId": { "$ref": "#/$defs/AttachmentId" } }, "required": [ "workspaceId", "messageId", "attachmentId" ], "patternProperties": { "^(?!(?:workspaceId|messageId|attachmentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "messageId", "attachmentId" ] }, "$defs": { "AttachmentId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "attachmentId": { "$ref": "#/$defs/AttachmentId" }, "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "filename": { "$ref": "#/$defs/ShortText" }, "contentType": { "$ref": "#/$defs/ShortText" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "attachmentId", "url", "expiresAt", "filename", "contentType", "size" ], "patternProperties": { "^(?!(?:attachmentId|url|expiresAt|filename|contentType|size)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attachmentId", "url", "expiresAt", "filename", "contentType", "size" ] }, "$defs": { "AttachmentId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `uniboxMessages.createAttachmentDownload`: `POST /v1/workspaces/:workspaceId/unibox/messages/:messageId/attachments/:attachmentId/download` ## edit_campaign_sequence Edit a campaign's sequence in either shape — the grouped steps save or the ADR-067 builder (steps, variants, positions, content, run policy, entry delay) — and manage reusable sequences and subsequence trigger sets. Use to author or revise what a campaign sends. Every mutation answers the full updated sequence document with its new revision; pass expectedRevision / expectedSequenceRevision when the client has a snapshot. Positions are server-owned and deletions tombstone retained execution identities — do not try to renumber steps or rewrite send history. A step's last variant is deleted by deleting the step, and edits are refused while a contact is task-pending on the affected variant. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: campaign:create, campaign:update, sequence:create, sequence:update, sequence:delete Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "save" ] }, "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" }, "campaignId": { "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": { "expectedSequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] }, "steps": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email_content" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "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" } ] }, "variantOrder": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "subject": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] } }, "required": [ "variantOrder" ], "patternProperties": { "^(?!(?:id|variantOrder|enabled|subject|body|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "variantOrder", "enabled", "subject", "body", "status" ] } }, "maxItems": 26 } }, "required": [ "type", "delayMinutes", "variants" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|bodyFormat|previousThreadSelection|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "bodyFormat", "previousThreadSelection", "variants" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "manual_review" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "notificationMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "connectionNote": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|connectionNote)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "connectionNote" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phone_call" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "script": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "script" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text_message" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "message": { "anyOf": [ { "type": "string", "maxLength": 1600 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http_post_request" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaignId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "attio_task" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } } ] }, "maxItems": 100 } }, "required": [ "steps" ], "patternProperties": { "^(?!(?:expectedSequenceRevision|initialDelayMinutes|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedSequenceRevision", "initialDelayMinutes", "steps" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "update_step" ] }, "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" }, "campaignId": { "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" }, "stepId": { "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": { "stepOrder": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "variantOrder": { "type": "integer", "minimum": 1 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "notificationMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "manualStepType": { "type": "string", "enum": [ "notify_and_continue", "notify_and_wait" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:stepOrder|variantOrder|delayMinutes|subject|body|notificationMessage|manualStepType|runMode|rearmAfterDays)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "stepOrder", "variantOrder", "delayMinutes", "subject", "body", "notificationMessage", "manualStepType", "runMode", "rearmAfterDays" ] } } }, "required": [ "action", "workspaceId", "campaignId", "stepId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|stepId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "toggle_enabled" ] }, "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" }, "campaignId": { "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" }, "stepId": { "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", "workspaceId", "campaignId", "stepId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|stepId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "delete_step" ] }, "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" }, "campaignId": { "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" }, "stepId": { "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", "workspaceId", "campaignId", "stepId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|stepId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "delete_all" ] }, "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" }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create_step" ] }, "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" }, "campaignId": { "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": { "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" }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "afterStepId": { "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" } ] }, "waitFor": { "type": "integer", "minimum": 0 }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "variants": { "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" }, "content": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email_content" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "manual_review" ] }, "stepType": { "type": "string", "enum": [ "notify_and_continue", "notify_and_wait" ] }, "notificationMessage": { "type": "string", "maxLength": 10000 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepType|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepType", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "message": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phone_call" ] }, "script": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "script" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text_message" ] }, "message": { "anyOf": [ { "type": "string", "maxLength": 1600 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http_post_request" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "url" ], "patternProperties": { "^(?!(?:type|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "attio_task" ] }, "content": { "type": "string", "maxLength": 10000 }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "connectionId": { "type": "string" }, "campaignId": { "type": "integer", "minimum": 1 }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "campaignId" ], "patternProperties": { "^(?!(?:type|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } } ] }, "enabled": { "type": "boolean" } }, "patternProperties": { "^(?!(?:id|content|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "content", "enabled" ] } }, "maxItems": 26 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:id|type|afterStepId|waitFor|runMode|rearmAfterDays|bodyFormat|previousThreadSelection|enabled|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "afterStepId", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "variants" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "update_sequence_step" ] }, "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" }, "campaignId": { "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" }, "stepId": { "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": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "waitFor": { "type": "integer", "minimum": 0 }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "enabled": { "type": "boolean" } }, "patternProperties": { "^(?!(?:expectedRevision|waitFor|runMode|rearmAfterDays|bodyFormat|previousThreadSelection|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled" ] } } }, "required": [ "action", "workspaceId", "campaignId", "stepId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|stepId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "move_sequence_step" ] }, "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" }, "campaignId": { "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" }, "stepId": { "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": { "afterStepId": { "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" } ] } }, "required": [ "afterStepId" ], "patternProperties": { "^(?!(?:afterStepId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "afterStepId" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "stepId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|stepId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "delete_sequence_step" ] }, "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" }, "campaignId": { "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" }, "stepId": { "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", "workspaceId", "campaignId", "stepId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|stepId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create_variant" ] }, "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" }, "campaignId": { "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" }, "stepId": { "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": { "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" }, "content": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email_content" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "manual_review" ] }, "stepType": { "type": "string", "enum": [ "notify_and_continue", "notify_and_wait" ] }, "notificationMessage": { "type": "string", "maxLength": 10000 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepType|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepType", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "message": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phone_call" ] }, "script": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "script" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text_message" ] }, "message": { "anyOf": [ { "type": "string", "maxLength": 1600 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http_post_request" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "url" ], "patternProperties": { "^(?!(?:type|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "attio_task" ] }, "content": { "type": "string", "maxLength": 10000 }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "connectionId": { "type": "string" }, "campaignId": { "type": "integer", "minimum": 1 }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "campaignId" ], "patternProperties": { "^(?!(?:type|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } } ] }, "copyFromVariantId": { "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" } ] }, "enabled": { "type": "boolean" } }, "patternProperties": { "^(?!(?:id|content|copyFromVariantId|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "content", "copyFromVariantId", "enabled" ] } } }, "required": [ "action", "workspaceId", "campaignId", "stepId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|stepId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "update_variant" ] }, "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" }, "campaignId": { "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" }, "variantId": { "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": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "content": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email_content" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "manual_review" ] }, "stepType": { "type": "string", "enum": [ "notify_and_continue", "notify_and_wait" ] }, "notificationMessage": { "type": "string", "maxLength": 10000 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepType|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepType", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "message": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phone_call" ] }, "script": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "script" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text_message" ] }, "message": { "anyOf": [ { "type": "string", "maxLength": 1600 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http_post_request" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "url" ], "patternProperties": { "^(?!(?:type|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "attio_task" ] }, "content": { "type": "string", "maxLength": 10000 }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "connectionId": { "type": "string" }, "campaignId": { "type": "integer", "minimum": 1 }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "campaignId" ], "patternProperties": { "^(?!(?:type|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } } ] }, "enabled": { "type": "boolean" } }, "patternProperties": { "^(?!(?:expectedRevision|content|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "content", "enabled" ] } } }, "required": [ "action", "workspaceId", "campaignId", "variantId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|variantId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "variantId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "delete_variant" ] }, "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" }, "campaignId": { "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" }, "variantId": { "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", "workspaceId", "campaignId", "variantId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|variantId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "variantId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "replace_sequence" ] }, "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" }, "campaignId": { "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": { "expectedSequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] }, "steps": { "type": "array", "items": { "type": "object", "properties": { "stepId": { "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" } ] }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "waitFor": { "type": "integer", "minimum": 0 }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "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" } ] }, "content": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email_content" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "manual_review" ] }, "stepType": { "type": "string", "enum": [ "notify_and_continue", "notify_and_wait" ] }, "notificationMessage": { "type": "string", "maxLength": 10000 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepType|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepType", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "message": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phone_call" ] }, "script": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "script" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text_message" ] }, "message": { "anyOf": [ { "type": "string", "maxLength": 1600 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http_post_request" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "url" ], "patternProperties": { "^(?!(?:type|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "attio_task" ] }, "content": { "type": "string", "maxLength": 10000 }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "connectionId": { "type": "string" }, "campaignId": { "type": "integer", "minimum": 1 }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "campaignId" ], "patternProperties": { "^(?!(?:type|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } } ] }, "enabled": { "type": "boolean" } }, "patternProperties": { "^(?!(?:id|content|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "content", "enabled" ] } }, "maxItems": 26 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:stepId|type|waitFor|runMode|rearmAfterDays|bodyFormat|previousThreadSelection|enabled|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "stepId", "type", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "variants" ] } }, "maxItems": 100 } }, "required": [ "steps" ], "patternProperties": { "^(?!(?:expectedSequenceRevision|initialDelayMinutes|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedSequenceRevision", "initialDelayMinutes", "steps" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "update_sequence" ] }, "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" }, "campaignId": { "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": { "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] } }, "required": [ "initialDelayMinutes" ], "patternProperties": { "^(?!(?:initialDelayMinutes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "initialDelayMinutes" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create_sequence" ] }, "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" }, "payload": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, "initialDelayMinutes": { "type": "integer", "minimum": 0, "maximum": 525600 }, "stopOtherCampaigns": { "type": "boolean" } }, "required": [ "name", "inboxIds" ], "patternProperties": { "^(?!(?:name|inboxIds|initialDelayMinutes|stopOtherCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "inboxIds", "initialDelayMinutes", "stopOtherCampaigns" ] } } }, "required": [ "action", "workspaceId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "set_sequence_status" ] }, "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" }, "sequenceId": { "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": { "status": { "type": "string", "enum": [ "active", "paused" ] } }, "required": [ "status" ], "patternProperties": { "^(?!(?:status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "status" ] } ] } } }, "required": [ "action", "workspaceId", "sequenceId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|sequenceId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "sequenceId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create_subsequence" ] }, "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" }, "campaignId": { "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": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "trigger": { "type": "object", "properties": { "conditionType": { "type": "string", "enum": [ "reply_any", "reply_genuine", "reply_label", "reply_text" ] }, "replyLabelIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "textContains": { "$ref": "#/$defs/NonEmptyString" }, "textNotContains": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "conditionType" ], "patternProperties": { "^(?!(?:conditionType|replyLabelIds|textContains|textNotContains)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "conditionType", "replyLabelIds", "textContains", "textNotContains" ] } } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|trigger)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "trigger" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "save_subsequence_triggers" ] }, "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" }, "subsequenceCampaignId": { "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": { "triggers": { "type": "array", "items": { "type": "object", "properties": { "conditionType": { "type": "string", "enum": [ "reply_any", "reply_genuine", "reply_label", "reply_text" ] }, "replyLabelIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "textContains": { "$ref": "#/$defs/NonEmptyString" }, "textNotContains": { "$ref": "#/$defs/NonEmptyString" }, "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" }, "enabled": { "type": "boolean" } }, "required": [ "conditionType" ], "patternProperties": { "^(?!(?:conditionType|replyLabelIds|textContains|textNotContains|id|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "conditionType", "replyLabelIds", "textContains", "textNotContains", "id", "enabled" ] } } } }, "required": [ "triggers" ], "patternProperties": { "^(?!(?:triggers)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "triggers" ] } ] } } }, "required": [ "action", "workspaceId", "subsequenceCampaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|subsequenceCampaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "subsequenceCampaignId", "payload" ] } } ], "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### 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": [ "save" ] }, "campaignId": { "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": { "expectedSequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] }, "steps": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email_content" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "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" } ] }, "variantOrder": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "subject": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] } }, "required": [ "variantOrder" ], "patternProperties": { "^(?!(?:id|variantOrder|enabled|subject|body|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "variantOrder", "enabled", "subject", "body", "status" ] } }, "maxItems": 26 } }, "required": [ "type", "delayMinutes", "variants" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|bodyFormat|previousThreadSelection|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "bodyFormat", "previousThreadSelection", "variants" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "manual_review" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "notificationMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "connectionNote": { "anyOf": [ { "type": "string", "maxLength": 300 }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|connectionNote)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "connectionNote" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phone_call" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "script": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "script" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text_message" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "message": { "anyOf": [ { "type": "string", "maxLength": 1600 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http_post_request" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaignId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "attio_task" ] }, "stepId": { "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" } ] }, "dbId": { "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" } ] }, "status": { "type": "string", "enum": [ "draft", "saved" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepId|dbId|status|runMode|rearmAfterDays|delayMinutes|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepId", "dbId", "status", "runMode", "rearmAfterDays", "delayMinutes", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } } ] }, "maxItems": 100 } }, "required": [ "steps" ], "patternProperties": { "^(?!(?:expectedSequenceRevision|initialDelayMinutes|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedSequenceRevision", "initialDelayMinutes", "steps" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "update_step" ] }, "campaignId": { "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" }, "stepId": { "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": { "stepOrder": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "variantOrder": { "type": "integer", "minimum": 1 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "notificationMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "manualStepType": { "type": "string", "enum": [ "notify_and_continue", "notify_and_wait" ] }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:stepOrder|variantOrder|delayMinutes|subject|body|notificationMessage|manualStepType|runMode|rearmAfterDays)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "stepOrder", "variantOrder", "delayMinutes", "subject", "body", "notificationMessage", "manualStepType", "runMode", "rearmAfterDays" ] } } }, "required": [ "action", "workspaceId", "campaignId", "stepId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|stepId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId", "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": [ "toggle_enabled" ] }, "campaignId": { "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" }, "stepId": { "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", "workspaceId", "campaignId", "stepId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|stepId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId" ] }, { "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": [ "delete_step" ] }, "campaignId": { "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" }, "stepId": { "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", "workspaceId", "campaignId", "stepId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|stepId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId" ] }, { "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": [ "delete_all" ] }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] }, { "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": [ "create_step" ] }, "campaignId": { "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": { "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" }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "afterStepId": { "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" } ] }, "waitFor": { "type": "integer", "minimum": 0 }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "variants": { "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" }, "content": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email_content" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "manual_review" ] }, "stepType": { "type": "string", "enum": [ "notify_and_continue", "notify_and_wait" ] }, "notificationMessage": { "type": "string", "maxLength": 10000 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepType|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepType", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "message": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phone_call" ] }, "script": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "script" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text_message" ] }, "message": { "anyOf": [ { "type": "string", "maxLength": 1600 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http_post_request" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "url" ], "patternProperties": { "^(?!(?:type|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "attio_task" ] }, "content": { "type": "string", "maxLength": 10000 }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "connectionId": { "type": "string" }, "campaignId": { "type": "integer", "minimum": 1 }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "campaignId" ], "patternProperties": { "^(?!(?:type|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } } ] }, "enabled": { "type": "boolean" } }, "patternProperties": { "^(?!(?:id|content|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "content", "enabled" ] } }, "maxItems": 26 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:id|type|afterStepId|waitFor|runMode|rearmAfterDays|bodyFormat|previousThreadSelection|enabled|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "afterStepId", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "variants" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "update_sequence_step" ] }, "campaignId": { "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" }, "stepId": { "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": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "waitFor": { "type": "integer", "minimum": 0 }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "enabled": { "type": "boolean" } }, "patternProperties": { "^(?!(?:expectedRevision|waitFor|runMode|rearmAfterDays|bodyFormat|previousThreadSelection|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled" ] } } }, "required": [ "action", "workspaceId", "campaignId", "stepId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|stepId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId", "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": [ "move_sequence_step" ] }, "campaignId": { "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" }, "stepId": { "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": { "afterStepId": { "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" } ] } }, "required": [ "afterStepId" ], "patternProperties": { "^(?!(?:afterStepId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "afterStepId" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "stepId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|stepId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId", "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": [ "delete_sequence_step" ] }, "campaignId": { "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" }, "stepId": { "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", "workspaceId", "campaignId", "stepId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|stepId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId" ] }, { "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": [ "create_variant" ] }, "campaignId": { "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" }, "stepId": { "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": { "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" }, "content": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email_content" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "manual_review" ] }, "stepType": { "type": "string", "enum": [ "notify_and_continue", "notify_and_wait" ] }, "notificationMessage": { "type": "string", "maxLength": 10000 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepType|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepType", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "message": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phone_call" ] }, "script": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "script" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text_message" ] }, "message": { "anyOf": [ { "type": "string", "maxLength": 1600 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http_post_request" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "url" ], "patternProperties": { "^(?!(?:type|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "attio_task" ] }, "content": { "type": "string", "maxLength": 10000 }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "connectionId": { "type": "string" }, "campaignId": { "type": "integer", "minimum": 1 }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "campaignId" ], "patternProperties": { "^(?!(?:type|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } } ] }, "copyFromVariantId": { "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" } ] }, "enabled": { "type": "boolean" } }, "patternProperties": { "^(?!(?:id|content|copyFromVariantId|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "content", "copyFromVariantId", "enabled" ] } } }, "required": [ "action", "workspaceId", "campaignId", "stepId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|stepId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "stepId", "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": [ "update_variant" ] }, "campaignId": { "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" }, "variantId": { "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": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "content": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email_content" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "manual_review" ] }, "stepType": { "type": "string", "enum": [ "notify_and_continue", "notify_and_wait" ] }, "notificationMessage": { "type": "string", "maxLength": 10000 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepType|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepType", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "message": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phone_call" ] }, "script": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "script" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text_message" ] }, "message": { "anyOf": [ { "type": "string", "maxLength": 1600 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http_post_request" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "url" ], "patternProperties": { "^(?!(?:type|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "attio_task" ] }, "content": { "type": "string", "maxLength": 10000 }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "connectionId": { "type": "string" }, "campaignId": { "type": "integer", "minimum": 1 }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "campaignId" ], "patternProperties": { "^(?!(?:type|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } } ] }, "enabled": { "type": "boolean" } }, "patternProperties": { "^(?!(?:expectedRevision|content|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "content", "enabled" ] } } }, "required": [ "action", "workspaceId", "campaignId", "variantId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|variantId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "variantId", "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": [ "delete_variant" ] }, "campaignId": { "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" }, "variantId": { "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", "workspaceId", "campaignId", "variantId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|variantId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "variantId" ] }, { "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": [ "replace_sequence" ] }, "campaignId": { "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": { "expectedSequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] }, "steps": { "type": "array", "items": { "type": "object", "properties": { "stepId": { "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" } ] }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "waitFor": { "type": "integer", "minimum": 0 }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 365 }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "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" } ] }, "content": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email_content" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "manual_review" ] }, "stepType": { "type": "string", "enum": [ "notify_and_continue", "notify_and_wait" ] }, "notificationMessage": { "type": "string", "maxLength": 10000 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|stepType|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "stepType", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "message": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "subject": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] }, "body": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phone_call" ] }, "script": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "format": { "type": "string", "enum": [ "lexical" ] }, "state": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "format", "state" ], "patternProperties": { "^(?!(?:format|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "state" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "html" ] }, "html": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "html" ], "patternProperties": { "^(?!(?:format|html)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "html" ] } }, { "type": "object", "properties": { "format": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string", "maxLength": 256000 } }, "required": [ "format", "text" ], "patternProperties": { "^(?!(?:format|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "format", "text" ] } } ] }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "script" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text_message" ] }, "message": { "anyOf": [ { "type": "string", "maxLength": 1600 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "http_post_request" ] }, "url": { "type": "string" }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "type", "url" ], "patternProperties": { "^(?!(?:type|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "attio_task" ] }, "content": { "type": "string", "maxLength": 10000 }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "connectionId": { "type": "string" }, "campaignId": { "type": "integer", "minimum": 1 }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "campaignId" ], "patternProperties": { "^(?!(?:type|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } } ] }, "enabled": { "type": "boolean" } }, "patternProperties": { "^(?!(?:id|content|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "content", "enabled" ] } }, "maxItems": 26 } }, "required": [ "type" ], "patternProperties": { "^(?!(?:stepId|type|waitFor|runMode|rearmAfterDays|bodyFormat|previousThreadSelection|enabled|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "stepId", "type", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "variants" ] } }, "maxItems": 100 } }, "required": [ "steps" ], "patternProperties": { "^(?!(?:expectedSequenceRevision|initialDelayMinutes|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedSequenceRevision", "initialDelayMinutes", "steps" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "update_sequence" ] }, "campaignId": { "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": { "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] } }, "required": [ "initialDelayMinutes" ], "patternProperties": { "^(?!(?:initialDelayMinutes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "initialDelayMinutes" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "create_sequence" ] }, "payload": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, "initialDelayMinutes": { "type": "integer", "minimum": 0, "maximum": 525600 }, "stopOtherCampaigns": { "type": "boolean" } }, "required": [ "name", "inboxIds" ], "patternProperties": { "^(?!(?:name|inboxIds|initialDelayMinutes|stopOtherCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "inboxIds", "initialDelayMinutes", "stopOtherCampaigns" ] } } }, "required": [ "action", "workspaceId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "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": [ "set_sequence_status" ] }, "sequenceId": { "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": { "status": { "type": "string", "enum": [ "active", "paused" ] } }, "required": [ "status" ], "patternProperties": { "^(?!(?:status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "status" ] } ] } } }, "required": [ "action", "workspaceId", "sequenceId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|sequenceId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "sequenceId", "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": [ "create_subsequence" ] }, "campaignId": { "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": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "trigger": { "type": "object", "properties": { "conditionType": { "type": "string", "enum": [ "reply_any", "reply_genuine", "reply_label", "reply_text" ] }, "replyLabelIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "textContains": { "$ref": "#/$defs/NonEmptyString" }, "textNotContains": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "conditionType" ], "patternProperties": { "^(?!(?:conditionType|replyLabelIds|textContains|textNotContains)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "conditionType", "replyLabelIds", "textContains", "textNotContains" ] } } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|trigger)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "trigger" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "save_subsequence_triggers" ] }, "subsequenceCampaignId": { "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": { "triggers": { "type": "array", "items": { "type": "object", "properties": { "conditionType": { "type": "string", "enum": [ "reply_any", "reply_genuine", "reply_label", "reply_text" ] }, "replyLabelIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "textContains": { "$ref": "#/$defs/NonEmptyString" }, "textNotContains": { "$ref": "#/$defs/NonEmptyString" }, "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" }, "enabled": { "type": "boolean" } }, "required": [ "conditionType" ], "patternProperties": { "^(?!(?:conditionType|replyLabelIds|textContains|textNotContains|id|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "conditionType", "replyLabelIds", "textContains", "textNotContains", "id", "enabled" ] } } } }, "required": [ "triggers" ], "patternProperties": { "^(?!(?:triggers)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "triggers" ] } ] } } }, "required": [ "action", "workspaceId", "subsequenceCampaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|subsequenceCampaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "subsequenceCampaignId", "payload" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### 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$" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "savedSteps": { "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" }, "stepOrder": { "type": "integer", "minimum": 1 }, "variantOrder": { "type": "integer", "minimum": 1 }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "stepId": { "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", "stepOrder", "variantOrder", "type", "stepId" ], "patternProperties": { "^(?!(?:id|stepOrder|variantOrder|type|stepId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepOrder", "variantOrder", "type", "stepId" ] } } }, "txid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "savedSteps", "txid", "sequenceRevision" ], "patternProperties": { "^(?!(?:success|savedSteps|txid|sequenceRevision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "savedSteps", "txid", "sequenceRevision" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "enabled": { "type": "boolean" } }, "required": [ "success", "enabled" ], "patternProperties": { "^(?!(?:success|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "enabled" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } }, { "type": "object", "properties": { "txid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sequence": { "type": "object", "properties": { "campaignId": { "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" }, "sequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "steps": { "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" }, "position": { "type": "integer", "minimum": 1 }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "waitFor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "variants": { "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" }, "variantOrder": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "content": { "$ref": "#/$defs/Union_" }, "plainText": { "type": "object", "properties": { "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body" ] } }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "variantOrder", "enabled", "revision", "content", "plainText", "updatedAt" ], "patternProperties": { "^(?!(?:id|variantOrder|enabled|revision|content|plainText|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "variantOrder", "enabled", "revision", "content", "plainText", "updatedAt" ] } } } }, "required": [ "id", "position", "type", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "revision", "updatedAt", "variants" ], "patternProperties": { "^(?!(?:id|position|type|waitFor|runMode|rearmAfterDays|bodyFormat|previousThreadSelection|enabled|revision|updatedAt|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "position", "type", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "revision", "updatedAt", "variants" ] } } } }, "required": [ "campaignId", "sequenceRevision", "initialDelayMinutes", "steps" ], "patternProperties": { "^(?!(?:campaignId|sequenceRevision|initialDelayMinutes|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "sequenceRevision", "initialDelayMinutes", "steps" ] } } }, "required": [ "txid", "sequenceRevision", "sequence" ], "patternProperties": { "^(?!(?:txid|sequenceRevision|sequence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "txid", "sequenceRevision", "sequence" ] } }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "sequence" ] }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stopOtherCampaignsOnEnroll": { "type": "boolean" }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "status", "kind", "initialDelayMinutes", "stopOtherCampaignsOnEnroll", "inboxIds", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|status|pauseContext|kind|initialDelayMinutes|stopOtherCampaignsOnEnroll|inboxIds|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "pauseContext", "kind", "initialDelayMinutes", "stopOtherCampaignsOnEnroll", "inboxIds", "createdAt", "updatedAt" ] } }, { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } }, { "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" } }, "required": [ "id" ], "patternProperties": { "^(?!(?:id)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "id" ] } ] } } ] } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "savedSteps": { "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" }, "stepOrder": { "type": "integer", "minimum": 1 }, "variantOrder": { "type": "integer", "minimum": 1 }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "stepId": { "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", "stepOrder", "variantOrder", "type", "stepId" ], "patternProperties": { "^(?!(?:id|stepOrder|variantOrder|type|stepId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepOrder", "variantOrder", "type", "stepId" ] } } }, "txid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "savedSteps", "txid", "sequenceRevision" ], "patternProperties": { "^(?!(?:success|savedSteps|txid|sequenceRevision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "savedSteps", "txid", "sequenceRevision" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "enabled": { "type": "boolean" } }, "required": [ "success", "enabled" ], "patternProperties": { "^(?!(?:success|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "enabled" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } }, { "type": "object", "properties": { "txid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sequence": { "type": "object", "properties": { "campaignId": { "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" }, "sequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "steps": { "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" }, "position": { "type": "integer", "minimum": 1 }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "waitFor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "variants": { "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" }, "variantOrder": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "content": { "$ref": "#/$defs/Union_" }, "plainText": { "type": "object", "properties": { "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body" ] } }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "variantOrder", "enabled", "revision", "content", "plainText", "updatedAt" ], "patternProperties": { "^(?!(?:id|variantOrder|enabled|revision|content|plainText|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "variantOrder", "enabled", "revision", "content", "plainText", "updatedAt" ] } } } }, "required": [ "id", "position", "type", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "revision", "updatedAt", "variants" ], "patternProperties": { "^(?!(?:id|position|type|waitFor|runMode|rearmAfterDays|bodyFormat|previousThreadSelection|enabled|revision|updatedAt|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "position", "type", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "revision", "updatedAt", "variants" ] } } } }, "required": [ "campaignId", "sequenceRevision", "initialDelayMinutes", "steps" ], "patternProperties": { "^(?!(?:campaignId|sequenceRevision|initialDelayMinutes|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "sequenceRevision", "initialDelayMinutes", "steps" ] } } }, "required": [ "txid", "sequenceRevision", "sequence" ], "patternProperties": { "^(?!(?:txid|sequenceRevision|sequence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "txid", "sequenceRevision", "sequence" ] } }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "sequence" ] }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stopOtherCampaignsOnEnroll": { "type": "boolean" }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "status", "kind", "initialDelayMinutes", "stopOtherCampaignsOnEnroll", "inboxIds", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|status|pauseContext|kind|initialDelayMinutes|stopOtherCampaignsOnEnroll|inboxIds|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "pauseContext", "kind", "initialDelayMinutes", "stopOtherCampaignsOnEnroll", "inboxIds", "createdAt", "updatedAt" ] } }, { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } }, { "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" } }, "required": [ "id" ], "patternProperties": { "^(?!(?:id)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "id" ] } ] } } ] } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaignSteps.save`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/steps/save` - `campaignSteps.update`: `PATCH /v1/workspaces/:workspaceId/campaigns/:campaignId/steps/:stepId` - `campaignSteps.toggleEnabled`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/steps/:stepId/toggle-enabled` - `campaignSteps.delete`: `DELETE /v1/workspaces/:workspaceId/campaigns/:campaignId/steps/:stepId` - `campaignSteps.deleteAll`: `DELETE /v1/workspaces/:workspaceId/campaigns/:campaignId/steps` - `campaignSteps.createStep`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/sequence/steps` - `campaignSteps.updateSequenceStep`: `PATCH /v1/workspaces/:workspaceId/campaigns/:campaignId/sequence/steps/:stepId` - `campaignSteps.moveSequenceStep`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/sequence/steps/:stepId/move` - `campaignSteps.deleteSequenceStep`: `DELETE /v1/workspaces/:workspaceId/campaigns/:campaignId/sequence/steps/:stepId` - `campaignSteps.createVariant`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/sequence/steps/:stepId/variants` - `campaignSteps.updateVariant`: `PATCH /v1/workspaces/:workspaceId/campaigns/:campaignId/sequence/variants/:variantId` - `campaignSteps.deleteVariant`: `DELETE /v1/workspaces/:workspaceId/campaigns/:campaignId/sequence/variants/:variantId` - `campaignSteps.replaceSequence`: `PUT /v1/workspaces/:workspaceId/campaigns/:campaignId/sequence` - `campaignSteps.updateSequence`: `PATCH /v1/workspaces/:workspaceId/campaigns/:campaignId/sequence` - `campaignSequences.create`: `POST /v1/workspaces/:workspaceId/campaigns/sequences` - `campaignSequences.setStatus`: `PATCH /v1/workspaces/:workspaceId/campaigns/sequences/:sequenceId/status` - `campaignSubsequences.create`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/subsequences` - `campaignSubsequences.saveTriggers`: `POST /v1/workspaces/:workspaceId/campaigns/subsequences/:subsequenceCampaignId/triggers` ## enrich_heyreach_email Find a LinkedIn profile's email address with HeyReach's paid enrichment: start a lookup, then poll its job until it completes. Use when a lead has a LinkedIn profile but no email and the person wants one found. Start once, then poll the returned job id. Each lookup spends the customer's HeyReach enrichment credit and is refused on a frozen subscription. The server deduplicates retries of the same lookup. `EMAIL_NOT_FOUND` is a finished answer, not a failure to retry. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:update, integration:read Risk: costly; confirmation: explicit; 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": [ "start" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "action", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId|action|profileUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "profileUrl" ] } }, { "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": [ "status" ] }, "jobId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "jobId" ], "patternProperties": { "^(?!(?:workspaceId|action|jobId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "jobId" ] } } ], "$defs": { "LinkedInProfileUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } } } ``` ### 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": [ "start" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "action", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|profileUrl)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "profileUrl" ] }, { "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": [ "status" ] }, "jobId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "jobId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|jobId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "jobId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "LinkedInProfileUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachEnrichmentStarted": { "type": "object", "properties": { "jobId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "jobId" ], "patternProperties": { "^(?!(?:jobId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "jobId" ] } ] } }, "HeyReachText": { "type": "string", "minLength": 0, "maxLength": 10000 }, "HeyReachEnrichmentJob": { "type": "object", "properties": { "jobId": { "$ref": "#/$defs/HeyReachId" }, "status": { "type": "string", "enum": [ "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED" ] }, "data": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ENRICHED", "EMAIL_NOT_FOUND", "CANCELLED", "FAILED" ] }, "message": { "$ref": "#/$defs/HeyReachText" }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "memberId": { "$ref": "#/$defs/HeyReachText" }, "profileUrl": { "$ref": "#/$defs/HeyReachText" } }, "required": [ "status", "message", "emailAddress", "memberId", "profileUrl" ], "patternProperties": { "^(?!(?:status|message|emailAddress|memberId|profileUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "message", "emailAddress", "memberId", "profileUrl" ] } }, { "type": "null" } ] } }, "required": [ "jobId", "status", "data" ], "patternProperties": { "^(?!(?:jobId|status|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "jobId", "status", "data" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/HeyReachEnrichmentStarted" }, { "$ref": "#/$defs/HeyReachEnrichmentJob" } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/HeyReachEnrichmentStarted" }, { "$ref": "#/$defs/HeyReachEnrichmentJob" } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `heyreachInsights.enrichEmail`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/enrichment/email` - `heyreachInsights.enrichStatus`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/enrichment/:jobId` ## enroll_campaign_audience Enroll and curate a campaign's audience: add contacts, run CSV / existing-lead imports with dedupe options, remove or resume contacts, apply validated timezones, move contacts into a subsequence, and enroll or unenroll unibox threads in reusable sequences. Use to change who a campaign or sequence will send to. Imports dedupe across campaigns per the caller's chosen mode and never overwrite a lead's identity. Enrollment paths are paid actions — they start real sends and respect the subscription gate. Do not use this to bypass the gate, and report per-contact skip reasons rather than retrying them away. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: campaign:update, lead:create, lead:read, lead:update, lead:delete, lead:import, leadList:read, sequence:update, unibox:reply Risk: costly; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "add" ] }, "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" }, "campaignId": { "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": { "contacts": { "type": "array", "items": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "emails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 100 }, "phones": { "type": "array", "items": { "type": "string" }, "maxItems": 100 }, "ladder": { "type": "string" }, "rank": { "type": "integer" } }, "required": [ "emailAddress" ], "patternProperties": { "^(?!(?:emailAddress|emails|phones|ladder|rank)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "emails", "phones", "ladder", "rank" ] } }, "maxItems": 10000 } }, "required": [ "contacts" ], "patternProperties": { "^(?!(?:contacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "contacts" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "import_csv" ] }, "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" }, "campaignId": { "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": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "acquisitionSource": { "type": "string", "maxLength": 256 }, "email": { "$ref": "#/$defs/EmailAddress" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "companyName": { "type": "string" }, "jobTitle": { "type": "string" }, "companyWebsiteUrl": { "type": "string" }, "personalLinkedInUrl": { "type": "string" }, "companyLinkedInUrl": { "type": "string" }, "timezone": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "email", "firstName", "lastName", "customFields" ], "patternProperties": { "^(?!(?:acquisitionSource|email|firstName|lastName|city|state|country|companyName|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|timezone|customFields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "acquisitionSource", "email", "firstName", "lastName", "city", "state", "country", "companyName", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "timezone", "customFields" ] } }, "maxItems": 10000 }, { "type": "object", "properties": { "contacts": { "type": "array", "items": { "type": "object", "properties": { "acquisitionSource": { "type": "string", "maxLength": 256 }, "email": { "$ref": "#/$defs/EmailAddress" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "companyName": { "type": "string" }, "jobTitle": { "type": "string" }, "companyWebsiteUrl": { "type": "string" }, "personalLinkedInUrl": { "type": "string" }, "companyLinkedInUrl": { "type": "string" }, "timezone": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "email", "firstName", "lastName", "customFields" ], "patternProperties": { "^(?!(?:acquisitionSource|email|firstName|lastName|city|state|country|companyName|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|timezone|customFields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "acquisitionSource", "email", "firstName", "lastName", "city", "state", "country", "companyName", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "timezone", "customFields" ] } }, "maxItems": 10000 }, "options": { "type": "object", "properties": { "skipOtherCampaigns": { "type": "string", "enum": [ "none", "all", "active_paused", "active" ] }, "updateExistingContacts": { "type": "boolean" } }, "patternProperties": { "^(?!(?:skipOtherCampaigns|updateExistingContacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "skipOtherCampaigns", "updateExistingContacts" ] } } }, "required": [ "contacts" ], "patternProperties": { "^(?!(?:contacts|options)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contacts", "options" ] } } ] } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "import_leads" ] }, "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" }, "campaignId": { "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": { "leadListIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "leadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 1000 }, "options": { "type": "object", "properties": { "skipOtherCampaigns": { "type": "string", "enum": [ "none", "all", "active_paused", "active" ] }, "updateExistingContacts": { "type": "boolean" } }, "patternProperties": { "^(?!(?:skipOtherCampaigns|updateExistingContacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "skipOtherCampaigns", "updateExistingContacts" ] } } }, "patternProperties": { "^(?!(?:leadListIds|leadIds|options)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadListIds", "leadIds", "options" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "remove" ] }, "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" }, "campaignId": { "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": { "contactIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 5000 }, "all": { "type": "boolean" }, "search": { "type": "string" } }, "patternProperties": { "^(?!(?:contactIds|all|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactIds", "all", "search" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "resume" ] }, "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" }, "campaignId": { "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": { "contactIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 5000 } }, "required": [ "contactIds" ], "patternProperties": { "^(?!(?:contactIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "contactIds" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "apply_timezones" ] }, "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" }, "campaignId": { "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": { "updates": { "type": "array", "items": { "type": "object", "properties": { "contactId": { "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" }, "timezone": { "type": "string" } }, "required": [ "contactId", "timezone" ], "patternProperties": { "^(?!(?:contactId|timezone)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "timezone" ] } }, "maxItems": 5000 } }, "required": [ "updates" ], "patternProperties": { "^(?!(?:updates)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "updates" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "move_to_subsequence" ] }, "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" }, "campaignId": { "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": { "subsequenceCampaignId": { "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" }, "contactIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 1000 }, "sourceThreadId": { "type": "string" } }, "required": [ "subsequenceCampaignId", "contactIds" ], "patternProperties": { "^(?!(?:subsequenceCampaignId|contactIds|sourceThreadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subsequenceCampaignId", "contactIds", "sourceThreadId" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "enroll_thread" ] }, "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" }, "sequenceId": { "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": { "threadId": { "$ref": "#/$defs/NonEmptyString" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "stopOtherCampaigns": { "type": "boolean" } }, "required": [ "threadId" ], "patternProperties": { "^(?!(?:threadId|inboxId|stopOtherCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "inboxId", "stopOtherCampaigns" ] } } }, "required": [ "action", "workspaceId", "sequenceId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|sequenceId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "sequenceId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "unenroll" ] }, "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" }, "sequenceId": { "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": { "enrollmentId": { "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": [ "enrollmentId" ], "patternProperties": { "^(?!(?:enrollmentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "enrollmentId" ] } ] } } }, "required": [ "action", "workspaceId", "sequenceId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|sequenceId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "sequenceId", "payload" ] } } ], "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### 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": [ "add" ] }, "campaignId": { "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": { "contacts": { "type": "array", "items": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "emails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 100 }, "phones": { "type": "array", "items": { "type": "string" }, "maxItems": 100 }, "ladder": { "type": "string" }, "rank": { "type": "integer" } }, "required": [ "emailAddress" ], "patternProperties": { "^(?!(?:emailAddress|emails|phones|ladder|rank)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "emails", "phones", "ladder", "rank" ] } }, "maxItems": 10000 } }, "required": [ "contacts" ], "patternProperties": { "^(?!(?:contacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "contacts" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "import_csv" ] }, "campaignId": { "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": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "acquisitionSource": { "type": "string", "maxLength": 256 }, "email": { "$ref": "#/$defs/EmailAddress" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "companyName": { "type": "string" }, "jobTitle": { "type": "string" }, "companyWebsiteUrl": { "type": "string" }, "personalLinkedInUrl": { "type": "string" }, "companyLinkedInUrl": { "type": "string" }, "timezone": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "email", "firstName", "lastName", "customFields" ], "patternProperties": { "^(?!(?:acquisitionSource|email|firstName|lastName|city|state|country|companyName|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|timezone|customFields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "acquisitionSource", "email", "firstName", "lastName", "city", "state", "country", "companyName", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "timezone", "customFields" ] } }, "maxItems": 10000 }, { "type": "object", "properties": { "contacts": { "type": "array", "items": { "type": "object", "properties": { "acquisitionSource": { "type": "string", "maxLength": 256 }, "email": { "$ref": "#/$defs/EmailAddress" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "companyName": { "type": "string" }, "jobTitle": { "type": "string" }, "companyWebsiteUrl": { "type": "string" }, "personalLinkedInUrl": { "type": "string" }, "companyLinkedInUrl": { "type": "string" }, "timezone": { "type": "string" }, "customFields": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "email", "firstName", "lastName", "customFields" ], "patternProperties": { "^(?!(?:acquisitionSource|email|firstName|lastName|city|state|country|companyName|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|timezone|customFields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "acquisitionSource", "email", "firstName", "lastName", "city", "state", "country", "companyName", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "timezone", "customFields" ] } }, "maxItems": 10000 }, "options": { "type": "object", "properties": { "skipOtherCampaigns": { "type": "string", "enum": [ "none", "all", "active_paused", "active" ] }, "updateExistingContacts": { "type": "boolean" } }, "patternProperties": { "^(?!(?:skipOtherCampaigns|updateExistingContacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "skipOtherCampaigns", "updateExistingContacts" ] } } }, "required": [ "contacts" ], "patternProperties": { "^(?!(?:contacts|options)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contacts", "options" ] } } ] } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "import_leads" ] }, "campaignId": { "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": { "leadListIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "leadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 1000 }, "options": { "type": "object", "properties": { "skipOtherCampaigns": { "type": "string", "enum": [ "none", "all", "active_paused", "active" ] }, "updateExistingContacts": { "type": "boolean" } }, "patternProperties": { "^(?!(?:skipOtherCampaigns|updateExistingContacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "skipOtherCampaigns", "updateExistingContacts" ] } } }, "patternProperties": { "^(?!(?:leadListIds|leadIds|options)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadListIds", "leadIds", "options" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "remove" ] }, "campaignId": { "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": { "contactIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 5000 }, "all": { "type": "boolean" }, "search": { "type": "string" } }, "patternProperties": { "^(?!(?:contactIds|all|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactIds", "all", "search" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "resume" ] }, "campaignId": { "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": { "contactIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 5000 } }, "required": [ "contactIds" ], "patternProperties": { "^(?!(?:contactIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "contactIds" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "apply_timezones" ] }, "campaignId": { "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": { "updates": { "type": "array", "items": { "type": "object", "properties": { "contactId": { "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" }, "timezone": { "type": "string" } }, "required": [ "contactId", "timezone" ], "patternProperties": { "^(?!(?:contactId|timezone)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "timezone" ] } }, "maxItems": 5000 } }, "required": [ "updates" ], "patternProperties": { "^(?!(?:updates)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "updates" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "move_to_subsequence" ] }, "campaignId": { "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": { "subsequenceCampaignId": { "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" }, "contactIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 1000 }, "sourceThreadId": { "type": "string" } }, "required": [ "subsequenceCampaignId", "contactIds" ], "patternProperties": { "^(?!(?:subsequenceCampaignId|contactIds|sourceThreadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subsequenceCampaignId", "contactIds", "sourceThreadId" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "enroll_thread" ] }, "sequenceId": { "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": { "threadId": { "$ref": "#/$defs/NonEmptyString" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "stopOtherCampaigns": { "type": "boolean" } }, "required": [ "threadId" ], "patternProperties": { "^(?!(?:threadId|inboxId|stopOtherCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "inboxId", "stopOtherCampaigns" ] } } }, "required": [ "action", "workspaceId", "sequenceId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|sequenceId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "sequenceId", "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": [ "unenroll" ] }, "sequenceId": { "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": { "enrollmentId": { "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": [ "enrollmentId" ], "patternProperties": { "^(?!(?:enrollmentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "enrollmentId" ] } ] } } }, "required": [ "action", "workspaceId", "sequenceId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|sequenceId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "sequenceId", "payload" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### 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$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "imported", "skipped" ], "patternProperties": { "^(?!(?:success|imported|skipped)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "imported", "skipped" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updated": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "duplicates": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "imported", "updated", "skipped", "duplicates" ], "patternProperties": { "^(?!(?:success|imported|updated|skipped|duplicates)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "imported", "updated", "skipped", "duplicates" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updated": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "imported", "updated", "skipped" ], "patternProperties": { "^(?!(?:success|imported|updated|skipped)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "imported", "updated", "skipped" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "removed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "removed" ], "patternProperties": { "^(?!(?:success|removed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "removed" ] } }, { "type": "object", "properties": { "resumed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "resumed" ], "patternProperties": { "^(?!(?:resumed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "resumed" ] } ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "updated": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "updated", "skipped" ], "patternProperties": { "^(?!(?:success|updated|skipped)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "updated", "skipped" ] } }, { "type": "object", "properties": { "moved": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "array", "items": { "type": "object", "properties": { "contactId": { "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" }, "reason": { "type": "string", "enum": [ "not_movable", "already_enrolled", "email_in_subsequence" ] } }, "required": [ "contactId", "reason" ], "patternProperties": { "^(?!(?:contactId|reason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "reason" ] } } } }, "required": [ "moved", "skipped" ], "patternProperties": { "^(?!(?:moved|skipped)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "moved", "skipped" ] } }, { "type": "object", "properties": { "enrolled": { "type": "boolean", "enum": [ true ] }, "childContactId": { "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" }, "enrollmentId": { "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" }, "holdUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "pausedContactIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "enrolled", "childContactId", "enrollmentId", "holdUntil", "pausedContactIds" ], "patternProperties": { "^(?!(?:enrolled|childContactId|enrollmentId|holdUntil|pausedContactIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enrolled", "childContactId", "enrollmentId", "holdUntil", "pausedContactIds" ] } }, { "type": "object", "properties": { "unenrolled": { "type": "boolean" } }, "required": [ "unenrolled" ], "patternProperties": { "^(?!(?:unenrolled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "unenrolled" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "imported", "skipped" ], "patternProperties": { "^(?!(?:success|imported|skipped)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "imported", "skipped" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updated": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "duplicates": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "imported", "updated", "skipped", "duplicates" ], "patternProperties": { "^(?!(?:success|imported|updated|skipped|duplicates)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "imported", "updated", "skipped", "duplicates" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updated": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "imported", "updated", "skipped" ], "patternProperties": { "^(?!(?:success|imported|updated|skipped)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "imported", "updated", "skipped" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "removed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "removed" ], "patternProperties": { "^(?!(?:success|removed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "removed" ] } }, { "type": "object", "properties": { "resumed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "resumed" ], "patternProperties": { "^(?!(?:resumed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "resumed" ] } ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "updated": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "success", "updated", "skipped" ], "patternProperties": { "^(?!(?:success|updated|skipped)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "updated", "skipped" ] } }, { "type": "object", "properties": { "moved": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "array", "items": { "type": "object", "properties": { "contactId": { "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" }, "reason": { "type": "string", "enum": [ "not_movable", "already_enrolled", "email_in_subsequence" ] } }, "required": [ "contactId", "reason" ], "patternProperties": { "^(?!(?:contactId|reason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "reason" ] } } } }, "required": [ "moved", "skipped" ], "patternProperties": { "^(?!(?:moved|skipped)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "moved", "skipped" ] } }, { "type": "object", "properties": { "enrolled": { "type": "boolean", "enum": [ true ] }, "childContactId": { "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" }, "enrollmentId": { "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" }, "holdUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "pausedContactIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "enrolled", "childContactId", "enrollmentId", "holdUntil", "pausedContactIds" ], "patternProperties": { "^(?!(?:enrolled|childContactId|enrollmentId|holdUntil|pausedContactIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enrolled", "childContactId", "enrollmentId", "holdUntil", "pausedContactIds" ] } }, { "type": "object", "properties": { "unenrolled": { "type": "boolean" } }, "required": [ "unenrolled" ], "patternProperties": { "^(?!(?:unenrolled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "unenrolled" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaignContacts.add`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/contacts` - `campaignContacts.importCsv`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/contacts/import` - `campaignContacts.importLeads`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/contacts/import-from-list` - `campaignContacts.remove`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/contacts/remove` - `campaignContacts.resume`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/contacts/resume` - `campaignContacts.applyTimezones`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/contacts/apply-timezones` - `campaignContacts.moveToSubsequence`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/contacts/move-to-subsequence` - `campaignSequences.enrollThread`: `POST /v1/workspaces/:workspaceId/campaigns/sequences/:sequenceId/enroll-thread` - `campaignSequences.unenroll`: `POST /v1/workspaces/:workspaceId/campaigns/sequences/:sequenceId/unenroll` ## enroll_leads_in_workflow Start a published Lead-enrolled workflow for up to 100 existing leads. Use to put specific leads through an automation built on the Lead enrolled trigger. The server derives the enrollment identity from the request so retries do not enroll a lead twice. Only an active, published workflow with a Lead enrolled trigger accepts leads; the caller must also hold every permission the workflow's blocks use. Scopes: workflow:publish, lead:read, dialer:read Risk: costly; confirmation: none; idempotency: required. ### 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" }, "workflowId": { "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" }, "leadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 } }, "required": [ "workspaceId", "workflowId", "leadIds" ], "patternProperties": { "^(?!(?:workspaceId|workflowId|leadIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workflowId", "leadIds" ] } } ``` ### 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" }, "workflowId": { "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" }, "leadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 } }, "required": [ "workspaceId", "workflowId", "leadIds" ], "patternProperties": { "^(?!(?:workspaceId|workflowId|leadIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workflowId", "leadIds" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "workflowId": { "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" }, "enrolled": { "type": "integer", "minimum": 1 }, "operation": { "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" ] } } }, "required": [ "workflowId", "enrolled", "operation" ], "patternProperties": { "^(?!(?:workflowId|enrolled|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workflowId", "enrolled", "operation" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Underlying API operations - `workflows.enrollLeads`: `POST /v1/workspaces/:workspaceId/workflows/:workflowId/enrollments` ## export_campaign_delivery Export filtered monitored-send outcomes with immutable recipient attribution to CSV. Use when a workspace member needs a portable diagnostic report. Do not use this for real-time status checks; inspect_campaign_delivery provides paged current results. Scopes: analytics:export Risk: read; confirmation: none; idempotency: none. ### 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" }, "campaignId": { "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" }, "outcome": { "type": "string", "enum": [ "pending", "delivered", "failed", "unconfirmed" ] }, "cause": { "type": "string", "enum": [ "sender", "recipient", "unclassified" ] }, "failureCharacter": { "type": "string", "enum": [ "temporary", "permanent", "unknown" ] }, "sequenceDisposition": { "type": "string", "enum": [ "held", "continued", "resumed", "stopped" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|outcome|cause|failureCharacter|sequenceDisposition|offset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "outcome", "cause", "failureCharacter", "sequenceDisposition", "offset" ] } } ``` ### 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" }, "campaignId": { "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" }, "outcome": { "type": "string", "enum": [ "pending", "delivered", "failed", "unconfirmed" ] }, "cause": { "type": "string", "enum": [ "sender", "recipient", "unclassified" ] }, "failureCharacter": { "type": "string", "enum": [ "temporary", "permanent", "unknown" ] }, "sequenceDisposition": { "type": "string", "enum": [ "held", "continued", "resumed", "stopped" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|outcome|cause|failureCharacter|sequenceDisposition|offset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "outcome", "cause", "failureCharacter", "sequenceDisposition", "offset" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "fileName": { "type": "string" }, "contentType": { "type": "string", "enum": [ "text/csv" ] }, "content": { "type": "string" }, "recordCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextOffset": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "fileName", "contentType", "content", "recordCount", "truncated", "offset", "nextOffset" ], "patternProperties": { "^(?!(?:fileName|contentType|content|recordCount|truncated|offset|nextOffset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fileName", "contentType", "content", "recordCount", "truncated", "offset", "nextOffset" ] } } ``` ### Underlying API operations - `campaignDelivery.export`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/delivery/export` ## finalize_support_attachment Verify an uploaded object against its signed declaration and issue the download capability. Use after PUT-ing bytes to the upload URL, before referencing the attachment in a case. An expired or foreign upload token cannot finalize; open a fresh upload instead. Scopes: support:create Risk: write; confirmation: none; idempotency: required. ### 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" }, "uploadToken": { "$ref": "#/$defs/SupportCapabilityToken" } }, "required": [ "workspaceId", "uploadToken" ], "patternProperties": { "^(?!(?:workspaceId|uploadToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "uploadToken" ] }, "$defs": { "SupportCapabilityToken": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### 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" }, "uploadToken": { "$ref": "#/$defs/SupportCapabilityToken" } }, "required": [ "workspaceId", "uploadToken" ], "patternProperties": { "^(?!(?:workspaceId|uploadToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "uploadToken" ] }, "$defs": { "SupportCapabilityToken": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "downloadToken": { "$ref": "#/$defs/SupportCapabilityToken" }, "fileName": { "type": "string", "minLength": 1, "maxLength": 255 }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "downloadToken", "fileName", "expiresAt" ], "patternProperties": { "^(?!(?:downloadToken|fileName|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "downloadToken", "fileName", "expiresAt" ] }, "$defs": { "SupportCapabilityToken": { "type": "string", "minLength": 1, "maxLength": 4096 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `support.finalizeAttachment`: `POST /v1/workspaces/:workspaceId/support/attachments/finalize` ## get_attio_status Report the workspace's Attio connection status and granted scopes. Use to poll after connect_attio or to check whether outbound sync scopes are granted. The result carries no token material; do not look for credentials here. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "attio", "heyreach", "plusvibe", "getleads" ] }, "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" }, "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": [ "attio", "heyreach", "plusvibe", "getleads" ] }, "status": { "type": "string", "enum": [ "connected", "needs_reauthorization", "disabled", "disconnected" ] }, "providerWorkspaceId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "providerWorkspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "providerWorkspaceSlug": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "grantedScopes": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "webhookId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "credentialRefId": { "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" } ] }, "connectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "tokenExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "disconnectedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "provider", "status", "providerWorkspaceId", "providerWorkspaceName", "providerWorkspaceSlug", "grantedScopes", "webhookId", "credentialRefId", "connectedAt", "tokenExpiresAt", "disconnectedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|provider|status|providerWorkspaceId|providerWorkspaceName|providerWorkspaceSlug|grantedScopes|webhookId|credentialRefId|connectedAt|tokenExpiresAt|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "provider", "status", "providerWorkspaceId", "providerWorkspaceName", "providerWorkspaceSlug", "grantedScopes", "webhookId", "credentialRefId", "connectedAt", "tokenExpiresAt", "disconnectedAt" ] } }, { "type": "null" } ] } }, "required": [ "provider", "connection" ], "patternProperties": { "^(?!(?:provider|connection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connection" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `attio.getStatus`: `GET /v1/workspaces/:workspaceId/integrations/attio` ## get_booking_availability Read the workspace's calendar availability as up to five free slots plus insert-ready reply text. Use when drafting a reply that should propose meeting times; check `configured` first. Do not use to book or hold a time — this only reads free slots, and the booking link remains the source of truth. Scopes: workspace:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "action": { "type": "string", "enum": [ "status", "list" ] }, "timezone": { "$ref": "#/$defs/IanaTimeZone" }, "count": { "type": "integer", "minimum": 1, "maximum": 5 } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|action|timezone|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "timezone", "count" ] }, "$defs": { "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" } } } ``` ### 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" }, "action": { "type": "string", "enum": [ "status", "list" ] }, "timezone": { "$ref": "#/$defs/IanaTimeZone" }, "count": { "type": "integer", "minimum": 1, "maximum": 5 } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|action|timezone|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "timezone", "count" ] }, "$defs": { "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "configured": { "type": "boolean", "enum": [ false ] } }, "required": [ "configured" ], "patternProperties": { "^(?!(?:configured)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "configured" ] } ] } }, { "type": "object", "properties": { "configured": { "type": "boolean", "enum": [ true ] }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "eventTypeName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "configured", "provider", "eventTypeName" ], "patternProperties": { "^(?!(?:configured|provider|eventTypeName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "configured", "provider", "eventTypeName" ] } } ] }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "eventTypeName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "timezone": { "$ref": "#/$defs/IanaTimeZone" }, "slots": { "type": "array", "items": { "type": "object", "properties": { "startIso": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "formatted": { "$ref": "#/$defs/ShortText" } }, "required": [ "startIso", "formatted" ], "patternProperties": { "^(?!(?:startIso|formatted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "startIso", "formatted" ] } }, "maxItems": 5 }, "formattedText": { "type": "string", "maxLength": 1024 }, "freshness": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "cache", "provider" ] }, "fetchedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "source", "fetchedAt" ], "patternProperties": { "^(?!(?:source|fetchedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "source", "fetchedAt" ] } } }, "required": [ "provider", "eventTypeName", "timezone", "slots", "formattedText", "freshness" ], "patternProperties": { "^(?!(?:provider|eventTypeName|timezone|slots|formattedText|freshness)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "eventTypeName", "timezone", "slots", "formattedText", "freshness" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "configured": { "type": "boolean", "enum": [ false ] } }, "required": [ "configured" ], "patternProperties": { "^(?!(?:configured)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "configured" ] } ] } }, { "type": "object", "properties": { "configured": { "type": "boolean", "enum": [ true ] }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "eventTypeName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "configured", "provider", "eventTypeName" ], "patternProperties": { "^(?!(?:configured|provider|eventTypeName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "configured", "provider", "eventTypeName" ] } } ] }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "eventTypeName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "timezone": { "$ref": "#/$defs/IanaTimeZone" }, "slots": { "type": "array", "items": { "type": "object", "properties": { "startIso": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "formatted": { "$ref": "#/$defs/ShortText" } }, "required": [ "startIso", "formatted" ], "patternProperties": { "^(?!(?:startIso|formatted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "startIso", "formatted" ] } }, "maxItems": 5 }, "formattedText": { "type": "string", "maxLength": 1024 }, "freshness": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "cache", "provider" ] }, "fetchedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "source", "fetchedAt" ], "patternProperties": { "^(?!(?:source|fetchedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "source", "fetchedAt" ] } } }, "required": [ "provider", "eventTypeName", "timezone", "slots", "formattedText", "freshness" ], "patternProperties": { "^(?!(?:provider|eventTypeName|timezone|slots|formattedText|freshness)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "eventTypeName", "timezone", "slots", "formattedText", "freshness" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `booking.availability.status`: `GET /v1/workspaces/:workspaceId/booking/availability/status` - `booking.availability.list`: `GET /v1/workspaces/:workspaceId/booking/availability` ## get_booking_connection_status Report whether Calendly or cal.com is connected for the workspace and which event type is the default. Use to poll after connect_calendly, or to explain why availability is unavailable. The result carries no token or API-key material; do not look for credentials here. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] } }, "required": [ "workspaceId", "provider" ], "patternProperties": { "^(?!(?:workspaceId|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider" ] } } ``` ### 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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] } }, "required": [ "workspaceId", "provider" ], "patternProperties": { "^(?!(?:workspaceId|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "status": { "type": "string", "enum": [ "connected", "disconnected", "not_connected" ] }, "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" }, "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": [ "calendly", "cal_com" ] }, "status": { "type": "string", "enum": [ "connected", "disconnected", "not_connected" ] }, "ownerEmail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "grantedScopes": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "credentialRefId": { "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" } ] }, "webhookId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "defaultEventTypeRef": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "defaultEventTypeName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "defaultSchedulingUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "connectedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "disconnectedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "tokenExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "provider", "status", "ownerEmail", "workspaceName", "grantedScopes", "credentialRefId", "webhookId", "defaultEventTypeRef", "defaultEventTypeName", "defaultSchedulingUrl", "connectedAt", "updatedAt", "disconnectedAt", "tokenExpiresAt" ], "patternProperties": { "^(?!(?:id|workspaceId|provider|status|ownerEmail|workspaceName|grantedScopes|credentialRefId|webhookId|defaultEventTypeRef|defaultEventTypeName|defaultSchedulingUrl|connectedAt|updatedAt|disconnectedAt|tokenExpiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "provider", "status", "ownerEmail", "workspaceName", "grantedScopes", "credentialRefId", "webhookId", "defaultEventTypeRef", "defaultEventTypeName", "defaultSchedulingUrl", "connectedAt", "updatedAt", "disconnectedAt", "tokenExpiresAt" ] } }, { "type": "null" } ] } }, "required": [ "provider", "status", "connection" ], "patternProperties": { "^(?!(?:provider|status|connection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "status", "connection" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "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$" } } } ``` ### Underlying API operations - `booking.calendly.getStatus`: `GET /v1/workspaces/:workspaceId/booking/calendly` - `booking.calCom.getStatus`: `GET /v1/workspaces/:workspaceId/booking/cal-com` ## get_capability Return one capability's full guidance plus its input and output JSON Schemas. Use before calling an unfamiliar capability to learn its prerequisites and exact argument shape. Do not call for capabilities already summarized in a page. Scopes: agent:capabilities Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "capabilityId": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, "required": [ "capabilityId" ], "patternProperties": { "^(?!(?:capabilityId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "capabilityId" ] } ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "capabilityId": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, "required": [ "capabilityId" ], "patternProperties": { "^(?!(?:capabilityId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "capabilityId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "feature": { "$ref": "#/$defs/NonEmptyString" }, "purpose": { "$ref": "#/$defs/Description" }, "prerequisites": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "kind": { "type": "string", "enum": [ "direct_tool", "mcp_resource", "async_operation", "preview_commit", "user_completion", "human_only" ] }, "risk": { "type": "string", "enum": [ "read", "write", "costly", "destructive", "security_admin" ] }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "agent:capabilities", "agent:identity", "agent:operations:cancel", "agent:operations:read", "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "audit:read", "billing:manage", "billing:read", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "platform:operate", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "role:manage", "role:read", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "usage:read", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:create", "workspace:delete", "workspace:read", "workspace:transfer", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "confirmation": { "type": "string", "enum": [ "none", "explicit", "preview_token", "human_completion" ] }, "resultMode": { "type": "string", "enum": [ "inline", "page", "operation_handle", "stream", "download", "redirect" ] }, "availability": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "available", "scope_required", "permission_denied", "feature_disabled", "subscription_blocked", "human_completion_required", "temporarily_unavailable" ] }, "reason": { "$ref": "#/$defs/ShortText" } }, "required": [ "state" ], "patternProperties": { "^(?!(?:state|reason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "reason" ] } }, "inputFields": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "outputBounds": { "type": "object", "properties": { "maxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxBytes": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "maxItems", "maxBytes" ], "patternProperties": { "^(?!(?:maxItems|maxBytes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "maxItems", "maxBytes" ] } }, "bundles": { "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, "inputSchema": { "$ref": "#/$defs/Union_" }, "outputSchema": { "$ref": "#/$defs/Union_" }, "errorCodes": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "guidance": { "type": "object", "properties": { "whenToUse": { "$ref": "#/$defs/Description" }, "whenNotToUse": { "$ref": "#/$defs/Description" } }, "required": [ "whenToUse", "whenNotToUse" ], "patternProperties": { "^(?!(?:whenToUse|whenNotToUse)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "whenToUse", "whenNotToUse" ] } } }, "required": [ "id", "feature", "purpose", "prerequisites", "kind", "risk", "scopes", "confirmation", "resultMode", "availability", "inputFields", "outputBounds", "bundles", "inputSchema", "outputSchema", "errorCodes", "guidance" ], "patternProperties": { "^(?!(?:id|feature|purpose|prerequisites|kind|risk|scopes|confirmation|resultMode|availability|inputFields|outputBounds|bundles|inputSchema|outputSchema|errorCodes|guidance)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "feature", "purpose", "prerequisites", "kind", "risk", "scopes", "confirmation", "resultMode", "availability", "inputFields", "outputBounds", "bundles", "inputSchema", "outputSchema", "errorCodes", "guidance" ] }, "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] } } } ``` ### Underlying API operations - `agent.getCapability`: `GET /agent/capabilities/:capabilityId` ## get_dashboard Read a complete saved dashboard or query including SQL, chart types and columns, filters, text widgets, layout and revision. Use before editing. Preserve widget IDs and unrelated settings; use the returned revision with save_dashboard. Requires the Workspace SQL feature and the stated permission. This does not grant access to another Workspace or execute stored SQL automatically. Scopes: sql:query Risk: read; confirmation: none; idempotency: none. ### 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" }, "dashboardId": { "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", "dashboardId" ], "patternProperties": { "^(?!(?:workspaceId|dashboardId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "dashboardId" ] } } ``` ### 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" }, "dashboardId": { "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", "dashboardId" ], "patternProperties": { "^(?!(?:workspaceId|dashboardId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "dashboardId" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "ownerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedAt": { "type": "string" }, "document": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "kind": { "type": "string", "enum": [ "dashboard", "query" ] }, "name": { "type": "string", "maxLength": 160, "minLength": 1 }, "description": { "type": "string", "maxLength": 2000 }, "filters": { "type": "object", "properties": { "from": { "type": "string", "maxLength": 40 }, "to": { "type": "string", "maxLength": 40 }, "domain": { "type": "string", "maxLength": 253 }, "ip": { "type": "string", "maxLength": 64 }, "source": { "type": "string", "maxLength": 256 } }, "required": [ "from", "to", "domain", "ip", "source" ], "patternProperties": { "^(?!(?:from|to|domain|ip|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] } }, "widgets": { "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" }, "kind": { "type": "string", "enum": [ "chart", "text" ] }, "title": { "type": "string", "maxLength": 160 }, "text": { "type": "string", "maxLength": 4000 }, "query": { "type": "string", "maxLength": 20000 }, "bindings": { "type": "array", "items": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] }, "maxItems": 32 }, "chart": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "table", "number", "line", "area", "bar" ] }, "dimension": { "type": "string", "maxLength": 128 }, "measures": { "type": "array", "items": { "type": "string", "maxLength": 128 }, "maxItems": 8 }, "format": { "type": "string", "enum": [ "number", "percent", "currency", "duration", "bytes" ] }, "decimals": { "type": "integer", "minimum": 0, "maximum": 6 }, "label": { "type": "string", "maxLength": 128 } }, "required": [ "type", "dimension", "measures", "format", "decimals", "label" ], "patternProperties": { "^(?!(?:type|dimension|measures|format|decimals|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "dimension", "measures", "format", "decimals", "label" ] } }, "layout": { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 500 }, "w": { "type": "integer", "minimum": 2, "maximum": 12 }, "h": { "type": "integer", "minimum": 2, "maximum": 12 } }, "required": [ "x", "y", "w", "h" ], "patternProperties": { "^(?!(?:x|y|w|h)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y", "w", "h" ] } } }, "required": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ], "patternProperties": { "^(?!(?:id|kind|title|text|query|bindings|chart|layout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ] } }, "maxItems": 30 } }, "required": [ "version", "kind", "name", "description", "filters", "widgets" ], "patternProperties": { "^(?!(?:version|kind|name|description|filters|widgets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "kind", "name", "description", "filters", "widgets" ] } } }, "required": [ "id", "workspaceId", "ownerId", "revision", "updatedAt", "document" ], "patternProperties": { "^(?!(?:id|workspaceId|ownerId|revision|updatedAt|document)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "ownerId", "revision", "updatedAt", "document" ] } } ``` ### Underlying API operations - `dashboards.get`: `GET /v1/workspaces/:workspaceId/dashboards/:dashboardId` ## get_getleads_status Report whether GetLeads is connected, its pacing policy, and whether its webhook is armed. Use before running a GetLeads request or configuring a GetLeads workflow block. The result never contains the key or the webhook token; only the key's last four characters. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "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" }, "status": { "type": "string", "enum": [ "connected", "needs_reauthorization", "disabled", "disconnected" ] }, "keyLastFour": { "type": "string", "pattern": "^.{4}$" }, "requestsPerMinute": { "type": "integer", "minimum": 1, "maximum": 100 }, "webhookEnabled": { "type": "boolean" }, "lastWebhookAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "connectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "status", "keyLastFour", "requestsPerMinute", "webhookEnabled", "lastWebhookAt", "lastValidatedAt", "connectedAt" ], "patternProperties": { "^(?!(?:id|status|keyLastFour|requestsPerMinute|webhookEnabled|lastWebhookAt|lastValidatedAt|connectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "status", "keyLastFour", "requestsPerMinute", "webhookEnabled", "lastWebhookAt", "lastValidatedAt", "connectedAt" ] } }, { "type": "null" } ] } }, "required": [ "connection" ], "patternProperties": { "^(?!(?:connection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "connection" ] } ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `getleads.status`: `GET /v1/workspaces/:workspaceId/integrations/getleads` ## get_getleads_usage Read the GetLeads plan, remaining credits, and daily/monthly fair-use windows. Use before a large enrichment to check the account can absorb it. This reads GetLeads live and counts against the pacing gate; do not poll it. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "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" } }, "required": [ "workspaceId", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId" ] } } ``` ### 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" }, "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" } }, "required": [ "workspaceId", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "applies": { "type": "boolean" }, "plan": { "$ref": "#/$defs/ShortText" }, "exempt": { "type": "boolean" }, "creditsRemaining": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "daily": { "type": "object", "properties": { "cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "used": { "type": "number" }, "remaining": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "period": { "$ref": "#/$defs/ShortText" }, "periodStart": { "$ref": "#/$defs/ShortText" }, "resetsAt": { "$ref": "#/$defs/ShortText" } }, "required": [ "cap", "used", "remaining", "period", "periodStart", "resetsAt" ], "patternProperties": { "^(?!(?:cap|used|remaining|period|periodStart|resetsAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cap", "used", "remaining", "period", "periodStart", "resetsAt" ] } }, "monthly": { "type": "object", "properties": { "cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "used": { "type": "number" }, "remaining": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "period": { "$ref": "#/$defs/ShortText" }, "periodStart": { "$ref": "#/$defs/ShortText" }, "resetsAt": { "$ref": "#/$defs/ShortText" } }, "required": [ "cap", "used", "remaining", "period", "periodStart", "resetsAt" ], "patternProperties": { "^(?!(?:cap|used|remaining|period|periodStart|resetsAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cap", "used", "remaining", "period", "periodStart", "resetsAt" ] } }, "binding": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "ok", "applies", "plan", "creditsRemaining" ], "patternProperties": { "^(?!(?:ok|applies|plan|exempt|creditsRemaining|daily|monthly|binding)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "ok", "applies", "plan", "exempt", "creditsRemaining", "daily", "monthly", "binding" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `getleads.usage`: `GET /v1/workspaces/:workspaceId/integrations/getleads/:connectionId/usage` ## get_identity Return the authenticated agent's identity, registration kind, scope ceiling, and status. Call first to learn which principal, organization, and scopes the credential holds before attempting work. Do not call in a polling loop; identity changes only on credential or registration changes. Scopes: agent:identity Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "registrationId": { "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" } ] }, "grantId": { "$ref": "#/$defs/OpaqueId" }, "kind": { "type": "string", "enum": [ "service_auth", "identity_assertion", "organization_api_key", "internal_workflow", "mcp_client_grant" ] }, "status": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "interaction_required", "expired", "revoked", "suspended" ] }, "reasonCode": { "type": "string", "enum": [ "actor_removed", "credential_expired", "link_required", "provider_revoked", "admin_revoked", "policy_suspended" ] } }, "required": [ "status" ], "patternProperties": { "^(?!(?:status|reasonCode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "reasonCode" ] } }, "actorUserId": { "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" }, "organization": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name", "slug" ], "patternProperties": { "^(?!(?:id|name|slug)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug" ] } }, "provider": { "anyOf": [ { "type": "object", "properties": { "issuer": { "$ref": "#/$defs/ProviderId" }, "displayName": { "$ref": "#/$defs/ShortText" } }, "required": [ "issuer", "displayName" ], "patternProperties": { "^(?!(?:issuer|displayName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "issuer", "displayName" ] } }, { "type": "null" } ] }, "grantedScopes": { "type": "array", "items": { "type": "string", "enum": [ "agent:capabilities", "agent:identity", "agent:operations:cancel", "agent:operations:read", "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "audit:read", "billing:manage", "billing:read", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "platform:operate", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "role:manage", "role:read", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "usage:read", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:create", "workspace:delete", "workspace:read", "workspace:transfer", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "registrationId", "kind", "status", "actorUserId", "organization", "provider", "grantedScopes", "createdAt", "lastUsedAt", "expiresAt" ], "patternProperties": { "^(?!(?:registrationId|grantId|kind|status|actorUserId|organization|provider|grantedScopes|createdAt|lastUsedAt|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "registrationId", "grantId", "kind", "status", "actorUserId", "organization", "provider", "grantedScopes", "createdAt", "lastUsedAt", "expiresAt" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `agent.getIdentity`: `GET /agent/identity` ## get_integration_share_options Show whether a connection can be shared and which sibling workspaces can receive it. Call before share_integration_connection to pick eligible workspaceIds and see existing targets. Ineligible workspaces (no permission, or already their own connection) are listed with a reason; do not retry them. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "adapter": { "$ref": "#/$defs/IntegrationShareAdapter" }, "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" } }, "required": [ "workspaceId", "adapter", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|adapter|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "adapter", "connectionId" ] }, "$defs": { "IntegrationShareAdapter": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer", "heyreach", "getleads", "plusvibe", "calendly", "cal_com", "attio", "email_verifier", "phone_verifier", "warmup_provider", "mcp_server", "app_connection" ] } } } ``` ### 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" }, "adapter": { "$ref": "#/$defs/IntegrationShareAdapter" }, "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" } }, "required": [ "workspaceId", "adapter", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|adapter|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "adapter", "connectionId" ] }, "$defs": { "IntegrationShareAdapter": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer", "heyreach", "getleads", "plusvibe", "calendly", "cal_com", "attio", "email_verifier", "phone_verifier", "warmup_provider", "mcp_server", "app_connection" ] } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "adapter": { "$ref": "#/$defs/IntegrationShareAdapter" }, "provider": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,63}$" }, "displayName": { "$ref": "#/$defs/ShortText" }, "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" }, "shareable": { "type": "boolean" }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "existingShareId": { "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" } ] }, "includeFutureWorkspaces": { "type": "boolean" }, "candidates": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "eligible": { "type": "boolean" }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "enum": [ "attaching", "attached", "detached", "failed" ] }, { "type": "null" } ] } }, "required": [ "workspaceId", "workspaceName", "eligible", "reason", "state" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|eligible|reason|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "eligible", "reason", "state" ] } }, "maxItems": 500 } }, "required": [ "adapter", "provider", "displayName", "connectionId", "shareable", "reason", "existingShareId", "includeFutureWorkspaces", "candidates" ], "patternProperties": { "^(?!(?:adapter|provider|displayName|connectionId|shareable|reason|existingShareId|includeFutureWorkspaces|candidates)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "adapter", "provider", "displayName", "connectionId", "shareable", "reason", "existingShareId", "includeFutureWorkspaces", "candidates" ] }, "$defs": { "IntegrationShareAdapter": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer", "heyreach", "getleads", "plusvibe", "calendly", "cal_com", "attio", "email_verifier", "phone_verifier", "warmup_provider", "mcp_server", "app_connection" ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `integrationShares.options`: `GET /v1/workspaces/:workspaceId/integration-shares/options` ## get_my_developer_mode Read your account-wide Developer mode preference. Use your own human session, full-account personal API key or consented interactive MCP connection. The setting persists across devices and sign-ins. Cannot target another user, use restricted keys or non-interactive agents, or enable/disable realtime transport. Scopes: workspace:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "developerModeEnabled": { "type": "boolean" } }, "required": [ "developerModeEnabled" ], "patternProperties": { "^(?!(?:developerModeEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "developerModeEnabled" ] } ] } } ``` ### Underlying API operations - `developerMode.get`: `GET /v1/me/developer-mode` ## get_operation Poll a durable operation's state, progress, structured failure, or result reference. Poll after starting async work until the operation reaches a terminal state. Do not poll faster than the operation's suggested interval; it wastes the caller's rate budget. Scopes: agent:operations:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "operationId": { "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": [ "operationId" ], "patternProperties": { "^(?!(?:operationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "operationId" ] } ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "operationId": { "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": [ "operationId" ], "patternProperties": { "^(?!(?:operationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "operationId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "capabilityId": { "anyOf": [ { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, { "type": "null" } ] }, "workspaceId": { "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" } ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] }, "statusUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] }, "submittedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "startedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "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" }, "failure": { "type": "object", "properties": { "code": { "$ref": "#/$defs/NonEmptyString" }, "safeMessage": { "$ref": "#/$defs/ShortText" }, "retryable": { "type": "boolean" }, "retryAfter": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recoveryCapability": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, "required": [ "code", "safeMessage", "retryable" ], "patternProperties": { "^(?!(?:code|safeMessage|retryable|retryAfter|recoveryCapability)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "code", "safeMessage", "retryable", "retryAfter", "recoveryCapability" ] } }, "result": { "anyOf": [ { "type": "object", "properties": { "capabilityId": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "href": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] } }, "required": [ "capabilityId", "href" ], "patternProperties": { "^(?!(?:capabilityId|href)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "capabilityId", "href" ] } }, { "type": "object", "properties": { "providerOperation": { "type": "string", "enum": [ "usage", "enrich_email", "enrich_linkedin", "enrich_person", "lookup_phone", "search", "count", "export", "export_status", "profiles", "profile_leads", "set_profile_active" ] }, "results": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0 }, "outcome": { "type": "string", "enum": [ "ok", "failed", "skipped" ] }, "value": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "$ref": "#/$defs/Arrays_" }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "errorCode": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "index", "outcome" ], "patternProperties": { "^(?!(?:index|outcome|value|errorCode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "index", "outcome", "value", "errorCode" ] } }, "maxItems": 100 } }, "required": [ "providerOperation", "results" ], "patternProperties": { "^(?!(?:providerOperation|results)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerOperation", "results" ] } } ] } }, "required": [ "id", "capabilityId", "workspaceId", "state", "statusUrl", "submittedAt", "startedAt", "completedAt", "canCancel" ], "patternProperties": { "^(?!(?:id|capabilityId|workspaceId|state|statusUrl|submittedAt|startedAt|completedAt|progress|canCancel|failure|result)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "capabilityId", "workspaceId", "state", "statusUrl", "submittedAt", "startedAt", "completedAt", "progress", "canCancel", "failure", "result" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "$ref": "#/$defs/Arrays_" }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "Arrays_": { "type": "array", "items": { "$ref": "#/$defs/Union_" } } } } ``` ### Underlying API operations - `agent.getOperation`: `GET /agent/operations/:operationId` ## get_organization_dashboard Read a complete saved dashboard or query including SQL, chart types and columns, filters, text widgets, layout and revision. Use before editing. Preserve widget IDs and unrelated settings; use the returned revision with save_organization_dashboard. Requires the stated Organization analytics permission. Reading a document never executes its SQL; saving validates every selected child, and execution always requires live child SQL access and feature eligibility. Scopes: orgAnalytics:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "organizationId": { "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" }, "dashboardId": { "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": [ "organizationId", "dashboardId" ], "patternProperties": { "^(?!(?:organizationId|dashboardId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "dashboardId" ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "organizationId": { "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" }, "dashboardId": { "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": [ "organizationId", "dashboardId" ], "patternProperties": { "^(?!(?:organizationId|dashboardId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "dashboardId" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "organizationId": { "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" }, "workspaceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, { "type": "null" } ] }, "ownerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "updatedAt": { "type": "string" }, "document": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "kind": { "type": "string", "enum": [ "dashboard", "query" ] }, "name": { "type": "string", "maxLength": 160, "minLength": 1 }, "description": { "type": "string", "maxLength": 2000 }, "filters": { "type": "object", "properties": { "from": { "type": "string", "maxLength": 40 }, "to": { "type": "string", "maxLength": 40 }, "domain": { "type": "string", "maxLength": 253 }, "ip": { "type": "string", "maxLength": 64 }, "source": { "type": "string", "maxLength": 256 } }, "required": [ "from", "to", "domain", "ip", "source" ], "patternProperties": { "^(?!(?:from|to|domain|ip|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] } }, "widgets": { "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" }, "kind": { "type": "string", "enum": [ "chart", "text" ] }, "title": { "type": "string", "maxLength": 160 }, "text": { "type": "string", "maxLength": 4000 }, "query": { "type": "string", "maxLength": 20000 }, "bindings": { "type": "array", "items": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] }, "maxItems": 32 }, "chart": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "table", "number", "line", "area", "bar" ] }, "dimension": { "type": "string", "maxLength": 128 }, "measures": { "type": "array", "items": { "type": "string", "maxLength": 128 }, "maxItems": 8 }, "format": { "type": "string", "enum": [ "number", "percent", "currency", "duration", "bytes" ] }, "decimals": { "type": "integer", "minimum": 0, "maximum": 6 }, "label": { "type": "string", "maxLength": 128 } }, "required": [ "type", "dimension", "measures", "format", "decimals", "label" ], "patternProperties": { "^(?!(?:type|dimension|measures|format|decimals|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "dimension", "measures", "format", "decimals", "label" ] } }, "layout": { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 500 }, "w": { "type": "integer", "minimum": 2, "maximum": 12 }, "h": { "type": "integer", "minimum": 2, "maximum": 12 } }, "required": [ "x", "y", "w", "h" ], "patternProperties": { "^(?!(?:x|y|w|h)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y", "w", "h" ] } } }, "required": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ], "patternProperties": { "^(?!(?:id|kind|title|text|query|bindings|chart|layout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ] } }, "maxItems": 30 } }, "required": [ "version", "kind", "name", "description", "filters", "widgets" ], "patternProperties": { "^(?!(?:version|kind|name|description|filters|widgets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "kind", "name", "description", "filters", "widgets" ] } } }, "required": [ "id", "organizationId", "workspaceIds", "ownerId", "revision", "updatedAt", "document" ], "patternProperties": { "^(?!(?:id|organizationId|workspaceIds|ownerId|revision|updatedAt|document)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "organizationId", "workspaceIds", "ownerId", "revision", "updatedAt", "document" ] } } ``` ### Underlying API operations - `organizationDashboards.get`: `GET /v1/organizations/:organizationId/dashboards/:dashboardId` ## get_permission_request Read one permission request: requester, requested and granted permissions, reason and context, status, and the reviewer's note. Use to follow up on a request you filed (pending, approved, denied, cancelled, or expired) or to show a reviewer its details before deciding. Non-reviewers can read only their own requests; others answer not found. Scopes: workspace:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "requestId": { "$ref": "#/$defs/PermissionRequestId" } }, "required": [ "workspaceId", "requestId" ], "patternProperties": { "^(?!(?:workspaceId|requestId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "requestId" ] }, "$defs": { "PermissionRequestId": { "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" } } } ``` ### 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" }, "requestId": { "$ref": "#/$defs/PermissionRequestId" } }, "required": [ "workspaceId", "requestId" ], "patternProperties": { "^(?!(?:workspaceId|requestId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "requestId" ] }, "$defs": { "PermissionRequestId": { "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" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "PermissionRequestId": { "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" }, "PermissionRequestStatus": { "type": "string", "enum": [ "pending", "approved", "denied", "canceled", "expired" ] }, "PermissionRequestPerson": { "type": "object", "properties": { "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, "PermissionRequestContext": { "type": "object", "properties": { "attemptedOperation": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "attemptedTool": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "explanation": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:attemptedOperation|attemptedTool|explanation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attemptedOperation", "attemptedTool", "explanation" ] } }, "PermissionRequestSource": { "type": "string", "enum": [ "web", "api", "agent" ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "PermissionRequest": { "type": "object", "properties": { "id": { "$ref": "#/$defs/PermissionRequestId" }, "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" }, "status": { "$ref": "#/$defs/PermissionRequestStatus" }, "requester": { "$ref": "#/$defs/PermissionRequestPerson" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "grantedPermissions": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "context": { "$ref": "#/$defs/PermissionRequestContext" }, "source": { "$ref": "#/$defs/PermissionRequestSource" }, "agentName": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "decidedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "decidedBy": { "anyOf": [ { "$ref": "#/$defs/PermissionRequestPerson" }, { "type": "null" } ] }, "decisionNote": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "reviewable": { "type": "boolean" } }, "required": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ], "patternProperties": { "^(?!(?:id|workspaceId|status|requester|permissions|grantedPermissions|reason|context|source|agentName|createdAt|expiresAt|decidedAt|decidedBy|decisionNote|reviewable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/PermissionRequest" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/PermissionRequest" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `permissionRequests.get`: `GET /v1/workspaces/:workspaceId/permission-requests/:requestId` ## get_plusvibe_status Report whether PlusVibe is connected and the health of each workflow's PlusVibe webhook. Use before configuring a PlusVibe trigger or action, or to diagnose a workflow that stopped receiving PlusVibe events. The result carries no key material and no remote hook URLs; do not look for them here. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "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" }, "status": { "type": "string", "enum": [ "connected", "needs_reauthorization", "disabled", "disconnected" ] }, "providerWorkspaceIds": { "type": "array", "items": { "$ref": "#/$defs/PlusVibeRemoteId" }, "maxItems": 200 }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "connectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "disconnectedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "status", "providerWorkspaceIds", "lastValidatedAt", "connectedAt", "disconnectedAt" ], "patternProperties": { "^(?!(?:id|status|providerWorkspaceIds|lastValidatedAt|connectedAt|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "status", "providerWorkspaceIds", "lastValidatedAt", "connectedAt", "disconnectedAt" ] } }, { "type": "null" } ] }, "webhookSubscriptions": { "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" }, "workflowId": { "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" }, "status": { "type": "string", "enum": [ "pending", "creating", "active", "error", "removed", "unknown" ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workflowId", "status", "error", "updatedAt" ], "patternProperties": { "^(?!(?:id|workflowId|status|error|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "status", "error", "updatedAt" ] } }, "maxItems": 500 } }, "required": [ "connection", "webhookSubscriptions" ], "patternProperties": { "^(?!(?:connection|webhookSubscriptions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connection", "webhookSubscriptions" ] }, "$defs": { "PlusVibeRemoteId": { "type": "string", "minLength": 1, "maxLength": 100 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `plusvibe.status`: `GET /v1/workspaces/:workspaceId/integrations/plusvibe` ## get_thread_reminder Return the current reminder for one thread, or null. Use before scheduling to check whether a thread already has a pending reminder. Do not use for workspace-wide listing; use list_reminders. Scopes: unibox:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "threadId": { "$ref": "#/$defs/ProviderId" } }, "required": [ "workspaceId", "threadId" ], "patternProperties": { "^(?!(?:workspaceId|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "threadId" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### 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" }, "threadId": { "$ref": "#/$defs/ProviderId" } }, "required": [ "workspaceId", "threadId" ], "patternProperties": { "^(?!(?:workspaceId|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "threadId" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "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" }, "threadId": { "$ref": "#/$defs/ProviderId" }, "remindAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isAutomatic": { "type": "boolean" }, "status": { "type": "string", "enum": [ "pending", "sent", "cancelled" ] }, "sentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "jobRunId": { "anyOf": [ { "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": "string", "pattern": "^run_[a-zA-Z0-9]{1,200}$" } ] }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "threadId", "remindAt", "isAutomatic", "status", "sentAt", "cancelledAt", "jobRunId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|threadId|remindAt|isAutomatic|status|sentAt|cancelledAt|jobRunId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "threadId", "remindAt", "isAutomatic", "status", "sentAt", "cancelledAt", "jobRunId", "createdAt", "updatedAt" ] } }, { "type": "null" } ] }, { "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" }, "threadId": { "$ref": "#/$defs/ProviderId" }, "remindAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isAutomatic": { "type": "boolean" }, "status": { "type": "string", "enum": [ "pending", "sent", "cancelled" ] }, "sentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "jobRunId": { "anyOf": [ { "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": "string", "pattern": "^run_[a-zA-Z0-9]{1,200}$" } ] }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "threadId", "remindAt", "isAutomatic", "status", "sentAt", "cancelledAt", "jobRunId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|threadId|remindAt|isAutomatic|status|sentAt|cancelledAt|jobRunId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "threadId", "remindAt", "isAutomatic", "status", "sentAt", "cancelledAt", "jobRunId", "createdAt", "updatedAt" ] } }, { "type": "null" } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `reminders.getForThread`: `GET /v1/workspaces/:workspaceId/reminders/thread/:threadId` ## grant_support_access Grant Scheduler Zero support a chosen subset of your permissions in one workspace for 24, 72 (default), or 168 hours. Use only when the person asked for support to access this workspace and explicitly approved the exact permissions and period; pass confirmed: true. Never grant on your own initiative or broader than the task needs. You cannot grant a permission you do not hold here. API keys cannot grant. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspaceMember:invite Risk: security_admin; confirmation: explicit; 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" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "agent:capabilities", "agent:identity", "agent:operations:cancel", "agent:operations:read", "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "audit:read", "billing:manage", "billing:read", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "platform:operate", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "role:manage", "role:read", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "usage:read", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:create", "workspace:delete", "workspace:read", "workspace:transfer", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "minItems": 1, "maxItems": 200 }, "durationHours": { "$ref": "#/$defs/SupportAccessDurationHours" }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "confirmed": { "type": "boolean", "enum": [ true ] } }, "required": [ "workspaceId", "permissions", "confirmed" ], "patternProperties": { "^(?!(?:workspaceId|permissions|durationHours|reason|confirmed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "permissions", "durationHours", "reason", "confirmed" ] }, "$defs": { "SupportAccessDurationHours": { "type": "number", "enum": [ 24, 72, 168 ] } } } ``` ### 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" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "agent:capabilities", "agent:identity", "agent:operations:cancel", "agent:operations:read", "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "audit:read", "billing:manage", "billing:read", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "platform:operate", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "role:manage", "role:read", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "usage:read", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:create", "workspace:delete", "workspace:read", "workspace:transfer", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "minItems": 1, "maxItems": 200 }, "durationHours": { "$ref": "#/$defs/SupportAccessDurationHours" }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "confirmed": { "type": "boolean", "enum": [ true ] } }, "required": [ "workspaceId", "permissions", "confirmed" ], "patternProperties": { "^(?!(?:workspaceId|permissions|durationHours|reason|confirmed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "permissions", "durationHours", "reason", "confirmed" ] }, "$defs": { "SupportAccessDurationHours": { "type": "number", "enum": [ 24, 72, 168 ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "SupportAccessGrantId": { "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" }, "SupportAccessStatus": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "SupportAccessDurationHours": { "type": "number", "enum": [ 24, 72, 168 ] }, "SupportAccessPerson": { "type": "object", "properties": { "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "userId", "email" ], "patternProperties": { "^(?!(?:userId|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "email" ] } }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "SupportAccessGrant": { "type": "object", "properties": { "id": { "$ref": "#/$defs/SupportAccessGrantId" }, "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" }, "status": { "$ref": "#/$defs/SupportAccessStatus" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "agent:capabilities", "agent:identity", "agent:operations:cancel", "agent:operations:read", "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "audit:read", "billing:manage", "billing:read", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "platform:operate", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "role:manage", "role:read", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "usage:read", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:create", "workspace:delete", "workspace:read", "workspace:transfer", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "durationHours": { "$ref": "#/$defs/SupportAccessDurationHours" }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "grantedBy": { "$ref": "#/$defs/SupportAccessPerson" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "revokedBy": { "anyOf": [ { "$ref": "#/$defs/SupportAccessPerson" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "status", "permissions", "durationHours", "reason", "grantedBy", "createdAt", "expiresAt", "revokedAt", "revokedBy", "lastUsedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|status|permissions|durationHours|reason|grantedBy|createdAt|expiresAt|revokedAt|revokedBy|lastUsedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "status", "permissions", "durationHours", "reason", "grantedBy", "createdAt", "expiresAt", "revokedAt", "revokedBy", "lastUsedAt" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/SupportAccessGrant" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/SupportAccessGrant" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `supportAccess.grant`: `POST /v1/workspaces/:workspaceId/support-access` ## import_attio_list Import an Attio list — or chosen entries of it — into a campaign as a durable operation, creating unified leads through the same primitive as a single import. Use for bulk imports. Poll the returned operation handle, then read the import record (read_attio_records import_history or import_details) for counts and row failures. Refused with Conflict while an import of the same list into the same campaign is still running. People without an email are skipped and reported, never enrolled. Scopes: lead:import, integration: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" }, "import": { "type": "object", "properties": { "listId": { "$ref": "#/$defs/ProviderId" }, "campaignId": { "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" }, "mappingId": { "$ref": "#/$defs/AttioFieldMappingId" }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal" ] }, "duplicateBehavior": { "type": "string", "enum": [ "skip", "update" ] }, "entryIds": { "type": "array", "items": { "$ref": "#/$defs/ProviderId" }, "minItems": 1, "maxItems": 10000 } }, "required": [ "listId", "campaignId" ], "patternProperties": { "^(?!(?:listId|campaignId|mappingId|emailStrategy|duplicateBehavior|entryIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "listId", "campaignId", "mappingId", "emailStrategy", "duplicateBehavior", "entryIds" ] } } }, "required": [ "workspaceId", "import" ], "patternProperties": { "^(?!(?:workspaceId|import)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "import" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "AttioFieldMappingId": { "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" } } } ``` ### 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" }, "import": { "type": "object", "properties": { "listId": { "$ref": "#/$defs/ProviderId" }, "campaignId": { "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" }, "mappingId": { "$ref": "#/$defs/AttioFieldMappingId" }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal" ] }, "duplicateBehavior": { "type": "string", "enum": [ "skip", "update" ] }, "entryIds": { "type": "array", "items": { "$ref": "#/$defs/ProviderId" }, "minItems": 1, "maxItems": 10000 } }, "required": [ "listId", "campaignId" ], "patternProperties": { "^(?!(?:listId|campaignId|mappingId|emailStrategy|duplicateBehavior|entryIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "listId", "campaignId", "mappingId", "emailStrategy", "duplicateBehavior", "entryIds" ] } } }, "required": [ "workspaceId", "import" ], "patternProperties": { "^(?!(?:workspaceId|import)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "import" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "AttioFieldMappingId": { "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" } } } ``` ### Output schema (structuredContent) ```json { "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" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Underlying API operations - `attioImports.list`: `POST /v1/workspaces/:workspaceId/integrations/attio/imports/list` ## import_attio_person Import one Attio person into a campaign as a unified lead plus its campaign contact, using the email address a person chose from the import preview. Use after read_attio_records' person_import_preview, once the email to import is settled. The result says whether the lead was created or matched and reports any contact point that stayed with another lead. Refused with Conflict when that email is already a contact in the campaign — it is never enrolled twice. For more than one person, use import_attio_list, which is durable. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: lead:import, integration:read Risk: write; confirmation: explicit; 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" }, "import": { "type": "object", "properties": { "recordId": { "$ref": "#/$defs/ProviderId" }, "campaignId": { "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" }, "selectedEmail": { "$ref": "#/$defs/EmailAddress" }, "mappingId": { "$ref": "#/$defs/AttioFieldMappingId" }, "customFieldValues": { "type": "object", "additionalProperties": true, "minProperties": 0, "maxProperties": 100 } }, "required": [ "recordId", "campaignId", "selectedEmail" ], "patternProperties": { "^(?!(?:recordId|campaignId|selectedEmail|mappingId|customFieldValues)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recordId", "campaignId", "selectedEmail", "mappingId", "customFieldValues" ] } } }, "required": [ "workspaceId", "import" ], "patternProperties": { "^(?!(?:workspaceId|import)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "import" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "AttioFieldMappingId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### 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" }, "import": { "type": "object", "properties": { "recordId": { "$ref": "#/$defs/ProviderId" }, "campaignId": { "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" }, "selectedEmail": { "$ref": "#/$defs/EmailAddress" }, "mappingId": { "$ref": "#/$defs/AttioFieldMappingId" }, "customFieldValues": { "type": "object", "additionalProperties": true, "minProperties": 0, "maxProperties": 100 } }, "required": [ "recordId", "campaignId", "selectedEmail" ], "patternProperties": { "^(?!(?:recordId|campaignId|selectedEmail|mappingId|customFieldValues)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recordId", "campaignId", "selectedEmail", "mappingId", "customFieldValues" ] } } }, "required": [ "workspaceId", "import" ], "patternProperties": { "^(?!(?:workspaceId|import)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "import" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "AttioFieldMappingId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "AttioImportId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "AttioImportPersonResult": { "type": "object", "properties": { "importId": { "$ref": "#/$defs/AttioImportId" }, "campaignContactId": { "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" }, "leadId": { "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" }, "leadCreated": { "type": "boolean" }, "conflicts": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/ShortText" }, "ownedByLeadId": { "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": [ "kind", "value", "ownedByLeadId" ], "patternProperties": { "^(?!(?:kind|value|ownedByLeadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "value", "ownedByLeadId" ] } }, "maxItems": 100 } }, "required": [ "importId", "campaignContactId", "leadId", "leadCreated", "conflicts" ], "patternProperties": { "^(?!(?:importId|campaignContactId|leadId|leadCreated|conflicts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "importId", "campaignContactId", "leadId", "leadCreated", "conflicts" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/AttioImportPersonResult" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/AttioImportPersonResult" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `attioImports.person`: `POST /v1/workspaces/:workspaceId/integrations/attio/imports/person` ## import_leads Import rows or bulk-create leads into a lead list via email-keyed never-clear upserts; action selects import or bulk_create. Use for JSON row imports (<=10,000) or the Add Lead bulk path; blank values never erase data. Attio sync is available only for a single-lead bulk create and is gated on the outbound toggle. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: lead:import, lead:create Risk: write; confirmation: explicit; 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" }, "leadListId": { "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": [ "import", "bulk_create" ] }, "rows": { "type": "array", "items": { "type": "object", "properties": { "acquisitionSource": { "type": "string", "maxLength": 256 }, "email": { "$ref": "#/$defs/EmailAddress" }, "firstName": { "type": "string", "maxLength": 256 }, "lastName": { "type": "string", "maxLength": 256 }, "company": { "type": "string", "maxLength": 256 }, "city": { "type": "string", "maxLength": 256 }, "state": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "maxLength": 256 }, "customFields": { "$ref": "#/$defs/LeadCustomFieldValues" }, "emails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" } }, "phones": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "ladder": { "type": "string", "maxLength": 256 }, "rank": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "email", "firstName", "lastName" ], "patternProperties": { "^(?!(?:acquisitionSource|email|firstName|lastName|company|city|state|country|customFields|emails|phones|ladder|rank)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "acquisitionSource", "email", "firstName", "lastName", "company", "city", "state", "country", "customFields", "emails", "phones", "ladder", "rank" ] } }, "maxItems": 10000 }, "leads": { "type": "array", "items": { "type": "object", "properties": { "acquisitionSource": { "type": "string", "maxLength": 256 }, "email": { "$ref": "#/$defs/NonEmptyString" }, "firstName": { "type": "string", "maxLength": 256 }, "lastName": { "type": "string", "maxLength": 256 }, "company": { "type": "string", "maxLength": 256 }, "city": { "type": "string", "maxLength": 256 }, "state": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "maxLength": 256 }, "customFieldValues": { "$ref": "#/$defs/LeadCustomFieldValues" }, "emails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" } }, "phones": { "type": "array", "items": { "$ref": "#/$defs/LeadPhoneValue" } }, "ladder": { "$ref": "#/$defs/ShortText" }, "rank": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "email", "firstName", "lastName" ], "patternProperties": { "^(?!(?:acquisitionSource|email|firstName|lastName|company|city|state|country|customFieldValues|emails|phones|ladder|rank)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "acquisitionSource", "email", "firstName", "lastName", "company", "city", "state", "country", "customFieldValues", "emails", "phones", "ladder", "rank" ] } }, "maxItems": 10000 }, "syncToAttio": { "type": "boolean" } }, "required": [ "workspaceId", "leadListId", "action" ], "patternProperties": { "^(?!(?:workspaceId|leadListId|action|rows|leads|syncToAttio)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "leadListId", "action", "rows", "leads", "syncToAttio" ] }, "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "LeadCustomFieldValues": { "type": "object", "additionalProperties": true }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "LeadPhoneValue": { "type": "string", "minLength": 2, "maxLength": 32, "pattern": "^\\+?[0-9]+(;ext=[0-9]+)?$" } } } ``` ### 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" }, "leadListId": { "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": [ "import", "bulk_create" ] }, "rows": { "type": "array", "items": { "type": "object", "properties": { "acquisitionSource": { "type": "string", "maxLength": 256 }, "email": { "$ref": "#/$defs/EmailAddress" }, "firstName": { "type": "string", "maxLength": 256 }, "lastName": { "type": "string", "maxLength": 256 }, "company": { "type": "string", "maxLength": 256 }, "city": { "type": "string", "maxLength": 256 }, "state": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "maxLength": 256 }, "customFields": { "$ref": "#/$defs/LeadCustomFieldValues" }, "emails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" } }, "phones": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "ladder": { "type": "string", "maxLength": 256 }, "rank": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "email", "firstName", "lastName" ], "patternProperties": { "^(?!(?:acquisitionSource|email|firstName|lastName|company|city|state|country|customFields|emails|phones|ladder|rank)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "acquisitionSource", "email", "firstName", "lastName", "company", "city", "state", "country", "customFields", "emails", "phones", "ladder", "rank" ] } }, "maxItems": 10000 }, "leads": { "type": "array", "items": { "type": "object", "properties": { "acquisitionSource": { "type": "string", "maxLength": 256 }, "email": { "$ref": "#/$defs/NonEmptyString" }, "firstName": { "type": "string", "maxLength": 256 }, "lastName": { "type": "string", "maxLength": 256 }, "company": { "type": "string", "maxLength": 256 }, "city": { "type": "string", "maxLength": 256 }, "state": { "type": "string", "maxLength": 256 }, "country": { "type": "string", "maxLength": 256 }, "customFieldValues": { "$ref": "#/$defs/LeadCustomFieldValues" }, "emails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" } }, "phones": { "type": "array", "items": { "$ref": "#/$defs/LeadPhoneValue" } }, "ladder": { "$ref": "#/$defs/ShortText" }, "rank": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "email", "firstName", "lastName" ], "patternProperties": { "^(?!(?:acquisitionSource|email|firstName|lastName|company|city|state|country|customFieldValues|emails|phones|ladder|rank)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "acquisitionSource", "email", "firstName", "lastName", "company", "city", "state", "country", "customFieldValues", "emails", "phones", "ladder", "rank" ] } }, "maxItems": 10000 }, "syncToAttio": { "type": "boolean" } }, "required": [ "workspaceId", "leadListId", "action" ], "patternProperties": { "^(?!(?:workspaceId|leadListId|action|rows|leads|syncToAttio)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "leadListId", "action", "rows", "leads", "syncToAttio" ] }, "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "LeadCustomFieldValues": { "type": "object", "additionalProperties": true }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "LeadPhoneValue": { "type": "string", "minLength": 2, "maxLength": 32, "pattern": "^\\+?[0-9]+(;ext=[0-9]+)?$" } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "imported" ], "patternProperties": { "^(?!(?:imported)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "imported" ] } ] } }, { "type": "object", "properties": { "created": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "created" ], "patternProperties": { "^(?!(?:created)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "created" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "imported" ], "patternProperties": { "^(?!(?:imported)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "imported" ] } ] } }, { "type": "object", "properties": { "created": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "created" ], "patternProperties": { "^(?!(?:created)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "created" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `leads.import`: `POST /v1/workspaces/:workspaceId/leads/import` - `leads.bulkCreate`: `POST /v1/workspaces/:workspaceId/leads/bulk` ## inspect_billing Read an Organization's subscription (plan, status, seats, billing period, pending cancellation, frozen state, and plan limits). Use to answer what plan a customer is on, why a workspace is frozen, or what it is entitled to. Do not use it to change the plan or cancel; those need a person. Use the product-specific retention eligibility tools when a person asks about an offboarding offer. A Workspace id resolves to its parent billing Organization. Scopes: billing:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "action": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "subscription" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] } } ``` ### 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" }, "action": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "subscription" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "subscriptions": { "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" }, "plan": { "type": "string", "enum": [ "trial", "starter", "growth", "pro" ] }, "status": { "type": "string", "enum": [ "incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid", "paused", "frozen" ] }, "billingCycle": { "anyOf": [ { "type": "string", "enum": [ "monthly", "annual" ] }, { "type": "null" } ] }, "seats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trialStart": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "trialEnd": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cancelAtPeriodEnd": { "type": "boolean" }, "pastDueSince": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "stripeSubscriptionId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "priceId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "frozen": { "type": "boolean" }, "limits": { "anyOf": [ { "type": "object", "properties": { "maxEmailsPerMonth": { "type": "integer", "minimum": -1 }, "maxInboxes": { "type": "integer", "minimum": -1 }, "maxCampaigns": { "type": "integer", "minimum": -1 }, "maxContactsPerCampaign": { "type": "integer", "minimum": -1 }, "whiteLabelEnabled": { "type": "boolean" }, "prioritySupport": { "type": "boolean" }, "warmupPoolTier": { "type": "string", "enum": [ "standard", "premium" ] }, "maxWarmupEmailsPerDay": { "type": "integer", "minimum": -1 }, "maxWarmupInboxes": { "type": "integer", "minimum": -1 }, "privatePoolEnabled": { "type": "boolean" }, "dedicatedEgressEnabled": { "type": "boolean" }, "maxActiveEgressIps": { "type": "integer", "minimum": -1 }, "egressInfrastructureBudgetCents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "byokEnabled": { "type": "boolean" }, "fullMailboxSyncEnabled": { "type": "boolean" } }, "required": [ "maxEmailsPerMonth", "maxInboxes", "maxCampaigns", "maxContactsPerCampaign", "whiteLabelEnabled", "prioritySupport", "warmupPoolTier", "maxWarmupEmailsPerDay", "maxWarmupInboxes", "privatePoolEnabled", "dedicatedEgressEnabled", "maxActiveEgressIps", "egressInfrastructureBudgetCents", "byokEnabled", "fullMailboxSyncEnabled" ], "patternProperties": { "^(?!(?:maxEmailsPerMonth|maxInboxes|maxCampaigns|maxContactsPerCampaign|whiteLabelEnabled|prioritySupport|warmupPoolTier|maxWarmupEmailsPerDay|maxWarmupInboxes|privatePoolEnabled|dedicatedEgressEnabled|maxActiveEgressIps|egressInfrastructureBudgetCents|byokEnabled|fullMailboxSyncEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "maxEmailsPerMonth", "maxInboxes", "maxCampaigns", "maxContactsPerCampaign", "whiteLabelEnabled", "prioritySupport", "warmupPoolTier", "maxWarmupEmailsPerDay", "maxWarmupInboxes", "privatePoolEnabled", "dedicatedEgressEnabled", "maxActiveEgressIps", "egressInfrastructureBudgetCents", "byokEnabled", "fullMailboxSyncEnabled" ] } }, { "type": "null" } ] } }, "required": [ "id", "plan", "status", "billingCycle", "seats", "trialStart", "trialEnd", "periodStart", "periodEnd", "cancelAtPeriodEnd", "pastDueSince", "stripeCustomerId", "stripeSubscriptionId", "priceId", "frozen", "limits" ], "patternProperties": { "^(?!(?:id|plan|status|billingCycle|seats|trialStart|trialEnd|periodStart|periodEnd|cancelAtPeriodEnd|pastDueSince|stripeCustomerId|stripeSubscriptionId|priceId|frozen|limits)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "plan", "status", "billingCycle", "seats", "trialStart", "trialEnd", "periodStart", "periodEnd", "cancelAtPeriodEnd", "pastDueSince", "stripeCustomerId", "stripeSubscriptionId", "priceId", "frozen", "limits" ] } }, "maxItems": 20 } }, "required": [ "subscriptions" ], "patternProperties": { "^(?!(?:subscriptions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "subscriptions" ] } ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Underlying API operations - `billing.getSubscription`: `GET /v1/organizations/:organizationId/billing/subscription` ## inspect_campaign Inspect a campaign's bounded projection and step summaries without sender credentials. Use first to learn the campaign's status, version, and step shape before validating or launching. Step content bodies and sender internals are never returned; do not probe for them. Scopes: campaign:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "campaignId": { "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", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId" ] } } ``` ### 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" }, "campaignId": { "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", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "campaign": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "kind": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "currentVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "status", "kind", "currentVersion", "inboxCount", "contactCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|status|pauseContext|kind|currentVersion|inboxCount|contactCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "status", "pauseContext", "kind", "currentVersion", "inboxCount", "contactCount", "createdAt", "updatedAt" ] } }, "steps": { "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" }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "enabled": { "type": "boolean" } }, "required": [ "id", "type", "enabled" ], "patternProperties": { "^(?!(?:id|type|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "enabled" ] } } } }, "required": [ "campaign", "steps" ], "patternProperties": { "^(?!(?:campaign|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaign", "steps" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `campaigns.get`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId` ## inspect_campaign_delivery Inspect delayed campaign sends, their outcomes, and individual delivery notices. Use to distinguish a pending delay from a final failure or unconfirmed result and to inspect source diagnostics before deciding whether to resume a held enrollment. Submission to an ESP or absence of a bounce does not prove delivery. This tool does not resume or resend messages. Scopes: campaign:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "list" ] }, "outcome": { "type": "string", "enum": [ "pending", "delivered", "failed", "unconfirmed" ] }, "cause": { "type": "string", "enum": [ "sender", "recipient", "unclassified" ] }, "failureCharacter": { "type": "string", "enum": [ "temporary", "permanent", "unknown" ] }, "sequenceDisposition": { "type": "string", "enum": [ "held", "continued", "resumed", "stopped" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope|outcome|cause|failureCharacter|sequenceDisposition|limit|offset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "outcome", "cause", "failureCharacter", "sequenceDisposition", "limit", "offset" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "summary" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "detail" ] }, "sendHistoryId": { "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" }, "evidenceOffset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "evidenceLimit": { "type": "integer", "minimum": 1, "maximum": 200 } }, "required": [ "workspaceId", "campaignId", "scope", "sendHistoryId" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope|sendHistoryId|evidenceOffset|evidenceLimit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "sendHistoryId", "evidenceOffset", "evidenceLimit" ] } } ] } ``` ### 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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "list" ] }, "outcome": { "type": "string", "enum": [ "pending", "delivered", "failed", "unconfirmed" ] }, "cause": { "type": "string", "enum": [ "sender", "recipient", "unclassified" ] }, "failureCharacter": { "type": "string", "enum": [ "temporary", "permanent", "unknown" ] }, "sequenceDisposition": { "type": "string", "enum": [ "held", "continued", "resumed", "stopped" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|outcome|cause|failureCharacter|sequenceDisposition|limit|offset)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "outcome", "cause", "failureCharacter", "sequenceDisposition", "limit", "offset" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "summary" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "detail" ] }, "sendHistoryId": { "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" }, "evidenceOffset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "evidenceLimit": { "type": "integer", "minimum": 1, "maximum": 200 } }, "required": [ "workspaceId", "campaignId", "scope", "sendHistoryId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|sendHistoryId|evidenceOffset|evidenceLimit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "sendHistoryId", "evidenceOffset", "evidenceLimit" ] }, { "enum": [ "workspaceId" ] } ] } } ] } ``` ### Output schema (structuredContent) ```json { "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "sendHistoryId": { "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" }, "campaignId": { "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" }, "campaignContactId": { "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" }, "recipientEmail": { "$ref": "#/$defs/EmailAddress" }, "pass": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outcome": { "type": "string", "enum": [ "pending", "delivered", "failed", "unconfirmed" ] }, "cause": { "type": "string", "enum": [ "sender", "recipient", "unclassified" ] }, "failureCharacter": { "type": "string", "enum": [ "temporary", "permanent", "unknown" ] }, "sequenceDisposition": { "anyOf": [ { "type": "string", "enum": [ "held", "continued", "resumed", "stopped" ] }, { "type": "null" } ] }, "firstDelayedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastEvidenceAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "monitoringEndsAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "providerRetryUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "confirmedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "outcomeAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "conflictingEvidence": { "type": "boolean" }, "canResume": { "type": "boolean" }, "canStop": { "type": "boolean" } }, "required": [ "sendHistoryId", "campaignId", "campaignContactId", "recipientEmail", "pass", "outcome", "cause", "failureCharacter", "sequenceDisposition", "firstDelayedAt", "lastEvidenceAt", "monitoringEndsAt", "providerRetryUntil", "confirmedAt", "outcomeAt", "conflictingEvidence", "canResume", "canStop" ], "patternProperties": { "^(?!(?:sendHistoryId|campaignId|campaignContactId|recipientEmail|pass|outcome|cause|failureCharacter|sequenceDisposition|firstDelayedAt|lastEvidenceAt|monitoringEndsAt|providerRetryUntil|confirmedAt|outcomeAt|conflictingEvidence|canResume|canStop)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sendHistoryId", "campaignId", "campaignContactId", "recipientEmail", "pass", "outcome", "cause", "failureCharacter", "sequenceDisposition", "firstDelayedAt", "lastEvidenceAt", "monitoringEndsAt", "providerRetryUntil", "confirmedAt", "outcomeAt", "conflictingEvidence", "canResume", "canStop" ] } } }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "total", "limit", "offset" ], "patternProperties": { "^(?!(?:items|total|limit|offset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "total", "limit", "offset" ] } }, { "type": "object", "properties": { "pending": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unconfirmed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "pending", "delivered", "failed", "unconfirmed", "total" ], "patternProperties": { "^(?!(?:pending|delivered|failed|unconfirmed|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "pending", "delivered", "failed", "unconfirmed", "total" ] } }, { "type": "object", "properties": { "delivery": { "type": "object", "properties": { "sendHistoryId": { "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" }, "campaignId": { "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" }, "campaignContactId": { "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" }, "recipientEmail": { "$ref": "#/$defs/EmailAddress" }, "pass": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outcome": { "type": "string", "enum": [ "pending", "delivered", "failed", "unconfirmed" ] }, "cause": { "type": "string", "enum": [ "sender", "recipient", "unclassified" ] }, "failureCharacter": { "type": "string", "enum": [ "temporary", "permanent", "unknown" ] }, "sequenceDisposition": { "anyOf": [ { "type": "string", "enum": [ "held", "continued", "resumed", "stopped" ] }, { "type": "null" } ] }, "firstDelayedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastEvidenceAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "monitoringEndsAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "providerRetryUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "confirmedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "outcomeAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "conflictingEvidence": { "type": "boolean" }, "canResume": { "type": "boolean" }, "canStop": { "type": "boolean" } }, "required": [ "sendHistoryId", "campaignId", "campaignContactId", "recipientEmail", "pass", "outcome", "cause", "failureCharacter", "sequenceDisposition", "firstDelayedAt", "lastEvidenceAt", "monitoringEndsAt", "providerRetryUntil", "confirmedAt", "outcomeAt", "conflictingEvidence", "canResume", "canStop" ], "patternProperties": { "^(?!(?:sendHistoryId|campaignId|campaignContactId|recipientEmail|pass|outcome|cause|failureCharacter|sequenceDisposition|firstDelayedAt|lastEvidenceAt|monitoringEndsAt|providerRetryUntil|confirmedAt|outcomeAt|conflictingEvidence|canResume|canStop)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sendHistoryId", "campaignId", "campaignContactId", "recipientEmail", "pass", "outcome", "cause", "failureCharacter", "sequenceDisposition", "firstDelayedAt", "lastEvidenceAt", "monitoringEndsAt", "providerRetryUntil", "confirmedAt", "outcomeAt", "conflictingEvidence", "canResume", "canStop" ] } }, "evidence": { "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" }, "action": { "type": "string", "enum": [ "delayed", "delivered", "failed", "relayed", "expanded", "unknown" ] }, "source": { "type": "string" }, "sourceMessageId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "diagnostic": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "statusCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipientEmail": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "observedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "occurredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "failureCharacter": { "type": "string", "enum": [ "temporary", "permanent", "unknown" ] }, "cause": { "type": "string", "enum": [ "sender", "recipient", "unclassified" ] }, "providerRetryUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "sourceComplete": { "type": "boolean" } }, "required": [ "id", "action", "source", "sourceMessageId", "diagnostic", "statusCode", "recipientEmail", "observedAt", "occurredAt", "failureCharacter", "cause", "providerRetryUntil", "sourceComplete" ], "patternProperties": { "^(?!(?:id|action|source|sourceMessageId|diagnostic|statusCode|recipientEmail|observedAt|occurredAt|failureCharacter|cause|providerRetryUntil|sourceComplete)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "action", "source", "sourceMessageId", "diagnostic", "statusCode", "recipientEmail", "observedAt", "occurredAt", "failureCharacter", "cause", "providerRetryUntil", "sourceComplete" ] } } }, "evidenceTotal": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "evidenceOffset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "evidenceNextOffset": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "delivery", "evidence", "evidenceTotal", "evidenceOffset", "evidenceNextOffset" ], "patternProperties": { "^(?!(?:delivery|evidence|evidenceTotal|evidenceOffset|evidenceNextOffset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivery", "evidence", "evidenceTotal", "evidenceOffset", "evidenceNextOffset" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "sendHistoryId": { "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" }, "campaignId": { "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" }, "campaignContactId": { "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" }, "recipientEmail": { "$ref": "#/$defs/EmailAddress" }, "pass": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outcome": { "type": "string", "enum": [ "pending", "delivered", "failed", "unconfirmed" ] }, "cause": { "type": "string", "enum": [ "sender", "recipient", "unclassified" ] }, "failureCharacter": { "type": "string", "enum": [ "temporary", "permanent", "unknown" ] }, "sequenceDisposition": { "anyOf": [ { "type": "string", "enum": [ "held", "continued", "resumed", "stopped" ] }, { "type": "null" } ] }, "firstDelayedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastEvidenceAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "monitoringEndsAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "providerRetryUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "confirmedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "outcomeAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "conflictingEvidence": { "type": "boolean" }, "canResume": { "type": "boolean" }, "canStop": { "type": "boolean" } }, "required": [ "sendHistoryId", "campaignId", "campaignContactId", "recipientEmail", "pass", "outcome", "cause", "failureCharacter", "sequenceDisposition", "firstDelayedAt", "lastEvidenceAt", "monitoringEndsAt", "providerRetryUntil", "confirmedAt", "outcomeAt", "conflictingEvidence", "canResume", "canStop" ], "patternProperties": { "^(?!(?:sendHistoryId|campaignId|campaignContactId|recipientEmail|pass|outcome|cause|failureCharacter|sequenceDisposition|firstDelayedAt|lastEvidenceAt|monitoringEndsAt|providerRetryUntil|confirmedAt|outcomeAt|conflictingEvidence|canResume|canStop)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sendHistoryId", "campaignId", "campaignContactId", "recipientEmail", "pass", "outcome", "cause", "failureCharacter", "sequenceDisposition", "firstDelayedAt", "lastEvidenceAt", "monitoringEndsAt", "providerRetryUntil", "confirmedAt", "outcomeAt", "conflictingEvidence", "canResume", "canStop" ] } } }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "total", "limit", "offset" ], "patternProperties": { "^(?!(?:items|total|limit|offset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "total", "limit", "offset" ] } }, { "type": "object", "properties": { "pending": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unconfirmed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "pending", "delivered", "failed", "unconfirmed", "total" ], "patternProperties": { "^(?!(?:pending|delivered|failed|unconfirmed|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "pending", "delivered", "failed", "unconfirmed", "total" ] } }, { "type": "object", "properties": { "delivery": { "type": "object", "properties": { "sendHistoryId": { "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" }, "campaignId": { "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" }, "campaignContactId": { "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" }, "recipientEmail": { "$ref": "#/$defs/EmailAddress" }, "pass": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outcome": { "type": "string", "enum": [ "pending", "delivered", "failed", "unconfirmed" ] }, "cause": { "type": "string", "enum": [ "sender", "recipient", "unclassified" ] }, "failureCharacter": { "type": "string", "enum": [ "temporary", "permanent", "unknown" ] }, "sequenceDisposition": { "anyOf": [ { "type": "string", "enum": [ "held", "continued", "resumed", "stopped" ] }, { "type": "null" } ] }, "firstDelayedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastEvidenceAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "monitoringEndsAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "providerRetryUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "confirmedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "outcomeAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "conflictingEvidence": { "type": "boolean" }, "canResume": { "type": "boolean" }, "canStop": { "type": "boolean" } }, "required": [ "sendHistoryId", "campaignId", "campaignContactId", "recipientEmail", "pass", "outcome", "cause", "failureCharacter", "sequenceDisposition", "firstDelayedAt", "lastEvidenceAt", "monitoringEndsAt", "providerRetryUntil", "confirmedAt", "outcomeAt", "conflictingEvidence", "canResume", "canStop" ], "patternProperties": { "^(?!(?:sendHistoryId|campaignId|campaignContactId|recipientEmail|pass|outcome|cause|failureCharacter|sequenceDisposition|firstDelayedAt|lastEvidenceAt|monitoringEndsAt|providerRetryUntil|confirmedAt|outcomeAt|conflictingEvidence|canResume|canStop)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sendHistoryId", "campaignId", "campaignContactId", "recipientEmail", "pass", "outcome", "cause", "failureCharacter", "sequenceDisposition", "firstDelayedAt", "lastEvidenceAt", "monitoringEndsAt", "providerRetryUntil", "confirmedAt", "outcomeAt", "conflictingEvidence", "canResume", "canStop" ] } }, "evidence": { "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" }, "action": { "type": "string", "enum": [ "delayed", "delivered", "failed", "relayed", "expanded", "unknown" ] }, "source": { "type": "string" }, "sourceMessageId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "diagnostic": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "statusCode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipientEmail": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "observedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "occurredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "failureCharacter": { "type": "string", "enum": [ "temporary", "permanent", "unknown" ] }, "cause": { "type": "string", "enum": [ "sender", "recipient", "unclassified" ] }, "providerRetryUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "sourceComplete": { "type": "boolean" } }, "required": [ "id", "action", "source", "sourceMessageId", "diagnostic", "statusCode", "recipientEmail", "observedAt", "occurredAt", "failureCharacter", "cause", "providerRetryUntil", "sourceComplete" ], "patternProperties": { "^(?!(?:id|action|source|sourceMessageId|diagnostic|statusCode|recipientEmail|observedAt|occurredAt|failureCharacter|cause|providerRetryUntil|sourceComplete)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "action", "source", "sourceMessageId", "diagnostic", "statusCode", "recipientEmail", "observedAt", "occurredAt", "failureCharacter", "cause", "providerRetryUntil", "sourceComplete" ] } } }, "evidenceTotal": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "evidenceOffset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "evidenceNextOffset": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "delivery", "evidence", "evidenceTotal", "evidenceOffset", "evidenceNextOffset" ], "patternProperties": { "^(?!(?:delivery|evidence|evidenceTotal|evidenceOffset|evidenceNextOffset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivery", "evidence", "evidenceTotal", "evidenceOffset", "evidenceNextOffset" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaignDelivery.list`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/delivery` - `campaignDelivery.summary`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/delivery/summary` - `campaignDelivery.get`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/delivery/:sendHistoryId` ## inspect_dialer_retention_eligibility Read whether the dialer add-on is eligible for its one-time retention offer. Use when a person asks whether the named product has an offboarding discount available. This only reads eligibility. A person in the web app must accept an offer or cancel a product. Scopes: dialer:manage_billing Risk: read; confirmation: none; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "eligible": { "type": "boolean" }, "label": { "$ref": "#/$defs/ShortText" }, "discountPercent": { "type": "number", "enum": [ 30 ] }, "discountMonths": { "type": "number", "enum": [ 2 ] } }, "required": [ "eligible", "label", "discountPercent", "discountMonths" ], "patternProperties": { "^(?!(?:eligible|label|discountPercent|discountMonths)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "eligible", "label", "discountPercent", "discountMonths" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `billing.retentionEligibility`: `GET /v1/organizations/:organizationId/billing/retention-eligibility` ## inspect_domain_nameservers Read provider-assigned nameservers and recursive DNS evidence for one authorized Workspace domain. Inspect nameserver assignment coverage, stored DNS provider and observed NS values. This is read-only. Do not treat recursive DNS or a historical application timestamp as verified parent or registrar delegation. This cannot change nameservers or provision zones. Scopes: domain:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "hostname": { "type": "string", "maxLength": 253 } }, "required": [ "workspaceId", "hostname" ], "patternProperties": { "^(?!(?:workspaceId|hostname)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "hostname" ] } } ``` ### 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" }, "hostname": { "type": "string", "maxLength": 253 } }, "required": [ "workspaceId", "hostname" ], "patternProperties": { "^(?!(?:workspaceId|hostname)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "hostname" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "hostname": { "type": "string" }, "dnsProvider": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expected": { "type": "array", "items": { "type": "string" } }, "appliedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "observed": { "type": "array", "items": { "type": "string" } }, "observationSource": { "type": "string", "enum": [ "recursive_dns" ] }, "observationStatus": { "type": "string", "enum": [ "observed", "unavailable" ] }, "checkedAt": { "type": "string" }, "comparison": { "type": "string", "enum": [ "matches", "differs", "unknown" ] }, "delegation": { "type": "string", "enum": [ "unknown" ] }, "registrarDomainId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "hostname", "dnsProvider", "expected", "appliedAt", "observed", "observationSource", "observationStatus", "checkedAt", "comparison", "delegation", "registrarDomainId" ], "additionalProperties": true } ``` ### Underlying API operations - `infrastructure.nameservers`: `GET /v1/workspaces/:workspaceId/infrastructure/domains/:hostname/nameservers` ## inspect_infrastructure Inspect a workspace's domains, inboxes, issuing Google OAuth clients, evidenced Microsoft directory/client associations, API egress IPs, masking state and historical send coverage. Investigate current resource relationships or filter a dated campaign-send cohort by domain or recorded IP. Results are paginated, read-only and limited to the selected Workspace. Do not infer recipient-facing MTA reputation, historical OAuth identity, email delivery, or active masking from configuration. Never use current assignments to fill historical coverage gaps. Scopes: inbox:read, domain:read, analytics:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "view": { "type": "string", "enum": [ "domains", "inboxes", "oauth", "microsoft", "ips" ] }, "search": { "type": "string", "maxLength": 320 }, "domain": { "type": "string", "maxLength": 320 }, "ip": { "type": "string", "maxLength": 320 }, "client": { "type": "string", "maxLength": 320 }, "tenant": { "type": "string", "maxLength": 320 }, "inbox": { "type": "string", "maxLength": 320 }, "provider": { "type": "string", "enum": [ "", "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "maxLength": 320 }, "page": { "type": "integer", "minimum": 1, "maximum": 10000 }, "sort": { "type": "string", "enum": [ "name", "inboxes" ] }, "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "workspaceId", "view", "search", "domain", "ip", "client", "tenant", "inbox", "provider", "status", "page", "sort", "from", "to" ], "patternProperties": { "^(?!(?:workspaceId|view|search|domain|ip|client|tenant|inbox|provider|status|page|sort|from|to)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "view", "search", "domain", "ip", "client", "tenant", "inbox", "provider", "status", "page", "sort", "from", "to" ] } } ``` ### 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" }, "view": { "type": "string", "enum": [ "domains", "inboxes", "oauth", "microsoft", "ips" ] }, "search": { "type": "string", "maxLength": 320 }, "domain": { "type": "string", "maxLength": 320 }, "ip": { "type": "string", "maxLength": 320 }, "client": { "type": "string", "maxLength": 320 }, "tenant": { "type": "string", "maxLength": 320 }, "inbox": { "type": "string", "maxLength": 320 }, "provider": { "type": "string", "enum": [ "", "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "maxLength": 320 }, "page": { "type": "integer", "minimum": 1, "maximum": 10000 }, "sort": { "type": "string", "enum": [ "name", "inboxes" ] }, "from": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "to": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "required": [ "workspaceId", "view", "search", "domain", "ip", "client", "tenant", "inbox", "provider", "status", "page", "sort", "from", "to" ], "patternProperties": { "^(?!(?:workspaceId|view|search|domain|ip|client|tenant|inbox|provider|status|page|sort|from|to)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "view", "search", "domain", "ip", "client", "tenant", "inbox", "provider", "status", "page", "sort", "from", "to" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "inboxCount": { "type": "integer" }, "domainCount": { "type": "integer" }, "domains": { "type": "array", "items": { "type": "string" } }, "providers": { "type": "array", "items": { "type": "string" } }, "statuses": { "type": "array", "items": { "type": "string" } }, "routes": { "type": "array", "items": { "type": "string" } }, "ips": { "type": "array", "items": { "type": "string" } }, "clients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "publicClientId": { "type": "string" }, "name": { "type": "string" }, "projectNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "serviceClass": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "publicClientId", "name", "projectNumber", "serviceClass", "status" ], "additionalProperties": true } }, "microsoftTenants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "entraTenantId": { "type": "string" }, "displayName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "active", "draining", "disabled", "retired" ] } }, "required": [ "id", "entraTenantId", "displayName", "status" ], "additionalProperties": true } }, "microsoftClientIds": { "type": "array", "items": { "type": "string" } }, "microsoftInboxCount": { "type": "integer" }, "unknownMicrosoftTenants": { "type": "integer" }, "unknownMicrosoftClients": { "type": "integer" }, "microsoftTenantVerifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "boundaryId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "boundaryStatus": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "desiredClientId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reconsentRequired": { "type": "boolean" }, "masking": { "anyOf": [ { "type": "object", "properties": { "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "desiredRevision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "activeRevision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "activeProvider": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "activeMode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "activeTarget": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "websiteRouteId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phase": { "type": "string", "enum": [ "not_configured", "waiting_dns", "waiting_tls", "waiting_publication", "active", "degraded", "retired", "needs_attention", "published_unverified", "unknown" ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "ownership_required", "certificate_pending", "certificate_failed", "route_pending", "dns_pending", "health_mismatch", "origin_unavailable", "origin_redirects", "provider_unavailable", "provider_drift", "retiring", "provider_managed_dns", "deployment_unconfigured", "reconcile_failed" ] }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "registrarDomainId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "provider", "mode", "target", "desiredRevision", "activeRevision", "activeProvider", "activeMode", "activeTarget", "checkedAt", "websiteRouteId", "phase", "reason", "updatedAt", "registrarDomainId" ], "additionalProperties": true }, { "type": "null" } ] } }, "required": [ "key", "label", "inboxCount", "domainCount", "domains", "providers", "statuses", "routes", "ips", "clients", "microsoftTenants", "microsoftClientIds", "microsoftInboxCount", "unknownMicrosoftTenants", "unknownMicrosoftClients", "microsoftTenantVerifiedAt", "boundaryId", "boundaryStatus", "desiredClientId", "reconsentRequired", "masking" ], "additionalProperties": true } }, "total": { "type": "integer" }, "pageSize": { "type": "integer" }, "metrics": { "type": "object", "properties": { "cohortSent": { "type": "integer" }, "missingRoute": { "type": "integer" }, "missingDomain": { "type": "integer" }, "sent": { "type": "integer" }, "contacted": { "type": "integer" }, "bounced": { "type": "integer" }, "allReplies": { "type": "integer" }, "humanReplies": { "type": "integer" }, "positiveReplies": { "type": "integer" }, "outOfOffice": { "type": "integer" }, "automaticReplies": { "type": "integer" }, "ipAttributed": { "type": "integer" }, "domainAttributed": { "type": "integer" }, "direct": { "type": "integer" }, "unknownRoute": { "type": "integer" }, "failedAttempts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "unknownAttempts": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "cohortSent", "missingRoute", "missingDomain", "sent", "contacted", "bounced", "allReplies", "humanReplies", "positiveReplies", "outOfOffice", "automaticReplies", "ipAttributed", "domainAttributed", "direct", "unknownRoute", "failedAttempts", "unknownAttempts" ], "additionalProperties": true }, "history": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "occurredAt": { "type": "string" }, "kind": { "type": "string" }, "resource": { "type": "string" }, "detail": { "type": "string" }, "actor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "occurredAt", "kind", "resource", "detail", "actor", "reason" ], "additionalProperties": true } }, "historyLimited": { "type": "boolean" } }, "required": [ "rows", "total", "pageSize", "metrics", "history", "historyLimited" ], "additionalProperties": true } ``` ### Underlying API operations - `infrastructure.explore`: `POST /v1/workspaces/:workspaceId/infrastructure/explore` ## inspect_scheduler_retention_eligibility Read whether the Scheduler Zero subscription is eligible for its one-time retention offer. Use when a person asks whether the named product has an offboarding discount available. This only reads eligibility. A person in the web app must accept an offer or cancel a product. Scopes: billing:manage Risk: read; confirmation: none; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "eligible": { "type": "boolean" }, "label": { "$ref": "#/$defs/ShortText" }, "discountPercent": { "type": "number", "enum": [ 30 ] }, "discountMonths": { "type": "number", "enum": [ 2 ] } }, "required": [ "eligible", "label", "discountPercent", "discountMonths" ], "patternProperties": { "^(?!(?:eligible|label|discountPercent|discountMonths)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "eligible", "label", "discountPercent", "discountMonths" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `billing.retentionEligibility`: `GET /v1/organizations/:organizationId/billing/retention-eligibility` ## invite_members Invite people to an Organization and/or its Workspaces with grants the caller holds; list, re-send, or revoke invitations. Call options first to see grantable roles and Workspaces, then invite; list shows status (accepted means joined). Never grants more than the caller holds, and cannot accept on the invitee's behalf; the invitee accepts from the email. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: orgMember:invite, orgMember:read, workspaceMember:invite, workspaceMember:read Risk: write; confirmation: explicit; idempotency: required. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "options" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "invite" ] } ] }, "organizationId": { "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" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } } }, "required": [ "action", "organizationId", "email", "grants" ], "patternProperties": { "^(?!(?:action|organizationId|email|grants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "email", "grants" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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" }, "includeExpired": { "type": "boolean" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId|includeExpired)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "includeExpired" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resend" ] } ] }, "organizationId": { "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" }, "invitationId": { "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", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "revoke" ] } ] }, "organizationId": { "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" }, "invitationId": { "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", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } } ], "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "RoleId": { "type": "string", "minLength": 1, "maxLength": 512 }, "InviteMembersInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "options" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "invite" ] } ] }, "organizationId": { "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" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } } }, "required": [ "action", "organizationId", "email", "grants" ], "patternProperties": { "^(?!(?:action|organizationId|email|grants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "email", "grants" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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" }, "includeExpired": { "type": "boolean" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId|includeExpired)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "includeExpired" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resend" ] } ] }, "organizationId": { "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" }, "invitationId": { "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", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "revoke" ] } ] }, "organizationId": { "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" }, "invitationId": { "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", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } } ] } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "options" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "invite" ] } ] }, "organizationId": { "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" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } } }, "required": [ "action", "organizationId", "email", "grants" ], "patternProperties": { "^(?!(?:action|organizationId|email|grants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "email", "grants" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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" }, "includeExpired": { "type": "boolean" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId|includeExpired)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "includeExpired" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resend" ] } ] }, "organizationId": { "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" }, "invitationId": { "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", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "revoke" ] } ] }, "organizationId": { "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" }, "invitationId": { "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", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } } ], "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "RoleId": { "type": "string", "minLength": 1, "maxLength": 512 }, "InviteMembersInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "options" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "invite" ] } ] }, "organizationId": { "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" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } } }, "required": [ "action", "organizationId", "email", "grants" ], "patternProperties": { "^(?!(?:action|organizationId|email|grants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "email", "grants" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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" }, "includeExpired": { "type": "boolean" } }, "required": [ "action", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId|includeExpired)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "includeExpired" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resend" ] } ] }, "organizationId": { "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" }, "invitationId": { "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", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "revoke" ] } ] }, "organizationId": { "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" }, "invitationId": { "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", "organizationId", "invitationId" ], "patternProperties": { "^(?!(?:action|organizationId|invitationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "invitationId" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "RoleId": { "type": "string", "minLength": 1, "maxLength": 512 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "InviteMembersOutput": { "anyOf": [ { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "$ref": "#/$defs/ShortText" }, "organization": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, { "type": "null" } ] }, "allWorkspaces": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "permissions": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } } }, "required": [ "workspaceId", "name", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|name|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "name", "permissions" ] } } }, "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/RoleId" }, "name": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "organization", "workspace" ] }, "system": { "type": "boolean" }, "permissions": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } } }, "required": [ "id", "name", "scope", "system", "permissions" ], "patternProperties": { "^(?!(?:id|name|scope|system|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "scope", "system", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organization", "allWorkspaces", "workspaces", "roles" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organization|allWorkspaces|workspaces|roles)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organization", "allWorkspaces", "workspaces", "roles" ] } }, { "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" }, "organizationId": { "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" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expired": { "type": "boolean" }, "invitedByUserId": { "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" }, "resendCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastSentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "organizationId", "email", "grants", "status", "expiresAt", "expired", "invitedByUserId", "resendCount", "lastSentAt", "createdAt" ], "patternProperties": { "^(?!(?:id|organizationId|email|grants|status|expiresAt|expired|invitedByUserId|resendCount|lastSentAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "organizationId", "email", "grants", "status", "expiresAt", "expired", "invitedByUserId", "resendCount", "lastSentAt", "createdAt" ] } }, { "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" }, "organizationId": { "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" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grants": { "type": "object", "properties": { "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 64 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions" ] } } }, "required": [ "roles", "directPermissions" ], "patternProperties": { "^(?!(?:roles|directPermissions|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "directPermissions", "allWorkspaces" ] } }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "directPermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 256 } }, "required": [ "workspaceId", "roles", "directPermissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|directPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "directPermissions" ] } }, "maxItems": 100 } }, "required": [ "workspaces" ], "patternProperties": { "^(?!(?:organization|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organization", "workspaces" ] } }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expired": { "type": "boolean" }, "invitedByUserId": { "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" }, "resendCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastSentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "organizationId", "email", "grants", "status", "expiresAt", "expired", "invitedByUserId", "resendCount", "lastSentAt", "createdAt" ], "patternProperties": { "^(?!(?:id|organizationId|email|grants|status|expiresAt|expired|invitedByUserId|resendCount|lastSentAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "organizationId", "email", "grants", "status", "expiresAt", "expired", "invitedByUserId", "resendCount", "lastSentAt", "createdAt" ] } } }, { "type": "object", "properties": { "revoked": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "revoked" ], "patternProperties": { "^(?!(?:revoked)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "revoked" ] } ] } } ] } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/InviteMembersOutput" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/InviteMembersOutput" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `organizationInvitations.options`: `GET /v1/organizations/:organizationId/invitations/options` - `organizationInvitations.create`: `POST /v1/organizations/:organizationId/invitations` - `organizationInvitations.list`: `GET /v1/organizations/:organizationId/invitations` - `organizationInvitations.resend`: `POST /v1/organizations/:organizationId/invitations/:invitationId/resend` - `organizationInvitations.revoke`: `DELETE /v1/organizations/:organizationId/invitations/:invitationId` ## launch_campaign Launch a draft campaign: preview binds the exact version and input hash, commit activates the campaign in-request and returns an already-succeeded operation handle. Use to start sending for a draft campaign after inspect_campaign and validate_campaign pass. Never launch without a preview token, and never reuse one after the campaign changed or the token expired. Use the native preview first and pass its confirmation token unchanged to commit. A token does not bypass current permissions or Workspace checks. Scopes: campaign:launch Risk: costly; confirmation: preview_token; idempotency: required. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "preview" ] }, "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" }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "commit" ] }, "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" }, "campaignId": { "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" }, "confirmationToken": { "type": "string" } }, "required": [ "action", "workspaceId", "campaignId", "confirmationToken" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "confirmationToken" ] } } ] } ``` ### 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": [ "preview" ] }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] }, { "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": [ "commit" ] }, "campaignId": { "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" }, "confirmationToken": { "type": "string" } }, "required": [ "action", "workspaceId", "campaignId", "confirmationToken" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|confirmationToken)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "confirmationToken" ] }, { "enum": [ "workspaceId" ] } ] } } ] } ``` ### Output schema (structuredContent) ```json { "$defs": { "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Money": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XCG", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWG" ] } }, "required": [ "amountMinor", "currency" ], "patternProperties": { "^(?!(?:amountMinor|currency)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "amountMinor", "currency" ] } }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "campaignId": { "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" }, "campaignVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "campaignId", "campaignVersion", "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:campaignId|campaignVersion|preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "campaignVersion", "preview", "confirmationToken" ] } }, { "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": { "campaignId": { "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" }, "campaignVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "campaignId", "campaignVersion", "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:campaignId|campaignVersion|preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "campaignVersion", "preview", "confirmationToken" ] } }, { "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 - `campaigns.previewLaunch`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/launch-preview` - `campaigns.launch`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/launch` ## list_booking_event_types List a connected provider's bookable event types so one can be chosen as the default. Use before set_booking_default_event_type to obtain a valid `eventTypeRef` and the current connection id. Do not call it on a provider the workspace has not connected; that is a not-found, not an empty list. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] } }, "required": [ "workspaceId", "provider" ], "patternProperties": { "^(?!(?:workspaceId|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider" ] } } ``` ### 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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] } }, "required": [ "workspaceId", "provider" ], "patternProperties": { "^(?!(?:workspaceId|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "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" }, "eventTypes": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "ref": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ShortText" }, "durationMinutes": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "schedulingUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "active": { "type": "boolean" } }, "required": [ "provider", "ref", "name", "durationMinutes", "schedulingUrl", "active" ], "patternProperties": { "^(?!(?:provider|ref|name|durationMinutes|schedulingUrl|active)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "ref", "name", "durationMinutes", "schedulingUrl", "active" ] } }, "maxItems": 200 } }, "required": [ "provider", "connectionId", "eventTypes" ], "patternProperties": { "^(?!(?:provider|connectionId|eventTypes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connectionId", "eventTypes" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } } } ``` ### Underlying API operations - `booking.eventTypes.list`: `GET /v1/workspaces/:workspaceId/booking/:provider/event-types` ## list_capabilities List capabilities with per-actor availability, scopes, confirmation policy, and bounded hints. Use to discover what this credential can actually run right now, filtered by feature, risk, or availability. Availability is computed per request; do not cache it across credential or consent changes. Scopes: agent:capabilities Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "feature": { "$ref": "#/$defs/NonEmptyString" }, "risk": { "type": "string", "enum": [ "read", "write", "costly", "destructive", "security_admin" ] }, "availability": { "type": "string", "enum": [ "available", "scope_required", "permission_denied", "feature_disabled", "subscription_blocked", "human_completion_required", "temporarily_unavailable" ] } }, "patternProperties": { "^(?!(?:cursor|limit|feature|risk|availability)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit", "feature", "risk", "availability" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "feature": { "$ref": "#/$defs/NonEmptyString" }, "risk": { "type": "string", "enum": [ "read", "write", "costly", "destructive", "security_admin" ] }, "availability": { "type": "string", "enum": [ "available", "scope_required", "permission_denied", "feature_disabled", "subscription_blocked", "human_completion_required", "temporarily_unavailable" ] } }, "patternProperties": { "^(?!(?:cursor|limit|feature|risk|availability)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit", "feature", "risk", "availability" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "feature": { "$ref": "#/$defs/NonEmptyString" }, "purpose": { "$ref": "#/$defs/Description" }, "prerequisites": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "kind": { "type": "string", "enum": [ "direct_tool", "mcp_resource", "async_operation", "preview_commit", "user_completion", "human_only" ] }, "risk": { "type": "string", "enum": [ "read", "write", "costly", "destructive", "security_admin" ] }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "agent:capabilities", "agent:identity", "agent:operations:cancel", "agent:operations:read", "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "audit:read", "billing:manage", "billing:read", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "platform:operate", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "role:manage", "role:read", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "usage:read", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:create", "workspace:delete", "workspace:read", "workspace:transfer", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "confirmation": { "type": "string", "enum": [ "none", "explicit", "preview_token", "human_completion" ] }, "resultMode": { "type": "string", "enum": [ "inline", "page", "operation_handle", "stream", "download", "redirect" ] }, "availability": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "available", "scope_required", "permission_denied", "feature_disabled", "subscription_blocked", "human_completion_required", "temporarily_unavailable" ] }, "reason": { "$ref": "#/$defs/ShortText" } }, "required": [ "state" ], "patternProperties": { "^(?!(?:state|reason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "reason" ] } }, "inputFields": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "outputBounds": { "type": "object", "properties": { "maxItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxBytes": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "maxItems", "maxBytes" ], "patternProperties": { "^(?!(?:maxItems|maxBytes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "maxItems", "maxBytes" ] } }, "bundles": { "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } } }, "required": [ "id", "feature", "purpose", "prerequisites", "kind", "risk", "scopes", "confirmation", "resultMode", "availability", "inputFields", "outputBounds", "bundles" ], "patternProperties": { "^(?!(?:id|feature|purpose|prerequisites|kind|risk|scopes|confirmation|resultMode|availability|inputFields|outputBounds|bundles)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "feature", "purpose", "prerequisites", "kind", "risk", "scopes", "confirmation", "resultMode", "availability", "inputFields", "outputBounds", "bundles" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] }, "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Underlying API operations - `agent.listCapabilities`: `GET /agent/capabilities` ## list_capability_bundles List curated capability bundles so an agent can adopt a focused tool set instead of the whole catalog. Use at session start to choose the smallest bundle set covering the task at hand. Bundles are discovery metadata; they never grant authority the credential's scopes do not. Scopes: agent:capabilities Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "patternProperties": { "^(?!(?:cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "patternProperties": { "^(?!(?:cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "title": { "$ref": "#/$defs/ShortText" }, "capabilities": { "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } } }, "required": [ "id", "title", "capabilities" ], "patternProperties": { "^(?!(?:id|title|capabilities)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "title", "capabilities" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Underlying API operations - `agent.listCapabilityBundles`: `GET /agent/capability-bundles` ## list_dashboards List the complete saved dashboards and saved queries visible in this Workspace. Use before creating reporting documents or to find the dashboardId and revision to edit. Requires the Workspace SQL feature and the stated permission. This does not grant access to another Workspace or execute stored SQL automatically. Scopes: sql:query Risk: read; confirmation: none; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "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" }, "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" }, "ownerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedAt": { "type": "string" }, "document": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "kind": { "type": "string", "enum": [ "dashboard", "query" ] }, "name": { "type": "string", "maxLength": 160, "minLength": 1 }, "description": { "type": "string", "maxLength": 2000 }, "filters": { "type": "object", "properties": { "from": { "type": "string", "maxLength": 40 }, "to": { "type": "string", "maxLength": 40 }, "domain": { "type": "string", "maxLength": 253 }, "ip": { "type": "string", "maxLength": 64 }, "source": { "type": "string", "maxLength": 256 } }, "required": [ "from", "to", "domain", "ip", "source" ], "patternProperties": { "^(?!(?:from|to|domain|ip|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] } }, "widgets": { "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" }, "kind": { "type": "string", "enum": [ "chart", "text" ] }, "title": { "type": "string", "maxLength": 160 }, "text": { "type": "string", "maxLength": 4000 }, "query": { "type": "string", "maxLength": 20000 }, "bindings": { "type": "array", "items": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] }, "maxItems": 32 }, "chart": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "table", "number", "line", "area", "bar" ] }, "dimension": { "type": "string", "maxLength": 128 }, "measures": { "type": "array", "items": { "type": "string", "maxLength": 128 }, "maxItems": 8 }, "format": { "type": "string", "enum": [ "number", "percent", "currency", "duration", "bytes" ] }, "decimals": { "type": "integer", "minimum": 0, "maximum": 6 }, "label": { "type": "string", "maxLength": 128 } }, "required": [ "type", "dimension", "measures", "format", "decimals", "label" ], "patternProperties": { "^(?!(?:type|dimension|measures|format|decimals|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "dimension", "measures", "format", "decimals", "label" ] } }, "layout": { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 500 }, "w": { "type": "integer", "minimum": 2, "maximum": 12 }, "h": { "type": "integer", "minimum": 2, "maximum": 12 } }, "required": [ "x", "y", "w", "h" ], "patternProperties": { "^(?!(?:x|y|w|h)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y", "w", "h" ] } } }, "required": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ], "patternProperties": { "^(?!(?:id|kind|title|text|query|bindings|chart|layout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ] } }, "maxItems": 30 } }, "required": [ "version", "kind", "name", "description", "filters", "widgets" ], "patternProperties": { "^(?!(?:version|kind|name|description|filters|widgets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "kind", "name", "description", "filters", "widgets" ] } } }, "required": [ "id", "workspaceId", "ownerId", "revision", "updatedAt", "document" ], "patternProperties": { "^(?!(?:id|workspaceId|ownerId|revision|updatedAt|document)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "ownerId", "revision", "updatedAt", "document" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } ``` ### Underlying API operations - `dashboards.list`: `GET /v1/workspaces/:workspaceId/dashboards` ## list_integration_connections List every provider connection in the workspace — CRM, outreach, enrichment, scheduling, and workflow connectors — with status and health. Use to learn which integrations are connected before choosing a provider-specific capability. The catalog never calls a provider; use the provider's own status capability for live detail. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "provider": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,63}$" }, "displayName": { "$ref": "#/$defs/ShortText" }, "category": { "type": "string", "enum": [ "crm", "outreach", "enrichment", "scheduling", "workflow_connector" ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "connected", "needs_reauthorization", "disabled", "disconnected" ] }, { "type": "null" } ] }, "connectionId": { "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" } ] }, "label": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "health": { "type": "string", "enum": [ "ok", "degraded", "needs_reauthorization", "disconnected", "unknown" ] }, "capabilities": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" }, "maxItems": 20 }, "connectedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "provider", "displayName", "category", "status", "connectionId", "label", "health", "capabilities", "connectedAt", "lastValidatedAt" ], "patternProperties": { "^(?!(?:provider|displayName|category|status|connectionId|label|health|capabilities|connectedAt|lastValidatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "displayName", "category", "status", "connectionId", "label", "health", "capabilities", "connectedAt", "lastValidatedAt" ] } }, "maxItems": 200 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `integrationCatalog.list`: `GET /v1/workspaces/:workspaceId/integrations` ## list_integration_shares List connections this workspace shares with sibling workspaces and connections shared into it. Use before sharing, detaching, or troubleshooting a connection that came from another workspace. Use list_integration_connections for connection health; this lists sharing relationships only. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "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" }, "adapter": { "$ref": "#/$defs/IntegrationShareAdapter" }, "provider": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,63}$" }, "displayName": { "$ref": "#/$defs/ShortText" }, "role": { "type": "string", "enum": [ "source", "target" ] }, "sourceWorkspaceId": { "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" }, "sourceWorkspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "sourceConnectionId": { "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" }, "sourceConnected": { "type": "boolean" }, "includeFutureWorkspaces": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "attaching", "attached", "detached", "failed" ] }, "connectionId": { "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" } ] }, "failureReason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "attachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "detachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|state|connectionId|failureReason|attachedAt|detachedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ] } }, "maxItems": 500 } }, "required": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ], "patternProperties": { "^(?!(?:id|adapter|provider|displayName|role|sourceWorkspaceId|sourceWorkspaceName|sourceConnectionId|sourceConnected|includeFutureWorkspaces|createdAt|revokedAt|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ] } }, "maxItems": 500 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] }, "$defs": { "IntegrationShareAdapter": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer", "heyreach", "getleads", "plusvibe", "calendly", "cal_com", "attio", "email_verifier", "phone_verifier", "warmup_provider", "mcp_server", "app_connection" ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `integrationShares.list`: `GET /v1/workspaces/:workspaceId/integration-shares` ## list_organization_dashboards List the complete saved dashboards and saved queries owned by this Organization. Use before creating reporting documents or to find the dashboardId and revision to edit. Requires the stated Organization analytics permission. Reading a document never executes its SQL; saving validates every selected child, and execution always requires live child SQL access and feature eligibility. Scopes: orgAnalytics:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "organizationId": { "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": [ "organizationId" ], "patternProperties": { "^(?!(?:organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "organizationId" ] } ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "organizationId": { "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": [ "organizationId" ], "patternProperties": { "^(?!(?:organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "organizationId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "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" }, "organizationId": { "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" }, "workspaceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, { "type": "null" } ] }, "ownerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "updatedAt": { "type": "string" }, "document": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "kind": { "type": "string", "enum": [ "dashboard", "query" ] }, "name": { "type": "string", "maxLength": 160, "minLength": 1 }, "description": { "type": "string", "maxLength": 2000 }, "filters": { "type": "object", "properties": { "from": { "type": "string", "maxLength": 40 }, "to": { "type": "string", "maxLength": 40 }, "domain": { "type": "string", "maxLength": 253 }, "ip": { "type": "string", "maxLength": 64 }, "source": { "type": "string", "maxLength": 256 } }, "required": [ "from", "to", "domain", "ip", "source" ], "patternProperties": { "^(?!(?:from|to|domain|ip|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] } }, "widgets": { "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" }, "kind": { "type": "string", "enum": [ "chart", "text" ] }, "title": { "type": "string", "maxLength": 160 }, "text": { "type": "string", "maxLength": 4000 }, "query": { "type": "string", "maxLength": 20000 }, "bindings": { "type": "array", "items": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] }, "maxItems": 32 }, "chart": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "table", "number", "line", "area", "bar" ] }, "dimension": { "type": "string", "maxLength": 128 }, "measures": { "type": "array", "items": { "type": "string", "maxLength": 128 }, "maxItems": 8 }, "format": { "type": "string", "enum": [ "number", "percent", "currency", "duration", "bytes" ] }, "decimals": { "type": "integer", "minimum": 0, "maximum": 6 }, "label": { "type": "string", "maxLength": 128 } }, "required": [ "type", "dimension", "measures", "format", "decimals", "label" ], "patternProperties": { "^(?!(?:type|dimension|measures|format|decimals|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "dimension", "measures", "format", "decimals", "label" ] } }, "layout": { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 500 }, "w": { "type": "integer", "minimum": 2, "maximum": 12 }, "h": { "type": "integer", "minimum": 2, "maximum": 12 } }, "required": [ "x", "y", "w", "h" ], "patternProperties": { "^(?!(?:x|y|w|h)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y", "w", "h" ] } } }, "required": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ], "patternProperties": { "^(?!(?:id|kind|title|text|query|bindings|chart|layout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ] } }, "maxItems": 30 } }, "required": [ "version", "kind", "name", "description", "filters", "widgets" ], "patternProperties": { "^(?!(?:version|kind|name|description|filters|widgets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "kind", "name", "description", "filters", "widgets" ] } } }, "required": [ "id", "organizationId", "workspaceIds", "ownerId", "revision", "updatedAt", "document" ], "patternProperties": { "^(?!(?:id|organizationId|workspaceIds|ownerId|revision|updatedAt|document)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "organizationId", "workspaceIds", "ownerId", "revision", "updatedAt", "document" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } ``` ### Underlying API operations - `organizationDashboards.list`: `GET /v1/organizations/:organizationId/dashboards` ## list_permission_requests List permission requests in a workspace (reviewers see everyone's; others see their own), whether requests are enabled, and which workspace permissions the person could still request. Use to check the status of a request you filed, to show a reviewer what is waiting, or to find the exact permission slugs before calling request_permissions. It does not list members or their current grants; use the member tools for that. Scopes: workspace:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "status": { "$ref": "#/$defs/PermissionRequestStatus" }, "scope": { "$ref": "#/$defs/PermissionRequestListScope" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|status|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "status", "scope" ] }, "$defs": { "PermissionRequestStatus": { "type": "string", "enum": [ "pending", "approved", "denied", "canceled", "expired" ] }, "PermissionRequestListScope": { "type": "string", "enum": [ "mine", "all" ] } } } ``` ### 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" }, "status": { "$ref": "#/$defs/PermissionRequestStatus" }, "scope": { "$ref": "#/$defs/PermissionRequestListScope" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|status|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "status", "scope" ] }, "$defs": { "PermissionRequestStatus": { "type": "string", "enum": [ "pending", "approved", "denied", "canceled", "expired" ] }, "PermissionRequestListScope": { "type": "string", "enum": [ "mine", "all" ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "PermissionRequestId": { "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" }, "PermissionRequestStatus": { "type": "string", "enum": [ "pending", "approved", "denied", "canceled", "expired" ] }, "PermissionRequestPerson": { "type": "object", "properties": { "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, "PermissionRequestContext": { "type": "object", "properties": { "attemptedOperation": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "attemptedTool": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "explanation": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:attemptedOperation|attemptedTool|explanation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attemptedOperation", "attemptedTool", "explanation" ] } }, "PermissionRequestSource": { "type": "string", "enum": [ "web", "api", "agent" ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "PermissionRequest": { "type": "object", "properties": { "id": { "$ref": "#/$defs/PermissionRequestId" }, "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" }, "status": { "$ref": "#/$defs/PermissionRequestStatus" }, "requester": { "$ref": "#/$defs/PermissionRequestPerson" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "grantedPermissions": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "context": { "$ref": "#/$defs/PermissionRequestContext" }, "source": { "$ref": "#/$defs/PermissionRequestSource" }, "agentName": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "decidedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "decidedBy": { "anyOf": [ { "$ref": "#/$defs/PermissionRequestPerson" }, { "type": "null" } ] }, "decisionNote": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "reviewable": { "type": "boolean" } }, "required": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ], "patternProperties": { "^(?!(?:id|workspaceId|status|requester|permissions|grantedPermissions|reason|context|source|agentName|createdAt|expiresAt|decidedAt|decidedBy|decisionNote|reviewable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ] } }, "PermissionRequestOverview": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/$defs/PermissionRequest" } }, "requestsEnabled": { "type": "boolean" }, "canReview": { "type": "boolean" }, "requestablePermissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "pendingCount": { "type": "integer" } }, "required": [ "requests", "requestsEnabled", "canReview", "requestablePermissions", "pendingCount" ], "patternProperties": { "^(?!(?:requests|requestsEnabled|canReview|requestablePermissions|pendingCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "requests", "requestsEnabled", "canReview", "requestablePermissions", "pendingCount" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/PermissionRequestOverview" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/PermissionRequestOverview" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `permissionRequests.list`: `GET /v1/workspaces/:workspaceId/permission-requests` ## list_reminders List reminders in a workspace with a cursor page. Use to inspect pending, sent, or cancelled reminders before changing them. Do not poll in a tight loop; reminders change on user action. Scopes: unibox:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "status": { "type": "string", "enum": [ "pending", "sent", "cancelled" ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|status|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "status", "cursor", "limit" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### 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" }, "status": { "type": "string", "enum": [ "pending", "sent", "cancelled" ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|status|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "status", "cursor", "limit" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "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" }, "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" }, "threadId": { "$ref": "#/$defs/ProviderId" }, "remindAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isAutomatic": { "type": "boolean" }, "status": { "type": "string", "enum": [ "pending", "sent", "cancelled" ] }, "sentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cancelledAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "jobRunId": { "anyOf": [ { "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": "string", "pattern": "^run_[a-zA-Z0-9]{1,200}$" } ] }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "threadId", "remindAt", "isAutomatic", "status", "sentAt", "cancelledAt", "jobRunId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|threadId|remindAt|isAutomatic|status|sentAt|cancelledAt|jobRunId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "threadId", "remindAt", "isAutomatic", "status", "sentAt", "cancelledAt", "jobRunId", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Underlying API operations - `reminders.list`: `GET /v1/workspaces/:workspaceId/reminders` ## list_support_access List a workspace's support-access grants to Scheduler Zero support, the permissions the caller may grant, and the support-access audit trail (granted, used, revoked, expired). Use before granting or revoking, or to show who at Scheduler Zero support can currently act in the workspace and when they last did. It does not list workspace members or their roles; use the member tools for that. Scopes: workspaceMember:read Risk: read; confirmation: none; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "SupportAccessGrantId": { "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" }, "SupportAccessStatus": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "SupportAccessDurationHours": { "type": "number", "enum": [ 24, 72, 168 ] }, "SupportAccessPerson": { "type": "object", "properties": { "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "userId", "email" ], "patternProperties": { "^(?!(?:userId|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "email" ] } }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "SupportAccessGrant": { "type": "object", "properties": { "id": { "$ref": "#/$defs/SupportAccessGrantId" }, "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" }, "status": { "$ref": "#/$defs/SupportAccessStatus" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "agent:capabilities", "agent:identity", "agent:operations:cancel", "agent:operations:read", "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "audit:read", "billing:manage", "billing:read", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "platform:operate", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "role:manage", "role:read", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "usage:read", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:create", "workspace:delete", "workspace:read", "workspace:transfer", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "durationHours": { "$ref": "#/$defs/SupportAccessDurationHours" }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "grantedBy": { "$ref": "#/$defs/SupportAccessPerson" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "revokedBy": { "anyOf": [ { "$ref": "#/$defs/SupportAccessPerson" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "status", "permissions", "durationHours", "reason", "grantedBy", "createdAt", "expiresAt", "revokedAt", "revokedBy", "lastUsedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|status|permissions|durationHours|reason|grantedBy|createdAt|expiresAt|revokedAt|revokedBy|lastUsedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "status", "permissions", "durationHours", "reason", "grantedBy", "createdAt", "expiresAt", "revokedAt", "revokedBy", "lastUsedAt" ] } }, "SupportAccessEventAction": { "type": "string", "enum": [ "support_access.granted", "support_access.used", "support_access.revoked", "support_access.expired" ] }, "SupportAccessEvent": { "type": "object", "properties": { "id": { "type": "string" }, "action": { "$ref": "#/$defs/SupportAccessEventAction" }, "grantId": { "type": "string" }, "actorKind": { "type": "string" }, "actorLabel": { "type": "string" }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "permission": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "action", "grantId", "actorKind", "actorLabel", "occurredAt", "permission" ], "patternProperties": { "^(?!(?:id|action|grantId|actorKind|actorLabel|occurredAt|permission)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "action", "grantId", "actorKind", "actorLabel", "occurredAt", "permission" ] } }, "SupportAccessOverview": { "type": "object", "properties": { "grants": { "type": "array", "items": { "$ref": "#/$defs/SupportAccessGrant" } }, "grantablePermissions": { "type": "array", "items": { "type": "string", "enum": [ "agent:capabilities", "agent:identity", "agent:operations:cancel", "agent:operations:read", "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "audit:read", "billing:manage", "billing:read", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "platform:operate", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "role:manage", "role:read", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "usage:read", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:create", "workspace:delete", "workspace:read", "workspace:transfer", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "events": { "type": "array", "items": { "$ref": "#/$defs/SupportAccessEvent" } } }, "required": [ "grants", "grantablePermissions", "events" ], "patternProperties": { "^(?!(?:grants|grantablePermissions|events)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "grants", "grantablePermissions", "events" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/SupportAccessOverview" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/SupportAccessOverview" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `supportAccess.list`: `GET /v1/workspaces/:workspaceId/support-access` ## list_task_assignable_members List members eligible to hold a task assignment. Use before assign_task, or while configuring a workflow human-input node, to pick real responders. Do not treat the list as permission evidence; it is a directory. Scopes: task:read Risk: read; confirmation: none; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "members": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "role": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "userId", "name", "email", "image", "role" ], "patternProperties": { "^(?!(?:userId|name|email|image|role)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "role" ] } } } }, "required": [ "members" ], "patternProperties": { "^(?!(?:members)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "members" ] } ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Underlying API operations - `tasks.assignableMembers`: `GET /v1/workspaces/:workspaceId/tasks/assignable-members` ## list_tasks List tasks and workflow requests in a workspace. Use to inspect open work, filter to workflow requests, or page recent activity. Completed-task history is bounded; use show_completed only when needed. Scopes: task:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "kind": { "type": "string", "enum": [ "all", "tasks", "workflow_requests" ] }, "showCompleted": { "type": "boolean" }, "leadId": { "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" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|kind|showCompleted|leadId|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "kind", "showCompleted", "leadId", "cursor", "limit" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### 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" }, "kind": { "type": "string", "enum": [ "all", "tasks", "workflow_requests" ] }, "showCompleted": { "type": "boolean" }, "leadId": { "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" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|kind|showCompleted|leadId|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "kind", "showCompleted", "leadId", "cursor", "limit" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "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" }, "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" }, "title": { "type": "string", "minLength": 1, "maxLength": 2000 }, "description": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedBy": { "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" } ] }, "outcome": { "anyOf": [ { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] }, { "type": "null" } ] }, "leadId": { "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" } ] }, "campaignContactId": { "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" } ] }, "campaignStepId": { "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" } ] }, "workflowRunId": { "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" } ] }, "workflow": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] }, "humanRequest": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "approval", "text" ] }, "question": { "$ref": "#/$defs/Description" } }, "required": [ "type", "question" ], "patternProperties": { "^(?!(?:type|question)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "question" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "choice" ] } ] }, "question": { "$ref": "#/$defs/Description" }, "options": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" }, "maxItems": 20 } }, "required": [ "type", "question", "options" ], "patternProperties": { "^(?!(?:type|question|options)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "question", "options" ] } } ] }, { "type": "null" } ] }, "humanResponse": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "approval" ] } ] }, "approved": { "type": "boolean" }, "comment": { "$ref": "#/$defs/ShortText" } }, "required": [ "type", "approved" ], "patternProperties": { "^(?!(?:type|approved|comment)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "approved", "comment" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] } ] }, "text": { "$ref": "#/$defs/Description" } }, "required": [ "type", "text" ], "patternProperties": { "^(?!(?:type|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "text" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "choice" ] } ] }, "choice": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "type", "choice" ], "patternProperties": { "^(?!(?:type|choice)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "choice" ] } } ] }, { "type": "null" } ] }, "requestState": { "anyOf": [ { "type": "string", "enum": [ "pending", "answered", "expired", "cancelled" ] }, { "type": "null" } ] }, "responseExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "requestedByAgentRegistrationId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "operationId": { "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" } ] }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } } }, "createdBy": { "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" } ] }, "createdByUser": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } }, { "type": "null" } ] }, "completedByUser": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } }, { "type": "null" } ] }, "lead": { "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" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "firstName", "lastName", "companyName", "emailAddress", "phoneNumber" ], "patternProperties": { "^(?!(?:id|firstName|lastName|companyName|emailAddress|phoneNumber)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "firstName", "lastName", "companyName", "emailAddress", "phoneNumber" ] } }, { "type": "null" } ] }, "outcomeDetail": { "anyOf": [ { "type": "object", "properties": { "phoneOutcomes": { "type": "array", "items": { "type": "object", "properties": { "leadPhoneId": { "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" }, "outcome": { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] } }, "required": [ "leadPhoneId", "outcome" ], "patternProperties": { "^(?!(?:leadPhoneId|outcome)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadPhoneId", "outcome" ] } }, "maxItems": 50 } }, "required": [ "phoneOutcomes" ], "patternProperties": { "^(?!(?:phoneOutcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "phoneOutcomes" ] } ] } }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "title", "description", "dueDate", "completedAt", "completedBy", "outcome", "leadId", "campaignContactId", "campaignStepId", "workflowRunId", "workflow", "humanRequest", "humanResponse", "requestState", "responseExpiresAt", "requestedByAgentRegistrationId", "operationId", "assignees", "createdBy", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|title|description|dueDate|completedAt|completedBy|outcome|leadId|campaignContactId|campaignStepId|workflowRunId|workflow|humanRequest|humanResponse|requestState|responseExpiresAt|requestedByAgentRegistrationId|operationId|assignees|createdBy|createdByUser|completedByUser|lead|outcomeDetail|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "title", "description", "dueDate", "completedAt", "completedBy", "outcome", "leadId", "campaignContactId", "campaignStepId", "workflowRunId", "workflow", "humanRequest", "humanResponse", "requestState", "responseExpiresAt", "requestedByAgentRegistrationId", "operationId", "assignees", "createdBy", "createdByUser", "completedByUser", "lead", "outcomeDetail", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Underlying API operations - `tasks.list`: `GET /v1/workspaces/:workspaceId/tasks` ## list_thread_label_history Read a conversation's reply-label history, newest first (default 50 events, limit up to 100). Returns added/removed events with snapshotted label names/colors, source, actor and time; multiple labels may coexist, so this is not an atomic from/to status change. Pass nextCursor unchanged for the next page. Use to audit which labels were added or removed on one conversation. Call list_unibox_threads first, then use the selected item's id as threadId and organizationId as workspaceId (not providerThreadId). The native REST thread list returns the same IDs. Do not infer unrecorded history or a complete historical label set: events before tracking began were not backfilled. This is conversation history, not a single-valued lead status. Scopes: unibox:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "threadId": { "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" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "threadId" ], "patternProperties": { "^(?!(?:workspaceId|threadId|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "threadId", "cursor", "limit" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### 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" }, "threadId": { "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" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "threadId" ], "patternProperties": { "^(?!(?:workspaceId|threadId|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "threadId", "cursor", "limit" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "threadId": { "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" }, "labelId": { "$ref": "#/$defs/ThreadLabelId" }, "labelType": { "type": "string", "enum": [ "custom", "default" ] }, "labelName": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "action": { "type": "string", "enum": [ "added", "removed" ] }, "source": { "$ref": "#/$defs/ShortText" }, "actorUserId": { "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" } ] }, "actorName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "threadId", "labelId", "labelType", "labelName", "hexColor", "action", "source", "actorUserId", "actorName", "occurredAt" ], "patternProperties": { "^(?!(?:id|threadId|labelId|labelType|labelName|hexColor|action|source|actorUserId|actorName|occurredAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "threadId", "labelId", "labelType", "labelName", "hexColor", "action", "source", "actorUserId", "actorName", "occurredAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ThreadLabelId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Underlying API operations - `uniboxThreads.listLabelHistory`: `GET /v1/workspaces/:workspaceId/unibox/threads/:threadId/label-history` ## list_unibox_threads Find conversations in a Workspace and obtain their local UUIDs for subsequent tools. Returns a bounded page of thread metadata, default 20 and maximum 100 items, with an opaque nextCursor. Use before list_thread_label_history. Select a conversation using search or folder. showAllEmails defaults to false (managed inbox conversations); set true to include other inbound inbox mail, including manually labeled conversations. Other folders retain their usual rules. Then pass its id as threadId and its organizationId as workspaceId. Pass nextCursor unchanged for another page. Does not return message bodies or label history. Folder defaults to inbox; choose archived, sent, starred, trash, or warmup when appropriate. Never use providerThreadId as the local threadId. Scopes: unibox:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "folder": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] }, "showAllEmails": { "type": "boolean" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|cursor|limit|search|folder|showAllEmails)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "cursor", "limit", "search", "folder", "showAllEmails" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### 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" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "folder": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] }, "showAllEmails": { "type": "boolean" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|cursor|limit|search|folder|showAllEmails)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "cursor", "limit", "search", "folder", "showAllEmails" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "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" }, "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" } ] }, "organizationId": { "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" }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "contact": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "leadId": { "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" } ] } }, "required": [ "emailAddress", "name", "leadId" ], "patternProperties": { "^(?!(?:emailAddress|name|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "name", "leadId" ] } }, "providerThreadId": { "$ref": "#/$defs/OpaqueId" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "lastMessageAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "messageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ThreadLabelId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isFormerMember": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isFormerMember" ], "patternProperties": { "^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isFormerMember" ] } } }, "campaignId": { "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" } ] }, "campaignContactId": { "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" } ] }, "isRead": { "type": "boolean" }, "starredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "folders": { "type": "array", "items": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] } }, "recentMessages": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isRead": { "type": "boolean" }, "isFromInboxSender": { "type": "boolean" } }, "required": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ], "patternProperties": { "^(?!(?:id|providerInternalMessageId|from|to|cc|subject|snippet|receivedAt|isRead|isFromInboxSender)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ] } }, "maxItems": 20 } }, "required": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders" ], "patternProperties": { "^(?!(?:id|inboxId|organizationId|subject|snippet|contact|providerThreadId|provider|lastMessageAt|messageCount|labels|assignees|campaignId|campaignContactId|isRead|starredAt|archivedAt|deletedAt|folders|recentMessages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders", "recentMessages" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor", "total" ] }, "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ThreadLabelId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Underlying API operations - `uniboxThreads.list`: `GET /v1/workspaces/:workspaceId/unibox/threads` ## list_workspaces List the workspaces the authenticated agent can act in with their capability bundles. Use when the agent needs to discover which workspace handles are available before selecting one. Do not use to probe for other organizations; the answer is already scoped to the credential's organization. Scopes: agent:identity Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "patternProperties": { "^(?!(?:cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "patternProperties": { "^(?!(?:cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/ShortText" }, "effectiveRoleLabel": { "$ref": "#/$defs/ShortText" }, "capabilityBundles": { "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, "accessSource": { "type": "string", "enum": [ "membership", "organization", "credential" ] } }, "required": [ "id", "name", "slug", "effectiveRoleLabel", "capabilityBundles", "accessSource" ], "patternProperties": { "^(?!(?:id|name|slug|effectiveRoleLabel|capabilityBundles|accessSource)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "effectiveRoleLabel", "capabilityBundles", "accessSource" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Underlying API operations - `agent.listWorkspaces`: `GET /agent/workspaces` ## manage_account_security Initiate private email, password, MFA, sessions or connected sign-in management; give the user the completion URL instead of asking for secrets. To change account security. The user completes the same API-backed UI, then reads provider state with read_account_security. Never send passwords, OTPs, recovery codes or TOTP secrets to a tool or chat. Unsupported provider actions are reported, not emulated. Return the authorization or checkout handoff to the person. The agent may initiate and inspect status, but must not complete the human approval. Scopes: workspace:read Risk: read; confirmation: human_completion; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "intent": { "type": "string", "enum": [ "email", "password", "password-reset", "mfa", "sessions", "connections" ] } }, "required": [ "intent" ], "patternProperties": { "^(?!(?:intent)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "intent" ] } ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "intent": { "type": "string", "enum": [ "email", "password", "password-reset", "mfa", "sessions", "connections" ] } }, "required": [ "intent" ], "patternProperties": { "^(?!(?:intent)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "intent" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "completionUrl": { "$ref": "#/$defs/HttpUrl" }, "intent": { "type": "string", "enum": [ "email", "password", "password-reset", "mfa", "sessions", "connections" ] }, "instructions": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "completionUrl", "intent", "instructions" ], "patternProperties": { "^(?!(?:completionUrl|intent|instructions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "completionUrl", "intent", "instructions" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Underlying API operations - `accountSecurity.handoff`: `POST /v1/me/security/handoff` - `accountSecurity.read`: `GET /v1/me/security` ## manage_analytics_shares Create, list, and revoke the public snapshot links that publish a campaign's frozen results. Use when a result set has to leave the workspace. Creating one freezes the numbers as they are at that instant, so the link keeps reporting that moment no matter what the campaign does afterwards. A snapshot is readable by anyone who receives the link and can never be edited — only revoked. Do not use it for live data, for row-level exports, or to work around someone's lack of workspace access. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: analytics:export Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create", "list", "revoke" ] }, "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" }, "campaignId": { "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" }, "shareId": { "$ref": "#/$defs/AnalyticsShareId" }, "create": { "type": "object", "properties": { "startDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "recipientProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "senderTagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 100 }, "senderDomains": { "type": "array", "items": { "$ref": "#/$defs/DomainNameEncoded" }, "maxItems": 100 }, "title": { "$ref": "#/$defs/AnalyticsShareTitle" }, "includeCampaignName": { "type": "boolean" }, "expiresInDays": { "anyOf": [ { "type": "number", "enum": [ 7, 30 ] }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:startDate|endDate|senderProviders|recipientProviders|senderTagIds|senderDomains|title|includeCampaignName|expiresInDays)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "startDate", "endDate", "senderProviders", "recipientProviders", "senderTagIds", "senderDomains", "title", "includeCampaignName", "expiresInDays" ] } } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|shareId|create)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "shareId", "create" ] }, "$defs": { "AnalyticsShareId": { "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" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "DomainNameEncoded": { "type": "string" }, "AnalyticsShareTitle": { "type": "string", "minLength": 1, "maxLength": 120 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create", "list", "revoke" ] }, "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" }, "campaignId": { "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" }, "shareId": { "$ref": "#/$defs/AnalyticsShareId" }, "create": { "type": "object", "properties": { "startDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "recipientProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "senderTagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 100 }, "senderDomains": { "type": "array", "items": { "$ref": "#/$defs/DomainNameEncoded" }, "maxItems": 100 }, "title": { "$ref": "#/$defs/AnalyticsShareTitle" }, "includeCampaignName": { "type": "boolean" }, "expiresInDays": { "anyOf": [ { "type": "number", "enum": [ 7, 30 ] }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:startDate|endDate|senderProviders|recipientProviders|senderTagIds|senderDomains|title|includeCampaignName|expiresInDays)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "startDate", "endDate", "senderProviders", "recipientProviders", "senderTagIds", "senderDomains", "title", "includeCampaignName", "expiresInDays" ] } } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|shareId|create)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "shareId", "create" ] }, "$defs": { "AnalyticsShareId": { "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" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "DomainNameEncoded": { "type": "string" }, "AnalyticsShareTitle": { "type": "string", "minLength": 1, "maxLength": 120 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "AnalyticsShareId": { "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" }, "AnalyticsShareToken": { "type": "string", "minLength": 32, "maxLength": 32, "pattern": "^[A-Za-z0-9_-]+$" }, "AnalyticsShareTitle": { "type": "string", "minLength": 1, "maxLength": 120 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/AnalyticsShareId" }, "token": { "$ref": "#/$defs/AnalyticsShareToken" }, "title": { "$ref": "#/$defs/AnalyticsShareTitle" }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "token", "title", "expiresAt", "revokedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|token|title|expiresAt|revokedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "token", "title", "expiresAt", "revokedAt", "createdAt" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AnalyticsShareId" }, "token": { "$ref": "#/$defs/AnalyticsShareToken" }, "title": { "$ref": "#/$defs/AnalyticsShareTitle" }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "token", "title", "expiresAt", "revokedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|token|title|expiresAt|revokedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "token", "title", "expiresAt", "revokedAt", "createdAt" ] } }, "maxItems": 20 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "shareId": { "$ref": "#/$defs/AnalyticsShareId" }, "revokedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "shareId", "revokedAt" ], "patternProperties": { "^(?!(?:shareId|revokedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "shareId", "revokedAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/AnalyticsShareId" }, "token": { "$ref": "#/$defs/AnalyticsShareToken" }, "title": { "$ref": "#/$defs/AnalyticsShareTitle" }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "token", "title", "expiresAt", "revokedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|token|title|expiresAt|revokedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "token", "title", "expiresAt", "revokedAt", "createdAt" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AnalyticsShareId" }, "token": { "$ref": "#/$defs/AnalyticsShareToken" }, "title": { "$ref": "#/$defs/AnalyticsShareTitle" }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "token", "title", "expiresAt", "revokedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|token|title|expiresAt|revokedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "token", "title", "expiresAt", "revokedAt", "createdAt" ] } }, "maxItems": 20 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "shareId": { "$ref": "#/$defs/AnalyticsShareId" }, "revokedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "shareId", "revokedAt" ], "patternProperties": { "^(?!(?:shareId|revokedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "shareId", "revokedAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaignAnalytics.createShare`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/analytics-shares` - `campaignAnalytics.listShares`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/analytics-shares` - `campaignAnalytics.revokeShare`: `DELETE /v1/workspaces/:workspaceId/campaigns/analytics-shares/:shareId` ## manage_api_key_grants Rename one of the caller's personal API keys or replace its access: full account, or a restriction to chosen Organizations with Organization permissions plus selected-Workspace or all-Workspaces permissions. Use after `read_api_key_issuance` when the person asks to narrow or change what a key can reach. A key never exceeds its owner's current permissions. Does not return or rotate the secret. Agents and API keys may only narrow access; widening a key (or making it full-account) needs the person in the web app. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: apiKey:update Risk: security_admin; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "apiKeyId": { "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": { "$ref": "#/$defs/ShortText" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "access": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "full" ] } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "type" ] } ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "restricted" ] } ] }, "organizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationPermissions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 100 }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 512 }, "maxItems": 20 }, "permissions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 400 } }, "required": [ "workspaceId", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "permissions" ] } }, "maxItems": 500 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 512 }, "maxItems": 20 }, "permissions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 400 } }, "required": [ "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } } }, "required": [ "organizationId" ], "patternProperties": { "^(?!(?:organizationId|organizationPermissions|workspaces|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationPermissions", "workspaces", "allWorkspaces" ] } }, "minItems": 1, "maxItems": 100 } }, "required": [ "type", "organizations" ], "patternProperties": { "^(?!(?:type|organizations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "organizations" ] } } ] } }, "required": [ "apiKeyId" ], "patternProperties": { "^(?!(?:apiKeyId|name|description|access)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "apiKeyId", "name", "description", "access" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "apiKeyId": { "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": { "$ref": "#/$defs/ShortText" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "access": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "full" ] } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "type" ] } ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "restricted" ] } ] }, "organizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationPermissions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 100 }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 512 }, "maxItems": 20 }, "permissions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 400 } }, "required": [ "workspaceId", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "permissions" ] } }, "maxItems": 500 }, "allWorkspaces": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 512 }, "maxItems": 20 }, "permissions": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 400 } }, "required": [ "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } } }, "required": [ "organizationId" ], "patternProperties": { "^(?!(?:organizationId|organizationPermissions|workspaces|allWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationPermissions", "workspaces", "allWorkspaces" ] } }, "minItems": 1, "maxItems": 100 } }, "required": [ "type", "organizations" ], "patternProperties": { "^(?!(?:type|organizations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "organizations" ] } } ] } }, "required": [ "apiKeyId" ], "patternProperties": { "^(?!(?:apiKeyId|name|description|access)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "apiKeyId", "name", "description", "access" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "access": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "full" ] } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "type" ] } ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "restricted" ] } ] }, "organizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } } } }, "required": [ "type", "organizations" ], "patternProperties": { "^(?!(?:type|organizations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "organizations" ] } } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedOrganizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "organizationId", "organizationName", "blockedAt" ], "patternProperties": { "^(?!(?:organizationId|organizationName|blockedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "blockedAt" ] } } }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|description|access|prefix|blockedOrganizations|expiresAt|lastUsedAt|lastRotatedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ] }, "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `personalApiKeys.update`: `PATCH /v1/me/api-keys/:apiKeyId` ## manage_attio_mappings Shape how Attio records import: save, change, or delete a named field mapping, and refresh the local catalog of Attio lists. Use when an import needs a mapping that does not exist yet, when the default mapping should change, or when a list the customer just created in Attio is missing from the catalog. Marking a mapping default clears every other default in the workspace. A list sync replaces the whole catalog in one swap; it never imports anything. None of these write into Attio. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:create, integration:update, integration:delete Risk: write; confirmation: explicit; 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" }, "action": { "type": "string", "enum": [ "create_mapping", "update_mapping", "delete_mapping", "sync_lists" ] }, "mappingId": { "$ref": "#/$defs/AttioFieldMappingId" }, "create": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "rules": { "$ref": "#/$defs/AttioFieldMappingRules" }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal", "ask" ] }, "duplicateBehavior": { "type": "string", "enum": [ "skip", "update" ] }, "isDefault": { "type": "boolean" } }, "required": [ "name", "rules" ], "patternProperties": { "^(?!(?:name|rules|emailStrategy|duplicateBehavior|isDefault)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "rules", "emailStrategy", "duplicateBehavior", "isDefault" ] } }, "update": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "rules": { "$ref": "#/$defs/AttioFieldMappingRules" }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal", "ask" ] }, "duplicateBehavior": { "type": "string", "enum": [ "skip", "update" ] }, "isDefault": { "type": "boolean" } }, "patternProperties": { "^(?!(?:name|rules|emailStrategy|duplicateBehavior|isDefault)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "rules", "emailStrategy", "duplicateBehavior", "isDefault" ] }, "minProperties": 1, "maxProperties": 5 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|mappingId|create|update)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "mappingId", "create", "update" ] }, "$defs": { "AttioFieldMappingId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "AttioFieldMappingRules": { "type": "object", "additionalProperties": true, "minProperties": 0, "maxProperties": 200 } } } ``` ### 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" }, "action": { "type": "string", "enum": [ "create_mapping", "update_mapping", "delete_mapping", "sync_lists" ] }, "mappingId": { "$ref": "#/$defs/AttioFieldMappingId" }, "create": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "rules": { "$ref": "#/$defs/AttioFieldMappingRules" }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal", "ask" ] }, "duplicateBehavior": { "type": "string", "enum": [ "skip", "update" ] }, "isDefault": { "type": "boolean" } }, "required": [ "name", "rules" ], "patternProperties": { "^(?!(?:name|rules|emailStrategy|duplicateBehavior|isDefault)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "rules", "emailStrategy", "duplicateBehavior", "isDefault" ] } }, "update": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "rules": { "$ref": "#/$defs/AttioFieldMappingRules" }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal", "ask" ] }, "duplicateBehavior": { "type": "string", "enum": [ "skip", "update" ] }, "isDefault": { "type": "boolean" } }, "patternProperties": { "^(?!(?:name|rules|emailStrategy|duplicateBehavior|isDefault)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "rules", "emailStrategy", "duplicateBehavior", "isDefault" ] }, "minProperties": 1, "maxProperties": 5 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|mappingId|create|update)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "mappingId", "create", "update" ] }, "$defs": { "AttioFieldMappingId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "AttioFieldMappingRules": { "type": "object", "additionalProperties": true, "minProperties": 0, "maxProperties": 200 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "AttioFieldMappingId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "AttioFieldMappingRules": { "type": "object", "additionalProperties": true, "minProperties": 0, "maxProperties": 200 }, "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "AttioFieldMapping": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttioFieldMappingId" }, "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" }, "name": { "$ref": "#/$defs/ShortText" }, "rules": { "$ref": "#/$defs/AttioFieldMappingRules" }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal", "ask" ] }, "duplicateBehavior": { "type": "string", "enum": [ "skip", "update" ] }, "isDefault": { "type": "boolean" }, "providerWorkspaceId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "rules", "emailStrategy", "duplicateBehavior", "isDefault", "providerWorkspaceId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|rules|emailStrategy|duplicateBehavior|isDefault|providerWorkspaceId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "rules", "emailStrategy", "duplicateBehavior", "isDefault", "providerWorkspaceId", "createdAt", "updatedAt" ] } }, "AttioCachedList": { "type": "object", "properties": { "listId": { "$ref": "#/$defs/ProviderId" }, "name": { "$ref": "#/$defs/ShortText" }, "parentObject": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "entryCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "lastSyncedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "listId", "name", "parentObject", "entryCount", "lastSyncedAt" ], "patternProperties": { "^(?!(?:listId|name|parentObject|entryCount|lastSyncedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "listId", "name", "parentObject", "entryCount", "lastSyncedAt" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/AttioFieldMapping" }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttioFieldMappingId" }, "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "id", "deleted" ], "patternProperties": { "^(?!(?:id|deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "deleted" ] } }, { "type": "object", "properties": { "synced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "items": { "type": "array", "items": { "$ref": "#/$defs/AttioCachedList" }, "maxItems": 1000 } }, "required": [ "synced", "items" ], "patternProperties": { "^(?!(?:synced|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "synced", "items" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/AttioFieldMapping" }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttioFieldMappingId" }, "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "id", "deleted" ], "patternProperties": { "^(?!(?:id|deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "deleted" ] } }, { "type": "object", "properties": { "synced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "items": { "type": "array", "items": { "$ref": "#/$defs/AttioCachedList" }, "maxItems": 1000 } }, "required": [ "synced", "items" ], "patternProperties": { "^(?!(?:synced|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "synced", "items" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `attioMappings.create`: `POST /v1/workspaces/:workspaceId/integrations/attio/mappings` - `attioMappings.update`: `PATCH /v1/workspaces/:workspaceId/integrations/attio/mappings/:mappingId` - `attioMappings.delete`: `DELETE /v1/workspaces/:workspaceId/integrations/attio/mappings/:mappingId` - `attioBrowse.syncLists`: `POST /v1/workspaces/:workspaceId/integrations/attio/lists/sync` ## manage_attio_outbound Turn the four outbound Attio writes on or off: automatic lead sync, and call, reply, and send activity notes. Use only when the customer has asked for Scheduler Zero to write into their Attio. Every toggle defaults off. Enabling a write is refused until the connection holds the matching Attio write grants — the customer must reconnect Attio, which no agent can do for them. Turning a toggle on changes what lands in a paying customer's CRM from then on; it does not backfill. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:update Risk: write; confirmation: explicit; 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" }, "settings": { "type": "object", "properties": { "pushLeads": { "type": "boolean" }, "pushCallNotes": { "type": "boolean" }, "pushReplyNotes": { "type": "boolean" }, "pushSendNotes": { "type": "boolean" } }, "patternProperties": { "^(?!(?:pushLeads|pushCallNotes|pushReplyNotes|pushSendNotes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "pushLeads", "pushCallNotes", "pushReplyNotes", "pushSendNotes" ] }, "minProperties": 1, "maxProperties": 4 } }, "required": [ "workspaceId", "settings" ], "patternProperties": { "^(?!(?:workspaceId|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "settings" ] } } ``` ### 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" }, "settings": { "type": "object", "properties": { "pushLeads": { "type": "boolean" }, "pushCallNotes": { "type": "boolean" }, "pushReplyNotes": { "type": "boolean" }, "pushSendNotes": { "type": "boolean" } }, "patternProperties": { "^(?!(?:pushLeads|pushCallNotes|pushReplyNotes|pushSendNotes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "pushLeads", "pushCallNotes", "pushReplyNotes", "pushSendNotes" ] }, "minProperties": 1, "maxProperties": 4 } }, "required": [ "workspaceId", "settings" ], "patternProperties": { "^(?!(?:workspaceId|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "settings" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "AttioOutboundSettings": { "type": "object", "properties": { "pushLeads": { "type": "boolean" }, "pushCallNotes": { "type": "boolean" }, "pushReplyNotes": { "type": "boolean" }, "pushSendNotes": { "type": "boolean" } }, "required": [ "pushLeads", "pushCallNotes", "pushReplyNotes", "pushSendNotes" ], "patternProperties": { "^(?!(?:pushLeads|pushCallNotes|pushReplyNotes|pushSendNotes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "pushLeads", "pushCallNotes", "pushReplyNotes", "pushSendNotes" ] } }, "AttioOutboundSettingsResult": { "type": "object", "properties": { "connected": { "type": "boolean" }, "settings": { "$ref": "#/$defs/AttioOutboundSettings" } }, "required": [ "connected", "settings" ], "patternProperties": { "^(?!(?:connected|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "settings" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/AttioOutboundSettingsResult" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/AttioOutboundSettingsResult" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `attioOutbound.updateSettings`: `PATCH /v1/workspaces/:workspaceId/integrations/attio/outbound-settings` ## manage_blocklist List, add, or remove blocked senders for a workspace; entries are normalized to lowercase addresses or bare domains. Use to audit or edit the suppression list that keeps a workspace from mailing blocked addresses or domains. Entries must be email addresses or bare DNS domains — URLs, wildcards, and paths are rejected. Removal is destructive. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: blocklist:read, blocklist:create, blocklist:delete Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "search": { "$ref": "#/$defs/ShortText" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|search|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "search", "cursor", "limit" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "add" ] } ] }, "entries": { "type": "array", "prefixItems": [ { "$ref": "#/$defs/BlockedEmailEntryEncoded" } ], "minItems": 1, "items": { "$ref": "#/$defs/BlockedEmailEntryEncoded" } } }, "required": [ "workspaceId", "action", "entries" ], "patternProperties": { "^(?!(?:workspaceId|action|entries)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "entries" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "remove" ] } ] }, "entry": { "$ref": "#/$defs/BlockedEmailEntryEncoded" } }, "required": [ "workspaceId", "action", "entry" ], "patternProperties": { "^(?!(?:workspaceId|action|entry)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "entry" ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "BlockedEmailEntryEncoded": { "type": "string" } } } ``` ### 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": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "search": { "$ref": "#/$defs/ShortText" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|search|cursor|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "search", "cursor", "limit" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "add" ] } ] }, "entries": { "type": "array", "prefixItems": [ { "$ref": "#/$defs/BlockedEmailEntryEncoded" } ], "minItems": 1, "items": { "$ref": "#/$defs/BlockedEmailEntryEncoded" } } }, "required": [ "workspaceId", "action", "entries" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|entries)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "entries" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "remove" ] } ] }, "entry": { "$ref": "#/$defs/BlockedEmailEntryEncoded" } }, "required": [ "workspaceId", "action", "entry" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|entry)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "entry" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "BlockedEmailEntryEncoded": { "type": "string" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "BlockedEmailEntryEncoded": { "type": "string" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "entry": { "$ref": "#/$defs/BlockedEmailEntryEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "entry", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:entry|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "entry", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "inserted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "inserted" ], "patternProperties": { "^(?!(?:inserted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "inserted" ] } ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "entry": { "$ref": "#/$defs/BlockedEmailEntryEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "entry", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:entry|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "entry", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "inserted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "inserted" ], "patternProperties": { "^(?!(?:inserted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "inserted" ] } ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `blockedEmails.list`: `GET /v1/workspaces/:workspaceId/settings/blocked-emails` - `blockedEmails.add`: `POST /v1/workspaces/:workspaceId/settings/blocked-emails` - `blockedEmails.remove`: `DELETE /v1/workspaces/:workspaceId/settings/blocked-emails/:entry` ## manage_call_lists Curate the lists a dialing session works through: create one, rename it, copy it, retire it, read the contacts in it, and import more from a CSV payload or an Attio people list. Use to prepare who a rep will call — build a fresh list for a segment, top one up with new rows, or read back what is queued and how far it has been worked. If the person asks to call this list, resolve its workspace slug with resolve_workspace and hand them `/{workspace.slug}/dialer/lists/{callListId}` in the Scheduler Zero web app. They can review the list, choose session settings, explicitly start dialing, and grant microphone access there; this handoff does not initiate a session or call. After they provide the session id, read progress with read_dialer_history. Deleting a list destroys every queue row in it, including dialing progress, and is refused while a published workflow or a live run still names it. An import only ever dials the numbers each uploaded row itself carried; it will not discover a matched lead's other numbers, and asking it to is a consent problem, not a missing feature. Lists the campaign engine owns cannot be edited here at all. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: dialer:read, dialer:create, dialer:update, dialer:delete, lead:import, integration:read Risk: destructive; confirmation: explicit; 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" }, "action": { "type": "string", "enum": [ "list", "get", "create", "update", "duplicate", "delete", "list_contacts", "import_csv", "import_attio_list" ] }, "callListId": { "$ref": "#/$defs/CallListId" }, "list": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "type": "string", "minLength": 1, "maxLength": 200 }, "sortBy": { "type": "string", "enum": [ "name", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] } }, "patternProperties": { "^(?!(?:offset|limit|search|sortBy|sortOrder)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "search", "sortBy", "sortOrder" ] } }, "contacts": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "status": { "type": "string", "enum": [ "not_called", "queued", "in_progress", "called", "completed", "skipped", "callback", "dnc", "failed" ] }, "search": { "type": "string", "minLength": 1, "maxLength": 200 } }, "patternProperties": { "^(?!(?:offset|limit|status|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "status", "search" ] } }, "create": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "customFieldNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|defaultTimezone|customFieldNames)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "defaultTimezone", "customFieldNames" ] } }, "update": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "customFieldNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 } }, "patternProperties": { "^(?!(?:name|customFieldNames)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "customFieldNames" ] }, "minProperties": 1, "maxProperties": 2 }, "importCsv": { "type": "object", "properties": { "contacts": { "type": "array", "items": { "type": "object", "properties": { "phone": { "$ref": "#/$defs/ShortText" }, "phones": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 9 }, "firstName": { "$ref": "#/$defs/ShortText" }, "lastName": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/ShortText" }, "companyName": { "$ref": "#/$defs/ShortText" }, "jobTitle": { "$ref": "#/$defs/ShortText" }, "companyWebsiteUrl": { "$ref": "#/$defs/ShortText" }, "personalLinkedInUrl": { "$ref": "#/$defs/ShortText" }, "companyLinkedInUrl": { "$ref": "#/$defs/ShortText" }, "city": { "$ref": "#/$defs/ShortText" }, "state": { "$ref": "#/$defs/ShortText" }, "country": { "$ref": "#/$defs/ShortText" }, "timezone": { "$ref": "#/$defs/ShortText" }, "customFields": { "type": "object", "additionalProperties": true } }, "required": [ "phone" ], "patternProperties": { "^(?!(?:phone|phones|firstName|lastName|email|companyName|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phone", "phones", "firstName", "lastName", "email", "companyName", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFields" ] } }, "minItems": 1, "maxItems": 50000 } }, "required": [ "contacts" ], "patternProperties": { "^(?!(?:contacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "contacts" ] } ] } }, "importAttioList": { "type": "object", "properties": { "attioListId": { "$ref": "#/$defs/ProviderId" }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal" ] } }, "required": [ "attioListId" ], "patternProperties": { "^(?!(?:attioListId|emailStrategy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attioListId", "emailStrategy" ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|callListId|list|contacts|create|update|importCsv|importAttioList)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "callListId", "list", "contacts", "create", "update", "importCsv", "importAttioList" ] }, "$defs": { "CallListId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "CallListCustomFieldValue": { "type": "string", "maxLength": 4096 }, "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### 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" }, "action": { "type": "string", "enum": [ "list", "get", "create", "update", "duplicate", "delete", "list_contacts", "import_csv", "import_attio_list" ] }, "callListId": { "$ref": "#/$defs/CallListId" }, "list": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "type": "string", "minLength": 1, "maxLength": 200 }, "sortBy": { "type": "string", "enum": [ "name", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] } }, "patternProperties": { "^(?!(?:offset|limit|search|sortBy|sortOrder)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "search", "sortBy", "sortOrder" ] } }, "contacts": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "status": { "type": "string", "enum": [ "not_called", "queued", "in_progress", "called", "completed", "skipped", "callback", "dnc", "failed" ] }, "search": { "type": "string", "minLength": 1, "maxLength": 200 } }, "patternProperties": { "^(?!(?:offset|limit|status|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "status", "search" ] } }, "create": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "customFieldNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|defaultTimezone|customFieldNames)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "defaultTimezone", "customFieldNames" ] } }, "update": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "customFieldNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 } }, "patternProperties": { "^(?!(?:name|customFieldNames)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "customFieldNames" ] }, "minProperties": 1, "maxProperties": 2 }, "importCsv": { "type": "object", "properties": { "contacts": { "type": "array", "items": { "type": "object", "properties": { "phone": { "$ref": "#/$defs/ShortText" }, "phones": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 9 }, "firstName": { "$ref": "#/$defs/ShortText" }, "lastName": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/ShortText" }, "companyName": { "$ref": "#/$defs/ShortText" }, "jobTitle": { "$ref": "#/$defs/ShortText" }, "companyWebsiteUrl": { "$ref": "#/$defs/ShortText" }, "personalLinkedInUrl": { "$ref": "#/$defs/ShortText" }, "companyLinkedInUrl": { "$ref": "#/$defs/ShortText" }, "city": { "$ref": "#/$defs/ShortText" }, "state": { "$ref": "#/$defs/ShortText" }, "country": { "$ref": "#/$defs/ShortText" }, "timezone": { "$ref": "#/$defs/ShortText" }, "customFields": { "type": "object", "additionalProperties": true } }, "required": [ "phone" ], "patternProperties": { "^(?!(?:phone|phones|firstName|lastName|email|companyName|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phone", "phones", "firstName", "lastName", "email", "companyName", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFields" ] } }, "minItems": 1, "maxItems": 50000 } }, "required": [ "contacts" ], "patternProperties": { "^(?!(?:contacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "contacts" ] } ] } }, "importAttioList": { "type": "object", "properties": { "attioListId": { "$ref": "#/$defs/ProviderId" }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal" ] } }, "required": [ "attioListId" ], "patternProperties": { "^(?!(?:attioListId|emailStrategy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attioListId", "emailStrategy" ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|callListId|list|contacts|create|update|importCsv|importAttioList)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "callListId", "list", "contacts", "create", "update", "importCsv", "importAttioList" ] }, "$defs": { "CallListId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "CallListCustomFieldValue": { "type": "string", "maxLength": 4096 }, "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "CallListId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "CallListContactId": { "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" }, "LeadPhoneId": { "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" }, "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "CallListCustomFieldValue": { "type": "string", "maxLength": 4096 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/CallListId" }, "name": { "$ref": "#/$defs/ShortText" }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "customFieldNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "systemType": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "sequence_tasks" ] } ] }, { "type": "null" } ] }, "contactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "defaultTimezone", "customFieldNames", "systemType", "contactCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|defaultTimezone|customFieldNames|systemType|contactCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "defaultTimezone", "customFieldNames", "systemType", "contactCount", "createdAt", "updatedAt" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/CallListId" }, "name": { "$ref": "#/$defs/ShortText" }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "customFieldNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "systemType": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "sequence_tasks" ] } ] }, { "type": "null" } ] }, "contactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "defaultTimezone", "customFieldNames", "systemType", "contactCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|defaultTimezone|customFieldNames|systemType|contactCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "defaultTimezone", "customFieldNames", "systemType", "contactCount", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/CallListContactId" }, "callListId": { "$ref": "#/$defs/CallListId" }, "leadId": { "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" } ] }, "leadPhoneId": { "anyOf": [ { "$ref": "#/$defs/LeadPhoneId" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "not_called", "queued", "in_progress", "called", "completed", "skipped", "callback", "dnc", "failed" ] }, "phoneNumber": { "$ref": "#/$defs/E164PhoneNumber" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "locality": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/IanaTimeZone" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": true }, "assignedUserId": { "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" } ] }, "callAttempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastCallId": { "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" } ] }, "lastDisposition": { "anyOf": [ { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, { "type": "null" } ] }, "lastAttemptAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "nextEligibleAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "callListId", "leadId", "leadPhoneId", "status", "phoneNumber", "firstName", "lastName", "emailAddress", "companyName", "companyWebsiteUrl", "jobTitle", "personalLinkedInUrl", "companyLinkedInUrl", "locality", "region", "country", "timezone", "customFieldValues", "assignedUserId", "callAttempts", "lastCallId", "lastDisposition", "lastAttemptAt", "nextEligibleAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|callListId|leadId|leadPhoneId|status|phoneNumber|firstName|lastName|emailAddress|companyName|companyWebsiteUrl|jobTitle|personalLinkedInUrl|companyLinkedInUrl|locality|region|country|timezone|customFieldValues|assignedUserId|callAttempts|lastCallId|lastDisposition|lastAttemptAt|nextEligibleAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "callListId", "leadId", "leadPhoneId", "status", "phoneNumber", "firstName", "lastName", "emailAddress", "companyName", "companyWebsiteUrl", "jobTitle", "personalLinkedInUrl", "companyLinkedInUrl", "locality", "region", "country", "timezone", "customFieldValues", "assignedUserId", "callAttempts", "lastCallId", "lastDisposition", "lastAttemptAt", "nextEligibleAt", "createdAt", "updatedAt" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "numbersImported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "imported", "numbersImported", "skipped" ], "patternProperties": { "^(?!(?:imported|numbersImported|skipped)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "imported", "numbersImported", "skipped" ] } }, { "type": "object", "properties": { "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "numbersImported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalRecords": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sourceName": { "$ref": "#/$defs/ShortText" } }, "required": [ "imported", "numbersImported", "skipped", "totalRecords", "sourceName" ], "patternProperties": { "^(?!(?:imported|numbersImported|skipped|totalRecords|sourceName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "imported", "numbersImported", "skipped", "totalRecords", "sourceName" ] } }, { "type": "object", "properties": { "callListId": { "$ref": "#/$defs/CallListId" }, "deletedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "callListId", "deletedAt" ], "patternProperties": { "^(?!(?:callListId|deletedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "callListId", "deletedAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/CallListId" }, "name": { "$ref": "#/$defs/ShortText" }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "customFieldNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "systemType": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "sequence_tasks" ] } ] }, { "type": "null" } ] }, "contactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "defaultTimezone", "customFieldNames", "systemType", "contactCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|defaultTimezone|customFieldNames|systemType|contactCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "defaultTimezone", "customFieldNames", "systemType", "contactCount", "createdAt", "updatedAt" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/CallListId" }, "name": { "$ref": "#/$defs/ShortText" }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "customFieldNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "systemType": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "sequence_tasks" ] } ] }, { "type": "null" } ] }, "contactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "defaultTimezone", "customFieldNames", "systemType", "contactCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|defaultTimezone|customFieldNames|systemType|contactCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "defaultTimezone", "customFieldNames", "systemType", "contactCount", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/CallListContactId" }, "callListId": { "$ref": "#/$defs/CallListId" }, "leadId": { "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" } ] }, "leadPhoneId": { "anyOf": [ { "$ref": "#/$defs/LeadPhoneId" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "not_called", "queued", "in_progress", "called", "completed", "skipped", "callback", "dnc", "failed" ] }, "phoneNumber": { "$ref": "#/$defs/E164PhoneNumber" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "locality": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/IanaTimeZone" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": true }, "assignedUserId": { "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" } ] }, "callAttempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastCallId": { "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" } ] }, "lastDisposition": { "anyOf": [ { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, { "type": "null" } ] }, "lastAttemptAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "nextEligibleAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "callListId", "leadId", "leadPhoneId", "status", "phoneNumber", "firstName", "lastName", "emailAddress", "companyName", "companyWebsiteUrl", "jobTitle", "personalLinkedInUrl", "companyLinkedInUrl", "locality", "region", "country", "timezone", "customFieldValues", "assignedUserId", "callAttempts", "lastCallId", "lastDisposition", "lastAttemptAt", "nextEligibleAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|callListId|leadId|leadPhoneId|status|phoneNumber|firstName|lastName|emailAddress|companyName|companyWebsiteUrl|jobTitle|personalLinkedInUrl|companyLinkedInUrl|locality|region|country|timezone|customFieldValues|assignedUserId|callAttempts|lastCallId|lastDisposition|lastAttemptAt|nextEligibleAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "callListId", "leadId", "leadPhoneId", "status", "phoneNumber", "firstName", "lastName", "emailAddress", "companyName", "companyWebsiteUrl", "jobTitle", "personalLinkedInUrl", "companyLinkedInUrl", "locality", "region", "country", "timezone", "customFieldValues", "assignedUserId", "callAttempts", "lastCallId", "lastDisposition", "lastAttemptAt", "nextEligibleAt", "createdAt", "updatedAt" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "numbersImported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "imported", "numbersImported", "skipped" ], "patternProperties": { "^(?!(?:imported|numbersImported|skipped)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "imported", "numbersImported", "skipped" ] } }, { "type": "object", "properties": { "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "numbersImported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalRecords": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sourceName": { "$ref": "#/$defs/ShortText" } }, "required": [ "imported", "numbersImported", "skipped", "totalRecords", "sourceName" ], "patternProperties": { "^(?!(?:imported|numbersImported|skipped|totalRecords|sourceName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "imported", "numbersImported", "skipped", "totalRecords", "sourceName" ] } }, { "type": "object", "properties": { "callListId": { "$ref": "#/$defs/CallListId" }, "deletedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "callListId", "deletedAt" ], "patternProperties": { "^(?!(?:callListId|deletedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "callListId", "deletedAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `dialerCallLists.list`: `GET /v1/workspaces/:workspaceId/dialer/call-lists` - `dialerCallLists.get`: `GET /v1/workspaces/:workspaceId/dialer/call-lists/:callListId` - `dialerCallLists.create`: `POST /v1/workspaces/:workspaceId/dialer/call-lists` - `dialerCallLists.update`: `PATCH /v1/workspaces/:workspaceId/dialer/call-lists/:callListId` - `dialerCallLists.duplicate`: `POST /v1/workspaces/:workspaceId/dialer/call-lists/:callListId/duplicate` - `dialerCallLists.delete`: `DELETE /v1/workspaces/:workspaceId/dialer/call-lists/:callListId` - `dialerCallContacts.list`: `GET /v1/workspaces/:workspaceId/dialer/call-lists/:callListId/contacts` - `dialerCallContacts.importCsv`: `POST /v1/workspaces/:workspaceId/dialer/call-lists/:callListId/contacts/import` - `dialerCallContacts.importAttioList`: `POST /v1/workspaces/:workspaceId/dialer/call-lists/:callListId/contacts/import-attio` ## manage_campaign_delivery Resume future steps or stop a currently held campaign enrollment after a delivery delay. Use only after inspecting the delivery record and explicitly choosing the action; both actions target the historical send that holds the current enrollment. Do not use this to resend the delayed message or to override an unrelated reply, unsubscribe, manual stop, or newer enrollment pass. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: campaign:update Risk: write; confirmation: explicit; idempotency: required. ### 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" }, "campaignId": { "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" }, "sendHistoryId": { "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": [ "resume", "stop" ] } }, "required": [ "workspaceId", "campaignId", "sendHistoryId", "action" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|sendHistoryId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "sendHistoryId", "action" ] } } ``` ### 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" }, "campaignId": { "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" }, "sendHistoryId": { "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": [ "resume", "stop" ] } }, "required": [ "workspaceId", "campaignId", "sendHistoryId", "action" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|sendHistoryId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "sendHistoryId", "action" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "delivery": { "type": "object", "properties": { "sendHistoryId": { "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" }, "campaignId": { "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" }, "campaignContactId": { "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" }, "recipientEmail": { "$ref": "#/$defs/EmailAddress" }, "pass": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outcome": { "type": "string", "enum": [ "pending", "delivered", "failed", "unconfirmed" ] }, "cause": { "type": "string", "enum": [ "sender", "recipient", "unclassified" ] }, "failureCharacter": { "type": "string", "enum": [ "temporary", "permanent", "unknown" ] }, "sequenceDisposition": { "anyOf": [ { "type": "string", "enum": [ "held", "continued", "resumed", "stopped" ] }, { "type": "null" } ] }, "firstDelayedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastEvidenceAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "monitoringEndsAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "providerRetryUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "confirmedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "outcomeAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "conflictingEvidence": { "type": "boolean" }, "canResume": { "type": "boolean" }, "canStop": { "type": "boolean" } }, "required": [ "sendHistoryId", "campaignId", "campaignContactId", "recipientEmail", "pass", "outcome", "cause", "failureCharacter", "sequenceDisposition", "firstDelayedAt", "lastEvidenceAt", "monitoringEndsAt", "providerRetryUntil", "confirmedAt", "outcomeAt", "conflictingEvidence", "canResume", "canStop" ], "patternProperties": { "^(?!(?:sendHistoryId|campaignId|campaignContactId|recipientEmail|pass|outcome|cause|failureCharacter|sequenceDisposition|firstDelayedAt|lastEvidenceAt|monitoringEndsAt|providerRetryUntil|confirmedAt|outcomeAt|conflictingEvidence|canResume|canStop)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sendHistoryId", "campaignId", "campaignContactId", "recipientEmail", "pass", "outcome", "cause", "failureCharacter", "sequenceDisposition", "firstDelayedAt", "lastEvidenceAt", "monitoringEndsAt", "providerRetryUntil", "confirmedAt", "outcomeAt", "conflictingEvidence", "canResume", "canStop" ] } } }, "required": [ "delivery" ], "patternProperties": { "^(?!(?:delivery)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "delivery" ] } ] }, "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `campaignDelivery.resume`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/delivery/:sendHistoryId/resume` - `campaignDelivery.stop`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/delivery/:sendHistoryId/stop` ## manage_campaign_notes Read and write the titled markdown notes attached to a campaign — briefs, strategy, retros. Use to record the reasoning behind a campaign change where the team will find it later. Notes are visible to everyone who can read the campaign; do not put credentials or personal data in them. Scopes: campaign:read, campaign:update Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "get", "create", "update", "delete" ] }, "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" }, "campaignId": { "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" }, "note": { "anyOf": [ { "type": "object", "properties": { "title": { "$ref": "#/$defs/ShortText" }, "content": { "$ref": "#/$defs/CampaignNoteContent" } }, "patternProperties": { "^(?!(?:title|content)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "title", "content" ] } }, { "type": "object", "properties": { "title": { "$ref": "#/$defs/ShortText" }, "content": { "$ref": "#/$defs/CampaignNoteContent" } }, "patternProperties": { "^(?!(?:title|content)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "title", "content" ] }, "minProperties": 1, "maxProperties": 2 } ] }, "noteId": { "type": "string" } }, "required": [ "action", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|note|noteId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "note", "noteId" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "CampaignNoteContent": { "type": "string", "maxLength": 100000 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "get", "create", "update", "delete" ] }, "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" }, "campaignId": { "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" }, "note": { "anyOf": [ { "type": "object", "properties": { "title": { "$ref": "#/$defs/ShortText" }, "content": { "$ref": "#/$defs/CampaignNoteContent" } }, "patternProperties": { "^(?!(?:title|content)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "title", "content" ] } }, { "type": "object", "properties": { "title": { "$ref": "#/$defs/ShortText" }, "content": { "$ref": "#/$defs/CampaignNoteContent" } }, "patternProperties": { "^(?!(?:title|content)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "title", "content" ] }, "minProperties": 1, "maxProperties": 2 } ] }, "noteId": { "type": "string" } }, "required": [ "action", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|note|noteId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "note", "noteId" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "CampaignNoteContent": { "type": "string", "maxLength": 100000 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "CampaignNoteContent": { "type": "string", "maxLength": 100000 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "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" }, "campaignId": { "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" }, "title": { "$ref": "#/$defs/ShortText" }, "content": { "$ref": "#/$defs/CampaignNoteContent" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "campaignId", "title", "content", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|campaignId|title|content|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "campaignId", "title", "content", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "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" }, "campaignId": { "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" }, "title": { "$ref": "#/$defs/ShortText" }, "content": { "$ref": "#/$defs/CampaignNoteContent" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "campaignId", "title", "content", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|campaignId|title|content|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "campaignId", "title", "content", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "noteId": { "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" }, "deleted": { "type": "boolean" } }, "required": [ "noteId", "deleted" ], "patternProperties": { "^(?!(?:noteId|deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "noteId", "deleted" ] } } ] }, { "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" }, "campaignId": { "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" }, "title": { "$ref": "#/$defs/ShortText" }, "content": { "$ref": "#/$defs/CampaignNoteContent" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "campaignId", "title", "content", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|campaignId|title|content|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "campaignId", "title", "content", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "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" }, "campaignId": { "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" }, "title": { "$ref": "#/$defs/ShortText" }, "content": { "$ref": "#/$defs/CampaignNoteContent" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "campaignId", "title", "content", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|campaignId|title|content|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "campaignId", "title", "content", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "noteId": { "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" }, "deleted": { "type": "boolean" } }, "required": [ "noteId", "deleted" ], "patternProperties": { "^(?!(?:noteId|deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "noteId", "deleted" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaignNotes.list`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/notes` - `campaignNotes.get`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/notes/:noteId` - `campaignNotes.create`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/notes` - `campaignNotes.update`: `PATCH /v1/workspaces/:workspaceId/campaigns/:campaignId/notes/:noteId` - `campaignNotes.delete`: `DELETE /v1/workspaces/:workspaceId/campaigns/:campaignId/notes/:noteId` ## manage_campaign_schedule Read and save a campaign's sending schedule, and manage the reusable schedule presets a campaign can follow. Use after reading the schedule, echoing back the schedule version it returned so a concurrent propagation cannot be silently swallowed. Editing a preset never changes a campaign; propagating is a separate, explicit act that reaches only the campaigns still following it. Deleting a preset only unlinks — it never deletes or blanks a campaign's schedule. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: campaign:read, campaign:create, campaign:update, campaign:delete Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "get", "update", "profiles", "create_profile", "update_profile", "propagate", "set_default", "delete_profile" ] }, "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" }, "campaignId": { "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" }, "schedule": { "anyOf": [ { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "exclusiveMinimum": 0 }, "rampUpDailyIncrement": { "type": "integer", "exclusiveMinimum": 0 }, "scheduleProfileId": { "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" } ] }, "expectedScheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|scheduleProfileId|expectedScheduleVersion)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "scheduleProfileId", "expectedScheduleVersion" ] }, "minProperties": 1, "maxProperties": 19 }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } } }, "required": [ "name", "settings" ], "patternProperties": { "^(?!(?:name|isDefault|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "isDefault", "settings" ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } } }, "patternProperties": { "^(?!(?:name|isDefault|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "isDefault", "settings" ] } }, { "type": "object", "properties": { "parentId": { "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" } ] } }, "required": [ "parentId" ], "patternProperties": { "^(?!(?:parentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "parentId" ] } ] } }, { "type": "object", "properties": { "campaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "folderId": { "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" } ] } }, "required": [ "campaignIds", "folderId" ], "patternProperties": { "^(?!(?:campaignIds|folderId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignIds", "folderId" ] } } ] }, "profileId": { "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", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|schedule|profileId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "schedule", "profileId" ] }, "$defs": { "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HolidayCalendarCode": { "type": "string", "pattern": "^[A-Z]{2}$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "get", "update", "profiles", "create_profile", "update_profile", "propagate", "set_default", "delete_profile" ] }, "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" }, "campaignId": { "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" }, "schedule": { "anyOf": [ { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "exclusiveMinimum": 0 }, "rampUpDailyIncrement": { "type": "integer", "exclusiveMinimum": 0 }, "scheduleProfileId": { "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" } ] }, "expectedScheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|scheduleProfileId|expectedScheduleVersion)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "scheduleProfileId", "expectedScheduleVersion" ] }, "minProperties": 1, "maxProperties": 19 }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } } }, "required": [ "name", "settings" ], "patternProperties": { "^(?!(?:name|isDefault|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "isDefault", "settings" ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } } }, "patternProperties": { "^(?!(?:name|isDefault|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "isDefault", "settings" ] } }, { "type": "object", "properties": { "parentId": { "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" } ] } }, "required": [ "parentId" ], "patternProperties": { "^(?!(?:parentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "parentId" ] } ] } }, { "type": "object", "properties": { "campaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "folderId": { "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" } ] } }, "required": [ "campaignIds", "folderId" ], "patternProperties": { "^(?!(?:campaignIds|folderId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignIds", "folderId" ] } } ] }, "profileId": { "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", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|schedule|profileId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "schedule", "profileId" ] }, "$defs": { "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HolidayCalendarCode": { "type": "string", "pattern": "^[A-Z]{2}$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HolidayCalendarCode": { "type": "string", "pattern": "^[A-Z]{2}$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "campaignId": { "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" }, "scheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scheduleProfileId": { "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" } ] }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpDailyIncrement": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpCompletedSendingDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "effectiveMaxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ], "patternProperties": { "^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ] } }, { "type": "object", "properties": { "schedule": { "type": "object", "properties": { "campaignId": { "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" }, "scheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scheduleProfileId": { "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" } ] }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpDailyIncrement": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpCompletedSendingDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "effectiveMaxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ], "patternProperties": { "^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ] } }, "unlinkedFrom": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] } }, "required": [ "schedule", "unlinkedFrom" ], "patternProperties": { "^(?!(?:schedule|unlinkedFrom)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schedule", "unlinkedFrom" ] } }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "linkedCampaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|isDefault|linkedCampaignCount|settings|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "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" }, "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" }, "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "linkedCampaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|isDefault|linkedCampaignCount|settings|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "profileId": { "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" }, "profileName": { "$ref": "#/$defs/ShortText" }, "reached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "profileId", "profileName", "reached" ], "patternProperties": { "^(?!(?:profileId|profileName|reached)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileId", "profileName", "reached" ] } }, { "type": "object", "properties": { "profileId": { "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" }, "unlinkedCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "profileId", "unlinkedCampaigns" ], "patternProperties": { "^(?!(?:profileId|unlinkedCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileId", "unlinkedCampaigns" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "campaignId": { "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" }, "scheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scheduleProfileId": { "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" } ] }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpDailyIncrement": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpCompletedSendingDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "effectiveMaxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ], "patternProperties": { "^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ] } }, { "type": "object", "properties": { "schedule": { "type": "object", "properties": { "campaignId": { "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" }, "scheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scheduleProfileId": { "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" } ] }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpDailyIncrement": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpCompletedSendingDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "effectiveMaxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ], "patternProperties": { "^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ] } }, "unlinkedFrom": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] } }, "required": [ "schedule", "unlinkedFrom" ], "patternProperties": { "^(?!(?:schedule|unlinkedFrom)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schedule", "unlinkedFrom" ] } }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "linkedCampaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|isDefault|linkedCampaignCount|settings|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "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" }, "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" }, "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "linkedCampaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|isDefault|linkedCampaignCount|settings|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "profileId": { "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" }, "profileName": { "$ref": "#/$defs/ShortText" }, "reached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "profileId", "profileName", "reached" ], "patternProperties": { "^(?!(?:profileId|profileName|reached)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileId", "profileName", "reached" ] } }, { "type": "object", "properties": { "profileId": { "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" }, "unlinkedCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "profileId", "unlinkedCampaigns" ], "patternProperties": { "^(?!(?:profileId|unlinkedCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileId", "unlinkedCampaigns" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaigns.getSchedule`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/schedule` - `campaigns.updateSchedule`: `PATCH /v1/workspaces/:workspaceId/campaigns/:campaignId/schedule` - `campaignScheduleProfiles.list`: `GET /v1/workspaces/:workspaceId/campaign-schedule-profiles` - `campaignScheduleProfiles.create`: `POST /v1/workspaces/:workspaceId/campaign-schedule-profiles` - `campaignScheduleProfiles.update`: `PATCH /v1/workspaces/:workspaceId/campaign-schedule-profiles/:profileId` - `campaignScheduleProfiles.propagate`: `POST /v1/workspaces/:workspaceId/campaign-schedule-profiles/:profileId/propagate` - `campaignScheduleProfiles.setDefault`: `POST /v1/workspaces/:workspaceId/campaign-schedule-profiles/:profileId/default` - `campaignScheduleProfiles.delete`: `DELETE /v1/workspaces/:workspaceId/campaign-schedule-profiles/:profileId` ## manage_campaigns Create, duplicate, rename, retag, file, transition, configure, and delete campaigns. A requested pause records manual intent, including when already bounce-paused. Use to set a campaign up or change how it sends, after read_campaign_setup has shown what is already there. Activating a campaign enforces the send prerequisites and the subscription gate; do not use this to work around either. Turning the contact waterfall off is refused while contacts sit on a later address, and that refusal must be reported, not retried. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: campaign:create, campaign:update, campaign:delete Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create", "duplicate", "update", "update_settings", "delete" ] }, "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" }, "campaignId": { "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" }, "create": { "anyOf": [ { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "folderId": { "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" } ] }, "parentCampaignId": { "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" } ] } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|folderId|parentCampaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "folderId", "parentCampaignId" ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" } }, "patternProperties": { "^(?!(?:name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "name" ] } ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "folderId": { "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" } ] }, "newLeadPriority": { "type": "integer", "minimum": 0, "maximum": 100 }, "espMatchMode": { "type": "string", "enum": [ "off", "match_then_spill", "match_only" ] } }, "patternProperties": { "^(?!(?:name|status|folderId|newLeadPriority|espMatchMode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "status", "folderId", "newLeadPriority", "espMatchMode" ] }, "minProperties": 1, "maxProperties": 5 }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 }, "tagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 50 }, "settings": { "type": "object", "properties": { "newLeadPriority": { "type": "integer", "minimum": 0, "maximum": 100 }, "espMatchMode": { "type": "string", "enum": [ "off", "match_then_spill", "match_only" ] }, "opportunityValue": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stopSendingOnReply": { "type": "boolean" }, "continueSendingOnAutomaticReply": { "type": "boolean" }, "defaultDelayDaysForAutomaticReply": { "type": "integer", "exclusiveMinimum": 0 }, "stopSendingOnSameDomainReply": { "type": "boolean" }, "openRateTracking": { "type": "boolean" }, "unsubscribeLink": { "type": "boolean" }, "addUnsubscribedLeadsToBlockList": { "type": "boolean" }, "sendAsPlainText": { "type": "boolean" }, "sendRiskyEmails": { "type": "boolean" }, "skipSegEmails": { "type": "boolean" }, "autoPauseOnHighBounceRate": { "type": "boolean" }, "continueOnSoftBounce": { "type": "boolean" }, "softBounceMonitoringDays": { "type": "integer", "minimum": 1, "maximum": 30 }, "highBounceRateThreshold": { "type": "integer", "minimum": 0, "maximum": 100 }, "fallbackSendingForRemovedInboxes": { "type": "boolean" }, "fallbackSendingForErroredInboxes": { "type": "boolean" }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "waterfallEnabled": { "type": "boolean" }, "waterfallPassGapDays": { "type": "integer", "minimum": 1, "maximum": 90 }, "waterfallResponseFreeze": { "type": "string", "enum": [ "freeze_ladder", "contact_only" ] }, "quotedChainAttribution": { "type": "string", "enum": [ "current_sender", "original" ] }, "ignoreInboxSendLimits": { "type": "boolean" }, "ccEmails": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, { "type": "null" } ] }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:newLeadPriority|espMatchMode|opportunityValue|stopSendingOnReply|continueSendingOnAutomaticReply|defaultDelayDaysForAutomaticReply|stopSendingOnSameDomainReply|openRateTracking|unsubscribeLink|addUnsubscribedLeadsToBlockList|sendAsPlainText|sendRiskyEmails|skipSegEmails|autoPauseOnHighBounceRate|continueOnSoftBounce|softBounceMonitoringDays|highBounceRateThreshold|fallbackSendingForRemovedInboxes|fallbackSendingForErroredInboxes|dailyCapPerRecipientDomain|waterfallEnabled|waterfallPassGapDays|waterfallResponseFreeze|quotedChainAttribution|ignoreInboxSendLimits|ccEmails|initialDelayMinutes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "newLeadPriority", "espMatchMode", "opportunityValue", "stopSendingOnReply", "continueSendingOnAutomaticReply", "defaultDelayDaysForAutomaticReply", "stopSendingOnSameDomainReply", "openRateTracking", "unsubscribeLink", "addUnsubscribedLeadsToBlockList", "sendAsPlainText", "sendRiskyEmails", "skipSegEmails", "autoPauseOnHighBounceRate", "continueOnSoftBounce", "softBounceMonitoringDays", "highBounceRateThreshold", "fallbackSendingForRemovedInboxes", "fallbackSendingForErroredInboxes", "dailyCapPerRecipientDomain", "waterfallEnabled", "waterfallPassGapDays", "waterfallResponseFreeze", "quotedChainAttribution", "ignoreInboxSendLimits", "ccEmails", "initialDelayMinutes" ] } } }, "patternProperties": { "^(?!(?:name|inboxIds|tagIds|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "inboxIds", "tagIds", "settings" ] }, "minProperties": 1, "maxProperties": 4 } ] } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|create)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "create" ] }, "$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": { "action": { "type": "string", "enum": [ "create", "duplicate", "update", "update_settings", "delete" ] }, "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" }, "campaignId": { "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" }, "create": { "anyOf": [ { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "folderId": { "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" } ] }, "parentCampaignId": { "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" } ] } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|folderId|parentCampaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "folderId", "parentCampaignId" ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" } }, "patternProperties": { "^(?!(?:name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "name" ] } ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "folderId": { "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" } ] }, "newLeadPriority": { "type": "integer", "minimum": 0, "maximum": 100 }, "espMatchMode": { "type": "string", "enum": [ "off", "match_then_spill", "match_only" ] } }, "patternProperties": { "^(?!(?:name|status|folderId|newLeadPriority|espMatchMode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "status", "folderId", "newLeadPriority", "espMatchMode" ] }, "minProperties": 1, "maxProperties": 5 }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 }, "tagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 50 }, "settings": { "type": "object", "properties": { "newLeadPriority": { "type": "integer", "minimum": 0, "maximum": 100 }, "espMatchMode": { "type": "string", "enum": [ "off", "match_then_spill", "match_only" ] }, "opportunityValue": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stopSendingOnReply": { "type": "boolean" }, "continueSendingOnAutomaticReply": { "type": "boolean" }, "defaultDelayDaysForAutomaticReply": { "type": "integer", "exclusiveMinimum": 0 }, "stopSendingOnSameDomainReply": { "type": "boolean" }, "openRateTracking": { "type": "boolean" }, "unsubscribeLink": { "type": "boolean" }, "addUnsubscribedLeadsToBlockList": { "type": "boolean" }, "sendAsPlainText": { "type": "boolean" }, "sendRiskyEmails": { "type": "boolean" }, "skipSegEmails": { "type": "boolean" }, "autoPauseOnHighBounceRate": { "type": "boolean" }, "continueOnSoftBounce": { "type": "boolean" }, "softBounceMonitoringDays": { "type": "integer", "minimum": 1, "maximum": 30 }, "highBounceRateThreshold": { "type": "integer", "minimum": 0, "maximum": 100 }, "fallbackSendingForRemovedInboxes": { "type": "boolean" }, "fallbackSendingForErroredInboxes": { "type": "boolean" }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "waterfallEnabled": { "type": "boolean" }, "waterfallPassGapDays": { "type": "integer", "minimum": 1, "maximum": 90 }, "waterfallResponseFreeze": { "type": "string", "enum": [ "freeze_ladder", "contact_only" ] }, "quotedChainAttribution": { "type": "string", "enum": [ "current_sender", "original" ] }, "ignoreInboxSendLimits": { "type": "boolean" }, "ccEmails": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, { "type": "null" } ] }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:newLeadPriority|espMatchMode|opportunityValue|stopSendingOnReply|continueSendingOnAutomaticReply|defaultDelayDaysForAutomaticReply|stopSendingOnSameDomainReply|openRateTracking|unsubscribeLink|addUnsubscribedLeadsToBlockList|sendAsPlainText|sendRiskyEmails|skipSegEmails|autoPauseOnHighBounceRate|continueOnSoftBounce|softBounceMonitoringDays|highBounceRateThreshold|fallbackSendingForRemovedInboxes|fallbackSendingForErroredInboxes|dailyCapPerRecipientDomain|waterfallEnabled|waterfallPassGapDays|waterfallResponseFreeze|quotedChainAttribution|ignoreInboxSendLimits|ccEmails|initialDelayMinutes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "newLeadPriority", "espMatchMode", "opportunityValue", "stopSendingOnReply", "continueSendingOnAutomaticReply", "defaultDelayDaysForAutomaticReply", "stopSendingOnSameDomainReply", "openRateTracking", "unsubscribeLink", "addUnsubscribedLeadsToBlockList", "sendAsPlainText", "sendRiskyEmails", "skipSegEmails", "autoPauseOnHighBounceRate", "continueOnSoftBounce", "softBounceMonitoringDays", "highBounceRateThreshold", "fallbackSendingForRemovedInboxes", "fallbackSendingForErroredInboxes", "dailyCapPerRecipientDomain", "waterfallEnabled", "waterfallPassGapDays", "waterfallResponseFreeze", "quotedChainAttribution", "ignoreInboxSendLimits", "ccEmails", "initialDelayMinutes" ] } } }, "patternProperties": { "^(?!(?:name|inboxIds|tagIds|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "inboxIds", "tagIds", "settings" ] }, "minProperties": 1, "maxProperties": 4 } ] } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|create)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "create" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "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": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "campaign", "subsequence", "sequence" ] }, "folderId": { "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" } ] }, "parentCampaignId": { "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" } ] }, "scheduleProfileId": { "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" } ] }, "tags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "status", "kind", "folderId", "parentCampaignId", "scheduleProfileId", "tags", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|status|pauseContext|kind|folderId|parentCampaignId|scheduleProfileId|tags|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "status", "pauseContext", "kind", "folderId", "parentCampaignId", "scheduleProfileId", "tags", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "campaign": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "campaign", "subsequence", "sequence" ] }, "folderId": { "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" } ] }, "parentCampaignId": { "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" } ] }, "scheduleProfileId": { "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" } ] }, "tags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "status", "kind", "folderId", "parentCampaignId", "scheduleProfileId", "tags", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|status|pauseContext|kind|folderId|parentCampaignId|scheduleProfileId|tags|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "status", "pauseContext", "kind", "folderId", "parentCampaignId", "scheduleProfileId", "tags", "createdAt", "updatedAt" ] } }, "settings": { "type": "object", "properties": { "newLeadPriority": { "type": "integer", "minimum": 0, "maximum": 100 }, "espMatchMode": { "type": "string", "enum": [ "off", "match_then_spill", "match_only" ] }, "opportunityValue": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stopSendingOnReply": { "type": "boolean" }, "continueSendingOnAutomaticReply": { "type": "boolean" }, "defaultDelayDaysForAutomaticReply": { "type": "integer", "exclusiveMinimum": 0 }, "stopSendingOnSameDomainReply": { "type": "boolean" }, "openRateTracking": { "type": "boolean" }, "unsubscribeLink": { "type": "boolean" }, "addUnsubscribedLeadsToBlockList": { "type": "boolean" }, "sendAsPlainText": { "type": "boolean" }, "sendRiskyEmails": { "type": "boolean" }, "skipSegEmails": { "type": "boolean" }, "autoPauseOnHighBounceRate": { "type": "boolean" }, "continueOnSoftBounce": { "type": "boolean" }, "softBounceMonitoringDays": { "type": "integer", "minimum": 1, "maximum": 30 }, "highBounceRateThreshold": { "type": "integer", "minimum": 0, "maximum": 100 }, "fallbackSendingForRemovedInboxes": { "type": "boolean" }, "fallbackSendingForErroredInboxes": { "type": "boolean" }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "waterfallEnabled": { "type": "boolean" }, "waterfallPassGapDays": { "type": "integer", "minimum": 1, "maximum": 90 }, "waterfallResponseFreeze": { "type": "string", "enum": [ "freeze_ladder", "contact_only" ] }, "quotedChainAttribution": { "type": "string", "enum": [ "current_sender", "original" ] }, "ignoreInboxSendLimits": { "type": "boolean" }, "ccEmails": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, { "type": "null" } ] }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] } }, "required": [ "newLeadPriority", "espMatchMode", "opportunityValue", "stopSendingOnReply", "continueSendingOnAutomaticReply", "defaultDelayDaysForAutomaticReply", "stopSendingOnSameDomainReply", "openRateTracking", "unsubscribeLink", "addUnsubscribedLeadsToBlockList", "sendAsPlainText", "sendRiskyEmails", "skipSegEmails", "autoPauseOnHighBounceRate", "continueOnSoftBounce", "softBounceMonitoringDays", "highBounceRateThreshold", "fallbackSendingForRemovedInboxes", "fallbackSendingForErroredInboxes", "dailyCapPerRecipientDomain", "waterfallEnabled", "waterfallPassGapDays", "waterfallResponseFreeze", "quotedChainAttribution", "ignoreInboxSendLimits", "ccEmails", "initialDelayMinutes" ], "patternProperties": { "^(?!(?:newLeadPriority|espMatchMode|opportunityValue|stopSendingOnReply|continueSendingOnAutomaticReply|defaultDelayDaysForAutomaticReply|stopSendingOnSameDomainReply|openRateTracking|unsubscribeLink|addUnsubscribedLeadsToBlockList|sendAsPlainText|sendRiskyEmails|skipSegEmails|autoPauseOnHighBounceRate|continueOnSoftBounce|softBounceMonitoringDays|highBounceRateThreshold|fallbackSendingForRemovedInboxes|fallbackSendingForErroredInboxes|dailyCapPerRecipientDomain|waterfallEnabled|waterfallPassGapDays|waterfallResponseFreeze|quotedChainAttribution|ignoreInboxSendLimits|ccEmails|initialDelayMinutes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "newLeadPriority", "espMatchMode", "opportunityValue", "stopSendingOnReply", "continueSendingOnAutomaticReply", "defaultDelayDaysForAutomaticReply", "stopSendingOnSameDomainReply", "openRateTracking", "unsubscribeLink", "addUnsubscribedLeadsToBlockList", "sendAsPlainText", "sendRiskyEmails", "skipSegEmails", "autoPauseOnHighBounceRate", "continueOnSoftBounce", "softBounceMonitoringDays", "highBounceRateThreshold", "fallbackSendingForRemovedInboxes", "fallbackSendingForErroredInboxes", "dailyCapPerRecipientDomain", "waterfallEnabled", "waterfallPassGapDays", "waterfallResponseFreeze", "quotedChainAttribution", "ignoreInboxSendLimits", "ccEmails", "initialDelayMinutes" ] } } }, "required": [ "campaign", "settings" ], "patternProperties": { "^(?!(?:campaign|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaign", "settings" ] } }, { "type": "object", "properties": { "campaignId": { "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" }, "deleted": { "type": "boolean" } }, "required": [ "campaignId", "deleted" ], "patternProperties": { "^(?!(?:campaignId|deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "deleted" ] } } ] }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "campaign", "subsequence", "sequence" ] }, "folderId": { "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" } ] }, "parentCampaignId": { "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" } ] }, "scheduleProfileId": { "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" } ] }, "tags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "status", "kind", "folderId", "parentCampaignId", "scheduleProfileId", "tags", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|status|pauseContext|kind|folderId|parentCampaignId|scheduleProfileId|tags|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "status", "pauseContext", "kind", "folderId", "parentCampaignId", "scheduleProfileId", "tags", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "campaign": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "campaign", "subsequence", "sequence" ] }, "folderId": { "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" } ] }, "parentCampaignId": { "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" } ] }, "scheduleProfileId": { "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" } ] }, "tags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "status", "kind", "folderId", "parentCampaignId", "scheduleProfileId", "tags", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|status|pauseContext|kind|folderId|parentCampaignId|scheduleProfileId|tags|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "status", "pauseContext", "kind", "folderId", "parentCampaignId", "scheduleProfileId", "tags", "createdAt", "updatedAt" ] } }, "settings": { "type": "object", "properties": { "newLeadPriority": { "type": "integer", "minimum": 0, "maximum": 100 }, "espMatchMode": { "type": "string", "enum": [ "off", "match_then_spill", "match_only" ] }, "opportunityValue": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stopSendingOnReply": { "type": "boolean" }, "continueSendingOnAutomaticReply": { "type": "boolean" }, "defaultDelayDaysForAutomaticReply": { "type": "integer", "exclusiveMinimum": 0 }, "stopSendingOnSameDomainReply": { "type": "boolean" }, "openRateTracking": { "type": "boolean" }, "unsubscribeLink": { "type": "boolean" }, "addUnsubscribedLeadsToBlockList": { "type": "boolean" }, "sendAsPlainText": { "type": "boolean" }, "sendRiskyEmails": { "type": "boolean" }, "skipSegEmails": { "type": "boolean" }, "autoPauseOnHighBounceRate": { "type": "boolean" }, "continueOnSoftBounce": { "type": "boolean" }, "softBounceMonitoringDays": { "type": "integer", "minimum": 1, "maximum": 30 }, "highBounceRateThreshold": { "type": "integer", "minimum": 0, "maximum": 100 }, "fallbackSendingForRemovedInboxes": { "type": "boolean" }, "fallbackSendingForErroredInboxes": { "type": "boolean" }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "waterfallEnabled": { "type": "boolean" }, "waterfallPassGapDays": { "type": "integer", "minimum": 1, "maximum": 90 }, "waterfallResponseFreeze": { "type": "string", "enum": [ "freeze_ladder", "contact_only" ] }, "quotedChainAttribution": { "type": "string", "enum": [ "current_sender", "original" ] }, "ignoreInboxSendLimits": { "type": "boolean" }, "ccEmails": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, { "type": "null" } ] }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] } }, "required": [ "newLeadPriority", "espMatchMode", "opportunityValue", "stopSendingOnReply", "continueSendingOnAutomaticReply", "defaultDelayDaysForAutomaticReply", "stopSendingOnSameDomainReply", "openRateTracking", "unsubscribeLink", "addUnsubscribedLeadsToBlockList", "sendAsPlainText", "sendRiskyEmails", "skipSegEmails", "autoPauseOnHighBounceRate", "continueOnSoftBounce", "softBounceMonitoringDays", "highBounceRateThreshold", "fallbackSendingForRemovedInboxes", "fallbackSendingForErroredInboxes", "dailyCapPerRecipientDomain", "waterfallEnabled", "waterfallPassGapDays", "waterfallResponseFreeze", "quotedChainAttribution", "ignoreInboxSendLimits", "ccEmails", "initialDelayMinutes" ], "patternProperties": { "^(?!(?:newLeadPriority|espMatchMode|opportunityValue|stopSendingOnReply|continueSendingOnAutomaticReply|defaultDelayDaysForAutomaticReply|stopSendingOnSameDomainReply|openRateTracking|unsubscribeLink|addUnsubscribedLeadsToBlockList|sendAsPlainText|sendRiskyEmails|skipSegEmails|autoPauseOnHighBounceRate|continueOnSoftBounce|softBounceMonitoringDays|highBounceRateThreshold|fallbackSendingForRemovedInboxes|fallbackSendingForErroredInboxes|dailyCapPerRecipientDomain|waterfallEnabled|waterfallPassGapDays|waterfallResponseFreeze|quotedChainAttribution|ignoreInboxSendLimits|ccEmails|initialDelayMinutes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "newLeadPriority", "espMatchMode", "opportunityValue", "stopSendingOnReply", "continueSendingOnAutomaticReply", "defaultDelayDaysForAutomaticReply", "stopSendingOnSameDomainReply", "openRateTracking", "unsubscribeLink", "addUnsubscribedLeadsToBlockList", "sendAsPlainText", "sendRiskyEmails", "skipSegEmails", "autoPauseOnHighBounceRate", "continueOnSoftBounce", "softBounceMonitoringDays", "highBounceRateThreshold", "fallbackSendingForRemovedInboxes", "fallbackSendingForErroredInboxes", "dailyCapPerRecipientDomain", "waterfallEnabled", "waterfallPassGapDays", "waterfallResponseFreeze", "quotedChainAttribution", "ignoreInboxSendLimits", "ccEmails", "initialDelayMinutes" ] } } }, "required": [ "campaign", "settings" ], "patternProperties": { "^(?!(?:campaign|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaign", "settings" ] } }, { "type": "object", "properties": { "campaignId": { "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" }, "deleted": { "type": "boolean" } }, "required": [ "campaignId", "deleted" ], "patternProperties": { "^(?!(?:campaignId|deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "deleted" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaigns.create`: `POST /v1/workspaces/:workspaceId/campaigns` - `campaigns.duplicate`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/duplicate` - `campaigns.update`: `PATCH /v1/workspaces/:workspaceId/campaigns/:campaignId` - `campaigns.updateSettings`: `PATCH /v1/workspaces/:workspaceId/campaigns/:campaignId/settings` - `campaigns.delete`: `DELETE /v1/workspaces/:workspaceId/campaigns/:campaignId` ## manage_custom_fields List, create, update, or delete the custom lead fields a workspace collects. Use to inspect or extend the workspace's lead schema before imports or enrichment rely on a field. Reserved lead property names are rejected; deleting a field drops its stored values. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspace:read, workspace:update Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "search": { "$ref": "#/$defs/ShortText" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|search|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "search", "cursor", "limit" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "input": { "type": "object", "properties": { "name": { "$ref": "#/$defs/CustomFieldName" }, "fieldType": { "type": "string", "enum": [ "text", "number", "date", "boolean", "url" ] }, "defaultValue": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|fieldType|defaultValue)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "fieldType", "defaultValue" ] } } }, "required": [ "workspaceId", "action", "input" ], "patternProperties": { "^(?!(?:workspaceId|action|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "input" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "customFieldId": { "type": "string", "minLength": 1, "maxLength": 64 }, "input": { "type": "object", "properties": { "name": { "$ref": "#/$defs/CustomFieldName" }, "fieldType": { "type": "string", "enum": [ "text", "number", "date", "boolean", "url" ] }, "defaultValue": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:name|fieldType|defaultValue)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "fieldType", "defaultValue" ] }, "minProperties": 1, "maxProperties": 3 } }, "required": [ "workspaceId", "action", "customFieldId", "input" ], "patternProperties": { "^(?!(?:workspaceId|action|customFieldId|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "customFieldId", "input" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "customFieldId": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "workspaceId", "action", "customFieldId" ], "patternProperties": { "^(?!(?:workspaceId|action|customFieldId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "customFieldId" ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "CustomFieldName": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" } } } ``` ### 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": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "search": { "$ref": "#/$defs/ShortText" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|search|cursor|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "search", "cursor", "limit" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "input": { "type": "object", "properties": { "name": { "$ref": "#/$defs/CustomFieldName" }, "fieldType": { "type": "string", "enum": [ "text", "number", "date", "boolean", "url" ] }, "defaultValue": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|fieldType|defaultValue)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "fieldType", "defaultValue" ] } } }, "required": [ "workspaceId", "action", "input" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|input)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "input" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "customFieldId": { "type": "string", "minLength": 1, "maxLength": 64 }, "input": { "type": "object", "properties": { "name": { "$ref": "#/$defs/CustomFieldName" }, "fieldType": { "type": "string", "enum": [ "text", "number", "date", "boolean", "url" ] }, "defaultValue": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:name|fieldType|defaultValue)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "fieldType", "defaultValue" ] }, "minProperties": 1, "maxProperties": 3 } }, "required": [ "workspaceId", "action", "customFieldId", "input" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|customFieldId|input)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "customFieldId", "input" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "customFieldId": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "workspaceId", "action", "customFieldId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|customFieldId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "customFieldId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "CustomFieldName": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "CustomFieldName": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "$ref": "#/$defs/CustomFieldName" }, "fieldType": { "type": "string", "enum": [ "text", "number", "date", "boolean", "url" ] }, "defaultValue": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "fieldType", "defaultValue", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|fieldType|defaultValue|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "fieldType", "defaultValue", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "$ref": "#/$defs/CustomFieldName" }, "fieldType": { "type": "string", "enum": [ "text", "number", "date", "boolean", "url" ] }, "defaultValue": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "fieldType", "defaultValue", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|fieldType|defaultValue|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "fieldType", "defaultValue", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "$ref": "#/$defs/CustomFieldName" }, "fieldType": { "type": "string", "enum": [ "text", "number", "date", "boolean", "url" ] }, "defaultValue": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "fieldType", "defaultValue", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|fieldType|defaultValue|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "fieldType", "defaultValue", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "$ref": "#/$defs/CustomFieldName" }, "fieldType": { "type": "string", "enum": [ "text", "number", "date", "boolean", "url" ] }, "defaultValue": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "fieldType", "defaultValue", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|fieldType|defaultValue|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "fieldType", "defaultValue", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `customFields.list`: `GET /v1/workspaces/:workspaceId/settings/custom-fields` - `customFields.create`: `POST /v1/workspaces/:workspaceId/settings/custom-fields` - `customFields.update`: `PATCH /v1/workspaces/:workspaceId/settings/custom-fields/:customFieldId` - `customFields.delete`: `DELETE /v1/workspaces/:workspaceId/settings/custom-fields/:customFieldId` ## manage_dialer_billing Read the dialer add-on's plan, seats, and metered minutes, and start a hosted checkout when more are needed. Use to report what the workspace is paying for and how much it has used, and to hand a human the checkout link when seats run out. The payment itself is completed by a person on the provider's hosted page; no card details pass through this API. Do not use it to cancel — that is its own capability. Return the authorization or checkout handoff to the person. The agent may initiate and inspect status, but must not complete the human approval. Scopes: dialer:manage_billing Risk: costly; confirmation: human_completion; 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" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "status" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "usage" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "checkout" ] }, "checkout": { "type": "object", "properties": { "plan": { "type": "string", "enum": [ "dialer_5", "dialer_10" ] }, "seatCount": { "type": "integer", "minimum": 1, "maximum": 500 }, "successUrl": { "$ref": "#/$defs/HttpUrl" }, "cancelUrl": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "plan", "seatCount", "successUrl", "cancelUrl" ], "patternProperties": { "^(?!(?:plan|seatCount|successUrl|cancelUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "plan", "seatCount", "successUrl", "cancelUrl" ] } } }, "required": [ "kind", "checkout" ], "patternProperties": { "^(?!(?:kind|checkout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "checkout" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\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" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "status" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "usage" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "checkout" ] }, "checkout": { "type": "object", "properties": { "plan": { "type": "string", "enum": [ "dialer_5", "dialer_10" ] }, "seatCount": { "type": "integer", "minimum": 1, "maximum": 500 }, "successUrl": { "$ref": "#/$defs/HttpUrl" }, "cancelUrl": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "plan", "seatCount", "successUrl", "cancelUrl" ], "patternProperties": { "^(?!(?:plan|seatCount|successUrl|cancelUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "plan", "seatCount", "successUrl", "cancelUrl" ] } } }, "required": [ "kind", "checkout" ], "patternProperties": { "^(?!(?:kind|checkout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "checkout" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\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$" }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "active": { "type": "boolean" }, "cancelAtPeriodEnd": { "type": "boolean" }, "plan": { "anyOf": [ { "type": "string", "enum": [ "dialer_5", "dialer_10" ] }, { "type": "null" } ] }, "purchasedSeats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "assignedSeats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "numbersPerSeat": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "active", "cancelAtPeriodEnd", "plan", "purchasedSeats", "assignedSeats", "numbersPerSeat" ], "patternProperties": { "^(?!(?:active|cancelAtPeriodEnd|plan|purchasedSeats|assignedSeats|numbersPerSeat)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "active", "cancelAtPeriodEnd", "plan", "purchasedSeats", "assignedSeats", "numbersPerSeat" ] } }, { "type": "object", "properties": { "minutesUsed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "periodStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "periodEnd": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "minutesUsed", "periodStart", "periodEnd" ], "patternProperties": { "^(?!(?:minutesUsed|periodStart|periodEnd)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "minutesUsed", "periodStart", "periodEnd" ] } }, { "type": "object", "properties": { "checkoutUrl": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "checkoutUrl" ], "patternProperties": { "^(?!(?:checkoutUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "checkoutUrl" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "active": { "type": "boolean" }, "cancelAtPeriodEnd": { "type": "boolean" }, "plan": { "anyOf": [ { "type": "string", "enum": [ "dialer_5", "dialer_10" ] }, { "type": "null" } ] }, "purchasedSeats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "assignedSeats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "numbersPerSeat": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "active", "cancelAtPeriodEnd", "plan", "purchasedSeats", "assignedSeats", "numbersPerSeat" ], "patternProperties": { "^(?!(?:active|cancelAtPeriodEnd|plan|purchasedSeats|assignedSeats|numbersPerSeat)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "active", "cancelAtPeriodEnd", "plan", "purchasedSeats", "assignedSeats", "numbersPerSeat" ] } }, { "type": "object", "properties": { "minutesUsed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "periodStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "periodEnd": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "minutesUsed", "periodStart", "periodEnd" ], "patternProperties": { "^(?!(?:minutesUsed|periodStart|periodEnd)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "minutesUsed", "periodStart", "periodEnd" ] } }, { "type": "object", "properties": { "checkoutUrl": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "checkoutUrl" ], "patternProperties": { "^(?!(?:checkoutUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "checkoutUrl" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `dialerBilling.status`: `GET /v1/workspaces/:workspaceId/dialer/billing/status` - `dialerBilling.usage`: `GET /v1/workspaces/:workspaceId/dialer/billing/usage` - `dialerBilling.checkout`: `POST /v1/workspaces/:workspaceId/dialer/billing/checkout` ## manage_dialer_numbers Inspect the workspace's dialing numbers, search the carrier for purchasable ones, assign a number to a rep, change its health or forwarding, and give one back. Use to keep the number fleet correct: park a flagged number, move a DID to the rep who needs it, or retire one nobody uses. Releasing is permanent — the carrier may reissue the number to someone else, and any campaign or forwarding that depended on it stops. Reassigning a number away from a rep mid-session removes it from their next dial. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: dialer:read, dialer:manage_numbers, dialer:manage_number_health, dialer:assign_numbers, dialer:release_numbers Risk: destructive; confirmation: explicit; 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" }, "action": { "type": "string", "enum": [ "list", "get", "search_available", "provisioning_options", "assign", "update", "release" ] }, "numberId": { "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" }, "list": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "assignedUserId": { "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" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "dialableOnly": { "type": "string", "enum": [ "true", "false" ] } }, "patternProperties": { "^(?!(?:offset|limit|assignedUserId|status|dialableOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "assignedUserId", "status", "dialableOnly" ] } }, "search": { "type": "object", "properties": { "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "search": { "type": "string", "maxLength": 32 }, "areaCode": { "$ref": "#/$defs/AreaCode" }, "limit": { "type": "integer", "minimum": 1, "maximum": 20 } }, "patternProperties": { "^(?!(?:countryCode|search|areaCode|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "countryCode", "search", "areaCode", "limit" ] } }, "assign": { "type": "object", "properties": { "assignedUserId": { "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" } ] }, "confirmedSessionId": { "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": [ "assignedUserId" ], "patternProperties": { "^(?!(?:assignedUserId|confirmedSessionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "assignedUserId", "confirmedSessionId" ] } }, "update": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:status|dailyCallCap|inboundEnabled|inboundForwardE164)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "dailyCallCap", "inboundEnabled", "inboundForwardE164" ] }, "minProperties": 1, "maxProperties": 4 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|numberId|list|search|assign|update)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "numberId", "list", "search", "assign", "update" ] }, "$defs": { "AreaCode": { "type": "string", "pattern": "^\\d{3}$" }, "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" } } } ``` ### 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" }, "action": { "type": "string", "enum": [ "list", "get", "search_available", "provisioning_options", "assign", "update", "release" ] }, "numberId": { "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" }, "list": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "assignedUserId": { "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" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "dialableOnly": { "type": "string", "enum": [ "true", "false" ] } }, "patternProperties": { "^(?!(?:offset|limit|assignedUserId|status|dialableOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "assignedUserId", "status", "dialableOnly" ] } }, "search": { "type": "object", "properties": { "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "search": { "type": "string", "maxLength": 32 }, "areaCode": { "$ref": "#/$defs/AreaCode" }, "limit": { "type": "integer", "minimum": 1, "maximum": 20 } }, "patternProperties": { "^(?!(?:countryCode|search|areaCode|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "countryCode", "search", "areaCode", "limit" ] } }, "assign": { "type": "object", "properties": { "assignedUserId": { "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" } ] }, "confirmedSessionId": { "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": [ "assignedUserId" ], "patternProperties": { "^(?!(?:assignedUserId|confirmedSessionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "assignedUserId", "confirmedSessionId" ] } }, "update": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:status|dailyCallCap|inboundEnabled|inboundForwardE164)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "dailyCallCap", "inboundEnabled", "inboundForwardE164" ] }, "minProperties": 1, "maxProperties": 4 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|numberId|list|search|assign|update)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "numberId", "list", "search", "assign", "update" ] }, "$defs": { "AreaCode": { "type": "string", "pattern": "^\\d{3}$" }, "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "messagingProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "assignedUserId": { "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" } ] }, "countryCode": { "anyOf": [ { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, { "type": "null" } ] }, "numberType": { "anyOf": [ { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, { "type": "null" } ] }, "areaCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "capabilities": { "anyOf": [ { "type": "object", "properties": { "voice": { "type": "boolean" }, "sms": { "type": "boolean" }, "mms": { "type": "boolean" } }, "required": [ "voice", "sms", "mms" ], "patternProperties": { "^(?!(?:voice|sms|mms)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voice", "sms", "mms" ] } }, { "type": "null" } ] }, "attestation": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "spamScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spamCategory": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "reputationScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastReputationCheckAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAvailableCallAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastCallAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "provisionedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "retiredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cooldownUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneE164|status|statusDetail|voiceProvider|messagingProvider|assignedUserId|countryCode|numberType|areaCode|region|capabilities|attestation|spamScore|spamCategory|reputationScore|lastReputationCheckAt|dailyCallCap|nextAvailableCallAt|lastCallAt|provisionedAt|retiredAt|cooldownUntil|inboundEnabled|inboundForwardE164|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "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" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "messagingProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "assignedUserId": { "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" } ] }, "countryCode": { "anyOf": [ { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, { "type": "null" } ] }, "numberType": { "anyOf": [ { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, { "type": "null" } ] }, "areaCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "capabilities": { "anyOf": [ { "type": "object", "properties": { "voice": { "type": "boolean" }, "sms": { "type": "boolean" }, "mms": { "type": "boolean" } }, "required": [ "voice", "sms", "mms" ], "patternProperties": { "^(?!(?:voice|sms|mms)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voice", "sms", "mms" ] } }, { "type": "null" } ] }, "attestation": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "spamScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spamCategory": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "reputationScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastReputationCheckAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAvailableCallAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastCallAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "provisionedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "retiredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cooldownUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneE164|status|statusDetail|voiceProvider|messagingProvider|assignedUserId|countryCode|numberType|areaCode|region|capabilities|attestation|spamScore|spamCategory|reputationScore|lastReputationCheckAt|dailyCallCap|nextAvailableCallAt|lastCallAt|provisionedAt|retiredAt|cooldownUntil|inboundEnabled|inboundForwardE164|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "$ref": "#/$defs/E164PhoneNumber" }, "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "locality": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "administrativeArea": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "features": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "addressRequirement": { "type": "string", "enum": [ "none", "any", "local", "foreign" ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] } }, "required": [ "phoneNumber", "countryCode", "locality", "administrativeArea", "features", "addressRequirement", "voiceProvider" ], "patternProperties": { "^(?!(?:phoneNumber|countryCode|locality|administrativeArea|features|addressRequirement|voiceProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phoneNumber", "countryCode", "locality", "administrativeArea", "features", "addressRequirement", "voiceProvider" ] } }, "maxItems": 20 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "countryName": { "$ref": "#/$defs/ShortText" }, "numberType": { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, "numberTypeName": { "$ref": "#/$defs/ShortText" }, "messaging": { "type": "string", "enum": [ "sms_mms", "sms", "voice_only" ] }, "searchKind": { "type": "string", "enum": [ "nanp", "international" ] }, "requiresRegulatoryBundle": { "type": "boolean" } }, "required": [ "countryCode", "countryName", "numberType", "numberTypeName", "messaging", "searchKind", "requiresRegulatoryBundle" ], "patternProperties": { "^(?!(?:countryCode|countryName|numberType|numberTypeName|messaging|searchKind|requiresRegulatoryBundle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "countryCode", "countryName", "numberType", "numberTypeName", "messaging", "searchKind", "requiresRegulatoryBundle" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "numberId": { "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" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "releasedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "numberId", "phoneE164", "releasedAt" ], "patternProperties": { "^(?!(?:numberId|phoneE164|releasedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "phoneE164", "releasedAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "messagingProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "assignedUserId": { "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" } ] }, "countryCode": { "anyOf": [ { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, { "type": "null" } ] }, "numberType": { "anyOf": [ { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, { "type": "null" } ] }, "areaCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "capabilities": { "anyOf": [ { "type": "object", "properties": { "voice": { "type": "boolean" }, "sms": { "type": "boolean" }, "mms": { "type": "boolean" } }, "required": [ "voice", "sms", "mms" ], "patternProperties": { "^(?!(?:voice|sms|mms)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voice", "sms", "mms" ] } }, { "type": "null" } ] }, "attestation": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "spamScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spamCategory": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "reputationScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastReputationCheckAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAvailableCallAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastCallAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "provisionedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "retiredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cooldownUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneE164|status|statusDetail|voiceProvider|messagingProvider|assignedUserId|countryCode|numberType|areaCode|region|capabilities|attestation|spamScore|spamCategory|reputationScore|lastReputationCheckAt|dailyCallCap|nextAvailableCallAt|lastCallAt|provisionedAt|retiredAt|cooldownUntil|inboundEnabled|inboundForwardE164|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "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" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "messagingProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "assignedUserId": { "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" } ] }, "countryCode": { "anyOf": [ { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, { "type": "null" } ] }, "numberType": { "anyOf": [ { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, { "type": "null" } ] }, "areaCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "capabilities": { "anyOf": [ { "type": "object", "properties": { "voice": { "type": "boolean" }, "sms": { "type": "boolean" }, "mms": { "type": "boolean" } }, "required": [ "voice", "sms", "mms" ], "patternProperties": { "^(?!(?:voice|sms|mms)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voice", "sms", "mms" ] } }, { "type": "null" } ] }, "attestation": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "spamScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spamCategory": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "reputationScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastReputationCheckAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "dailyCallCap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAvailableCallAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastCallAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "provisionedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "retiredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cooldownUntil": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "inboundEnabled": { "type": "boolean" }, "inboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneE164|status|statusDetail|voiceProvider|messagingProvider|assignedUserId|countryCode|numberType|areaCode|region|capabilities|attestation|spamScore|spamCategory|reputationScore|lastReputationCheckAt|dailyCallCap|nextAvailableCallAt|lastCallAt|provisionedAt|retiredAt|cooldownUntil|inboundEnabled|inboundForwardE164|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneE164", "status", "statusDetail", "voiceProvider", "messagingProvider", "assignedUserId", "countryCode", "numberType", "areaCode", "region", "capabilities", "attestation", "spamScore", "spamCategory", "reputationScore", "lastReputationCheckAt", "dailyCallCap", "nextAvailableCallAt", "lastCallAt", "provisionedAt", "retiredAt", "cooldownUntil", "inboundEnabled", "inboundForwardE164", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "$ref": "#/$defs/E164PhoneNumber" }, "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "locality": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "administrativeArea": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "features": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "addressRequirement": { "type": "string", "enum": [ "none", "any", "local", "foreign" ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] } }, "required": [ "phoneNumber", "countryCode", "locality", "administrativeArea", "features", "addressRequirement", "voiceProvider" ], "patternProperties": { "^(?!(?:phoneNumber|countryCode|locality|administrativeArea|features|addressRequirement|voiceProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phoneNumber", "countryCode", "locality", "administrativeArea", "features", "addressRequirement", "voiceProvider" ] } }, "maxItems": 20 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "countryName": { "$ref": "#/$defs/ShortText" }, "numberType": { "type": "string", "enum": [ "local", "mobile", "tollFree" ] }, "numberTypeName": { "$ref": "#/$defs/ShortText" }, "messaging": { "type": "string", "enum": [ "sms_mms", "sms", "voice_only" ] }, "searchKind": { "type": "string", "enum": [ "nanp", "international" ] }, "requiresRegulatoryBundle": { "type": "boolean" } }, "required": [ "countryCode", "countryName", "numberType", "numberTypeName", "messaging", "searchKind", "requiresRegulatoryBundle" ], "patternProperties": { "^(?!(?:countryCode|countryName|numberType|numberTypeName|messaging|searchKind|requiresRegulatoryBundle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "countryCode", "countryName", "numberType", "numberTypeName", "messaging", "searchKind", "requiresRegulatoryBundle" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "numberId": { "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" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "releasedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "numberId", "phoneE164", "releasedAt" ], "patternProperties": { "^(?!(?:numberId|phoneE164|releasedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "phoneE164", "releasedAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `dialerNumbers.list`: `GET /v1/workspaces/:workspaceId/dialer/numbers` - `dialerNumbers.get`: `GET /v1/workspaces/:workspaceId/dialer/numbers/:numberId` - `dialerNumbers.searchAvailable`: `GET /v1/workspaces/:workspaceId/dialer/numbers/search-available` - `dialerNumbers.provisioningOptions`: `GET /v1/workspaces/:workspaceId/dialer/numbers/provisioning-options` - `dialerNumbers.assign`: `PATCH /v1/workspaces/:workspaceId/dialer/numbers/:numberId/assign` - `dialerNumbers.update`: `PATCH /v1/workspaces/:workspaceId/dialer/numbers/:numberId` - `dialerNumbers.release`: `DELETE /v1/workspaces/:workspaceId/dialer/numbers/:numberId` ## manage_dialer_seats Grant or revoke a member's dialer seat, and set where the caller's own inbound dialer calls forward. Use to give a new rep the ability to dial, to take a seat back from someone who has left the team, or to point inbound calls at the right handset. Seats are billable: granting one consumes a purchased seat and granting past the purchased count is refused. Revoking a seat does not release the rep's numbers or turn off their forwarding. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: dialer:assign_seats, dialer:manage_numbers_self Risk: costly; confirmation: explicit; 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" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "assign" ] }, "seat": { "type": "object", "properties": { "userId": { "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" }, "enabled": { "type": "boolean" } }, "required": [ "userId", "enabled" ], "patternProperties": { "^(?!(?:userId|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "enabled" ] } } }, "required": [ "kind", "seat" ], "patternProperties": { "^(?!(?:kind|seat)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "seat" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "set_forwarding" ] }, "forwarding": { "type": "object", "properties": { "forwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "enabled": { "type": "boolean" } }, "required": [ "forwardE164", "enabled" ], "patternProperties": { "^(?!(?:forwardE164|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "forwardE164", "enabled" ] } } }, "required": [ "kind", "forwarding" ], "patternProperties": { "^(?!(?:kind|forwarding)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "forwarding" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] }, "$defs": { "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" } } } ``` ### 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" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "assign" ] }, "seat": { "type": "object", "properties": { "userId": { "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" }, "enabled": { "type": "boolean" } }, "required": [ "userId", "enabled" ], "patternProperties": { "^(?!(?:userId|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "enabled" ] } } }, "required": [ "kind", "seat" ], "patternProperties": { "^(?!(?:kind|seat)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "seat" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "set_forwarding" ] }, "forwarding": { "type": "object", "properties": { "forwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "enabled": { "type": "boolean" } }, "required": [ "forwardE164", "enabled" ], "patternProperties": { "^(?!(?:forwardE164|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "forwardE164", "enabled" ] } } }, "required": [ "kind", "forwarding" ], "patternProperties": { "^(?!(?:kind|forwarding)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "forwarding" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] }, "$defs": { "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "DialerSeatId": { "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" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/DialerSeatId" }, "userId": { "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" }, "active": { "type": "boolean" }, "assignedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "assignedByUserId": { "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" } ] }, "defaultInboundEnabled": { "type": "boolean" }, "defaultInboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] } }, "required": [ "id", "userId", "active", "assignedAt", "assignedByUserId", "defaultInboundEnabled", "defaultInboundForwardE164" ], "patternProperties": { "^(?!(?:id|userId|active|assignedAt|assignedByUserId|defaultInboundEnabled|defaultInboundForwardE164)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "userId", "active", "assignedAt", "assignedByUserId", "defaultInboundEnabled", "defaultInboundForwardE164" ] } }, { "type": "object", "properties": { "enabled": { "type": "boolean" }, "forwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "appliedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "enabled", "forwardE164", "appliedCount" ], "patternProperties": { "^(?!(?:enabled|forwardE164|appliedCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "forwardE164", "appliedCount" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/DialerSeatId" }, "userId": { "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" }, "active": { "type": "boolean" }, "assignedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "assignedByUserId": { "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" } ] }, "defaultInboundEnabled": { "type": "boolean" }, "defaultInboundForwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] } }, "required": [ "id", "userId", "active", "assignedAt", "assignedByUserId", "defaultInboundEnabled", "defaultInboundForwardE164" ], "patternProperties": { "^(?!(?:id|userId|active|assignedAt|assignedByUserId|defaultInboundEnabled|defaultInboundForwardE164)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "userId", "active", "assignedAt", "assignedByUserId", "defaultInboundEnabled", "defaultInboundForwardE164" ] } }, { "type": "object", "properties": { "enabled": { "type": "boolean" }, "forwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "appliedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "enabled", "forwardE164", "appliedCount" ], "patternProperties": { "^(?!(?:enabled|forwardE164|appliedCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "forwardE164", "appliedCount" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `dialerSeats.assign`: `POST /v1/workspaces/:workspaceId/dialer/seats/assign` - `dialerSeats.setInboundForwarding`: `POST /v1/workspaces/:workspaceId/dialer/seats/me/inbound-forwarding` ## manage_domain_dns Read or replace a domain's DNS records with validated typed records. Use to fix DNS for a sending domain or change where its website goes; confirm the full record set with a person before replacing it. Replacing records removes any not included; mail authentication (SPF/DKIM) belongs to the connected mailbox provider. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: domain:manage_dns Risk: destructive; confirmation: explicit; 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" }, "domainId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "read" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "replace" ] }, "request": { "type": "object", "properties": { "records": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "A" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "type": "string", "pattern": "^(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.){3}(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)$" } }, "required": [ "type", "value" ], "patternProperties": { "^(?!(?:type|host|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "AAAA" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "type": "string", "minLength": 2, "maxLength": 45, "pattern": "^[0-9A-Fa-f:.]+$" } }, "required": [ "type", "value" ], "patternProperties": { "^(?!(?:type|host|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CNAME" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?:[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?\\.)*[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?\\.?$" } }, "required": [ "type", "host", "value" ], "patternProperties": { "^(?!(?:type|host|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MX" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?:[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?\\.)*[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?\\.?$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 65535 } }, "required": [ "type", "value", "priority" ], "patternProperties": { "^(?!(?:type|host|value|priority)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value", "priority" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TXT" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "type", "value" ], "patternProperties": { "^(?!(?:type|host|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FORWARD" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "$ref": "#/$defs/HttpUrl" }, "forwardingType": { "type": "string", "enum": [ "301", "302" ] } }, "required": [ "type", "value" ], "patternProperties": { "^(?!(?:type|host|value|forwardingType)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value", "forwardingType" ] } } ] }, "maxItems": 20 } }, "required": [ "records" ], "patternProperties": { "^(?!(?:records)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "records" ] } ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } } ] } }, "required": [ "workspaceId", "domainId", "action" ], "patternProperties": { "^(?!(?:workspaceId|domainId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "domainId", "action" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\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" }, "domainId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "read" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "replace" ] }, "request": { "type": "object", "properties": { "records": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "A" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "type": "string", "pattern": "^(?:(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)\\.){3}(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]?\\d)$" } }, "required": [ "type", "value" ], "patternProperties": { "^(?!(?:type|host|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "AAAA" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "type": "string", "minLength": 2, "maxLength": 45, "pattern": "^[0-9A-Fa-f:.]+$" } }, "required": [ "type", "value" ], "patternProperties": { "^(?!(?:type|host|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "CNAME" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?:[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?\\.)*[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?\\.?$" } }, "required": [ "type", "host", "value" ], "patternProperties": { "^(?!(?:type|host|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MX" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?:[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?\\.)*[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?\\.?$" }, "priority": { "type": "integer", "minimum": 0, "maximum": 65535 } }, "required": [ "type", "value", "priority" ], "patternProperties": { "^(?!(?:type|host|value|priority)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value", "priority" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "TXT" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "required": [ "type", "value" ], "patternProperties": { "^(?!(?:type|host|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FORWARD" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 253, "pattern": "^(?:|@|(?:\\*|[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)(?:\\.[A-Za-z0-9_](?:[A-Za-z0-9_-]{0,61}[A-Za-z0-9_])?)*)$" }, "value": { "$ref": "#/$defs/HttpUrl" }, "forwardingType": { "type": "string", "enum": [ "301", "302" ] } }, "required": [ "type", "value" ], "patternProperties": { "^(?!(?:type|host|value|forwardingType)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value", "forwardingType" ] } } ] }, "maxItems": 20 } }, "required": [ "records" ], "patternProperties": { "^(?!(?:records)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "records" ] } ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } } ] } }, "required": [ "workspaceId", "domainId", "action" ], "patternProperties": { "^(?!(?:workspaceId|domainId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "domainId", "action" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "records": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "TXT" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 2048 }, "value": { "type": "string", "minLength": 0, "maxLength": 2048 } }, "required": [ "type", "host", "value" ], "patternProperties": { "^(?!(?:type|host|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MX" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 2048 }, "value": { "type": "string", "minLength": 0, "maxLength": 2048 }, "priority": { "type": "integer", "minimum": 0, "maximum": 65535 } }, "required": [ "type", "host", "value", "priority" ], "patternProperties": { "^(?!(?:type|host|value|priority)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value", "priority" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FORWARD" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 2048 }, "value": { "type": "string", "minLength": 0, "maxLength": 2048 }, "forwardingType": { "anyOf": [ { "type": "string", "enum": [ "301", "302" ] }, { "type": "null" } ] } }, "required": [ "type", "host", "value", "forwardingType" ], "patternProperties": { "^(?!(?:type|host|value|forwardingType)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value", "forwardingType" ] } } ] }, "maxItems": 100 } }, "required": [ "records" ], "patternProperties": { "^(?!(?:records)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "records" ] } ] } }, { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "recordCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "ok", "recordCount" ], "patternProperties": { "^(?!(?:ok|recordCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "ok", "recordCount" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "records": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "TXT" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 2048 }, "value": { "type": "string", "minLength": 0, "maxLength": 2048 } }, "required": [ "type", "host", "value" ], "patternProperties": { "^(?!(?:type|host|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "MX" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 2048 }, "value": { "type": "string", "minLength": 0, "maxLength": 2048 }, "priority": { "type": "integer", "minimum": 0, "maximum": 65535 } }, "required": [ "type", "host", "value", "priority" ], "patternProperties": { "^(?!(?:type|host|value|priority)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value", "priority" ] } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "FORWARD" ] }, "host": { "type": "string", "minLength": 0, "maxLength": 2048 }, "value": { "type": "string", "minLength": 0, "maxLength": 2048 }, "forwardingType": { "anyOf": [ { "type": "string", "enum": [ "301", "302" ] }, { "type": "null" } ] } }, "required": [ "type", "host", "value", "forwardingType" ], "patternProperties": { "^(?!(?:type|host|value|forwardingType)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "host", "value", "forwardingType" ] } } ] }, "maxItems": 100 } }, "required": [ "records" ], "patternProperties": { "^(?!(?:records)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "records" ] } ] } }, { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "recordCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "ok", "recordCount" ], "patternProperties": { "^(?!(?:ok|recordCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "ok", "recordCount" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `domains.dnsRecords`: `GET /v1/workspaces/:workspaceId/domains/:domainId/dns` - `domains.setDnsRecords`: `POST /v1/workspaces/:workspaceId/domains/:domainId/dns` ## manage_domain_nameservers Plan and manage optional AWS hosted DNS for a workspace domain while keeping registrar delegation under the domain owner's control. Use to inspect nameserver hosting, prepare a plan from a complete DNS export, revise mistaken records or source nameservers before any AWS create attempt or environment assignment, verify DNS TXT ownership before creating the paid zone, provision an independent Route 53 public zone, import records before a person performs registrar handoff, update records only after import is INSYNC, and check recursive DNS observations. Replanning recomputes plan and record hashes/revisions and preserves the ownership challenge. Updates require expectedRecordsHash to match the current AWS hash before UPSERT and retain every existing record name and type; this release does not support deletion. Do not infer a complete DNS zone from public DNS. This creates a separate identifiable AWS public zone per domain, with no reusable delegation sets; it never changes nameservers automatically. Recursive NS matching is not verified parent delegation. While pendingRecords is set, records and recordsHash remain the last confirmed state. Check resumes only the same already-confirmed pending UPSERT to recover its AWS change ID; it creates no new write intent or confirmation. Preserve the last confirmed records/hash, old zone, mail records, and ACM validation records. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: domain:manage_dns Risk: destructive; confirmation: explicit; 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" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "list" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "get" ] }, "zoneId": { "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": [ "kind", "zoneId" ], "patternProperties": { "^(?!(?:kind|zoneId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "zoneId" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "plan" ] }, "request": { "type": "object", "properties": { "hostname": { "$ref": "#/$defs/DomainName" }, "records": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, "sourceNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "completeExportAcknowledged": { "type": "boolean" } }, "required": [ "hostname", "records", "sourceNameservers", "completeExportAcknowledged" ], "patternProperties": { "^(?!(?:hostname|records|sourceNameservers|completeExportAcknowledged)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "hostname", "records", "sourceNameservers", "completeExportAcknowledged" ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "replan" ] }, "zoneId": { "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": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "records": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, "sourceNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "completeExportAcknowledged": { "type": "boolean" } }, "required": [ "expectedRevision", "records", "sourceNameservers", "completeExportAcknowledged" ], "patternProperties": { "^(?!(?:expectedRevision|records|sourceNameservers|completeExportAcknowledged)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "records", "sourceNameservers", "completeExportAcknowledged" ] } } }, "required": [ "kind", "zoneId", "request" ], "patternProperties": { "^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "zoneId", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "provision" ] }, "zoneId": { "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": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "planHash": { "type": "string", "minLength": 1, "maxLength": 256 }, "paidHostingAcknowledged": { "type": "boolean" }, "dnssecMigrationAcknowledged": { "type": "boolean" }, "providerCoordinationAcknowledged": { "type": "boolean" } }, "required": [ "expectedRevision", "planHash", "paidHostingAcknowledged", "dnssecMigrationAcknowledged", "providerCoordinationAcknowledged" ], "patternProperties": { "^(?!(?:expectedRevision|planHash|paidHostingAcknowledged|dnssecMigrationAcknowledged|providerCoordinationAcknowledged)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "planHash", "paidHostingAcknowledged", "dnssecMigrationAcknowledged", "providerCoordinationAcknowledged" ] } } }, "required": [ "kind", "zoneId", "request" ], "patternProperties": { "^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "zoneId", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "update" ] }, "zoneId": { "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": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "expectedRecordsHash": { "type": "string", "minLength": 1, "maxLength": 256 }, "records": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 } }, "required": [ "expectedRevision", "expectedRecordsHash", "records" ], "patternProperties": { "^(?!(?:expectedRevision|expectedRecordsHash|records)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "expectedRecordsHash", "records" ] } } }, "required": [ "kind", "zoneId", "request" ], "patternProperties": { "^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "zoneId", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "check" ] }, "zoneId": { "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": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "expectedRevision" ], "patternProperties": { "^(?!(?:expectedRevision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "expectedRevision" ] } ] } } }, "required": [ "kind", "zoneId", "request" ], "patternProperties": { "^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "zoneId", "request" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] }, "$defs": { "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" } } } ``` ### 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" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "list" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "get" ] }, "zoneId": { "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": [ "kind", "zoneId" ], "patternProperties": { "^(?!(?:kind|zoneId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "zoneId" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "plan" ] }, "request": { "type": "object", "properties": { "hostname": { "$ref": "#/$defs/DomainName" }, "records": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, "sourceNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "completeExportAcknowledged": { "type": "boolean" } }, "required": [ "hostname", "records", "sourceNameservers", "completeExportAcknowledged" ], "patternProperties": { "^(?!(?:hostname|records|sourceNameservers|completeExportAcknowledged)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "hostname", "records", "sourceNameservers", "completeExportAcknowledged" ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "replan" ] }, "zoneId": { "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": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "records": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, "sourceNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "completeExportAcknowledged": { "type": "boolean" } }, "required": [ "expectedRevision", "records", "sourceNameservers", "completeExportAcknowledged" ], "patternProperties": { "^(?!(?:expectedRevision|records|sourceNameservers|completeExportAcknowledged)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "records", "sourceNameservers", "completeExportAcknowledged" ] } } }, "required": [ "kind", "zoneId", "request" ], "patternProperties": { "^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "zoneId", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "provision" ] }, "zoneId": { "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": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "planHash": { "type": "string", "minLength": 1, "maxLength": 256 }, "paidHostingAcknowledged": { "type": "boolean" }, "dnssecMigrationAcknowledged": { "type": "boolean" }, "providerCoordinationAcknowledged": { "type": "boolean" } }, "required": [ "expectedRevision", "planHash", "paidHostingAcknowledged", "dnssecMigrationAcknowledged", "providerCoordinationAcknowledged" ], "patternProperties": { "^(?!(?:expectedRevision|planHash|paidHostingAcknowledged|dnssecMigrationAcknowledged|providerCoordinationAcknowledged)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "planHash", "paidHostingAcknowledged", "dnssecMigrationAcknowledged", "providerCoordinationAcknowledged" ] } } }, "required": [ "kind", "zoneId", "request" ], "patternProperties": { "^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "zoneId", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "update" ] }, "zoneId": { "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": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "expectedRecordsHash": { "type": "string", "minLength": 1, "maxLength": 256 }, "records": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 } }, "required": [ "expectedRevision", "expectedRecordsHash", "records" ], "patternProperties": { "^(?!(?:expectedRevision|expectedRecordsHash|records)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "expectedRecordsHash", "records" ] } } }, "required": [ "kind", "zoneId", "request" ], "patternProperties": { "^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "zoneId", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "check" ] }, "zoneId": { "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": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "expectedRevision" ], "patternProperties": { "^(?!(?:expectedRevision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "expectedRevision" ] } ] } } }, "required": [ "kind", "zoneId", "request" ], "patternProperties": { "^(?!(?:kind|zoneId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "zoneId", "request" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] }, "$defs": { "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "zones": { "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" }, "hostname": { "$ref": "#/$defs/DomainName" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recordsHash": { "type": "string" }, "status": { "type": "string", "enum": [ "ownership_pending", "provisioning", "import_pending", "ready_to_delegate", "observed_matching", "needs_attention" ] }, "ownershipRecord": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TXT" ] }, "value": { "type": "string" }, "removable": { "type": "boolean" } }, "required": [ "name", "type", "value", "removable" ], "patternProperties": { "^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value", "removable" ] } }, "records": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, "pendingRecords": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, { "type": "null" } ] }, "sourceNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "nameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "hostedZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "changeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "planHash": { "type": "string" }, "verifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "observedNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "delegationEvidence": { "type": "string", "enum": [ "recursive_dns_only" ] }, "hostingMonthlyUsd": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "hostname", "revision", "recordsHash", "status", "ownershipRecord", "records", "pendingRecords", "sourceNameservers", "nameservers", "hostedZoneId", "changeId", "planHash", "verifiedAt", "checkedAt", "reason", "observedNameservers", "delegationEvidence", "hostingMonthlyUsd" ], "patternProperties": { "^(?!(?:id|hostname|revision|recordsHash|status|ownershipRecord|records|pendingRecords|sourceNameservers|nameservers|hostedZoneId|changeId|planHash|verifiedAt|checkedAt|reason|observedNameservers|delegationEvidence|hostingMonthlyUsd)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "hostname", "revision", "recordsHash", "status", "ownershipRecord", "records", "pendingRecords", "sourceNameservers", "nameservers", "hostedZoneId", "changeId", "planHash", "verifiedAt", "checkedAt", "reason", "observedNameservers", "delegationEvidence", "hostingMonthlyUsd" ] } }, "maxItems": 50 } }, "required": [ "zones" ], "patternProperties": { "^(?!(?:zones)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "zones" ] } ] } }, { "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" }, "hostname": { "$ref": "#/$defs/DomainName" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recordsHash": { "type": "string" }, "status": { "type": "string", "enum": [ "ownership_pending", "provisioning", "import_pending", "ready_to_delegate", "observed_matching", "needs_attention" ] }, "ownershipRecord": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TXT" ] }, "value": { "type": "string" }, "removable": { "type": "boolean" } }, "required": [ "name", "type", "value", "removable" ], "patternProperties": { "^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value", "removable" ] } }, "records": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, "pendingRecords": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, { "type": "null" } ] }, "sourceNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "nameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "hostedZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "changeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "planHash": { "type": "string" }, "verifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "observedNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "delegationEvidence": { "type": "string", "enum": [ "recursive_dns_only" ] }, "hostingMonthlyUsd": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "hostname", "revision", "recordsHash", "status", "ownershipRecord", "records", "pendingRecords", "sourceNameservers", "nameservers", "hostedZoneId", "changeId", "planHash", "verifiedAt", "checkedAt", "reason", "observedNameservers", "delegationEvidence", "hostingMonthlyUsd" ], "patternProperties": { "^(?!(?:id|hostname|revision|recordsHash|status|ownershipRecord|records|pendingRecords|sourceNameservers|nameservers|hostedZoneId|changeId|planHash|verifiedAt|checkedAt|reason|observedNameservers|delegationEvidence|hostingMonthlyUsd)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "hostname", "revision", "recordsHash", "status", "ownershipRecord", "records", "pendingRecords", "sourceNameservers", "nameservers", "hostedZoneId", "changeId", "planHash", "verifiedAt", "checkedAt", "reason", "observedNameservers", "delegationEvidence", "hostingMonthlyUsd" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "zones": { "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" }, "hostname": { "$ref": "#/$defs/DomainName" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recordsHash": { "type": "string" }, "status": { "type": "string", "enum": [ "ownership_pending", "provisioning", "import_pending", "ready_to_delegate", "observed_matching", "needs_attention" ] }, "ownershipRecord": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TXT" ] }, "value": { "type": "string" }, "removable": { "type": "boolean" } }, "required": [ "name", "type", "value", "removable" ], "patternProperties": { "^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value", "removable" ] } }, "records": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, "pendingRecords": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, { "type": "null" } ] }, "sourceNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "nameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "hostedZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "changeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "planHash": { "type": "string" }, "verifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "observedNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "delegationEvidence": { "type": "string", "enum": [ "recursive_dns_only" ] }, "hostingMonthlyUsd": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "hostname", "revision", "recordsHash", "status", "ownershipRecord", "records", "pendingRecords", "sourceNameservers", "nameservers", "hostedZoneId", "changeId", "planHash", "verifiedAt", "checkedAt", "reason", "observedNameservers", "delegationEvidence", "hostingMonthlyUsd" ], "patternProperties": { "^(?!(?:id|hostname|revision|recordsHash|status|ownershipRecord|records|pendingRecords|sourceNameservers|nameservers|hostedZoneId|changeId|planHash|verifiedAt|checkedAt|reason|observedNameservers|delegationEvidence|hostingMonthlyUsd)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "hostname", "revision", "recordsHash", "status", "ownershipRecord", "records", "pendingRecords", "sourceNameservers", "nameservers", "hostedZoneId", "changeId", "planHash", "verifiedAt", "checkedAt", "reason", "observedNameservers", "delegationEvidence", "hostingMonthlyUsd" ] } }, "maxItems": 50 } }, "required": [ "zones" ], "patternProperties": { "^(?!(?:zones)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "zones" ] } ] } }, { "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" }, "hostname": { "$ref": "#/$defs/DomainName" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recordsHash": { "type": "string" }, "status": { "type": "string", "enum": [ "ownership_pending", "provisioning", "import_pending", "ready_to_delegate", "observed_matching", "needs_attention" ] }, "ownershipRecord": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TXT" ] }, "value": { "type": "string" }, "removable": { "type": "boolean" } }, "required": [ "name", "type", "value", "removable" ], "patternProperties": { "^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value", "removable" ] } }, "records": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, "pendingRecords": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 253 }, "type": { "type": "string", "enum": [ "A", "AAAA", "CNAME", "MX", "TXT", "CAA", "SRV", "NS", "PTR", "NAPTR", "DS" ] }, "ttl": { "type": "integer" }, "values": { "type": "array", "items": { "type": "string", "maxLength": 65536 }, "maxItems": 500 }, "aliasTarget": { "type": "object", "properties": { "dnsName": { "type": "string", "minLength": 1, "maxLength": 253 }, "hostedZoneId": { "type": "string", "minLength": 1, "maxLength": 128 }, "evaluateTargetHealth": { "type": "boolean" } }, "required": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ], "patternProperties": { "^(?!(?:dnsName|hostedZoneId|evaluateTargetHealth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsName", "hostedZoneId", "evaluateTargetHealth" ] } } }, "required": [ "name", "type", "ttl", "values" ], "patternProperties": { "^(?!(?:name|type|ttl|values|aliasTarget)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "ttl", "values", "aliasTarget" ] } }, "maxItems": 500 }, { "type": "null" } ] }, "sourceNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "nameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "hostedZoneId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "changeId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "planHash": { "type": "string" }, "verifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "observedNameservers": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 253 }, "maxItems": 32 }, "delegationEvidence": { "type": "string", "enum": [ "recursive_dns_only" ] }, "hostingMonthlyUsd": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "hostname", "revision", "recordsHash", "status", "ownershipRecord", "records", "pendingRecords", "sourceNameservers", "nameservers", "hostedZoneId", "changeId", "planHash", "verifiedAt", "checkedAt", "reason", "observedNameservers", "delegationEvidence", "hostingMonthlyUsd" ], "patternProperties": { "^(?!(?:id|hostname|revision|recordsHash|status|ownershipRecord|records|pendingRecords|sourceNameservers|nameservers|hostedZoneId|changeId|planHash|verifiedAt|checkedAt|reason|observedNameservers|delegationEvidence|hostingMonthlyUsd)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "hostname", "revision", "recordsHash", "status", "ownershipRecord", "records", "pendingRecords", "sourceNameservers", "nameservers", "hostedZoneId", "changeId", "planHash", "verifiedAt", "checkedAt", "reason", "observedNameservers", "delegationEvidence", "hostingMonthlyUsd" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `domainDns.list`: `GET /v1/workspaces/:workspaceId/domains/dns-hosting` - `domainDns.get`: `GET /v1/workspaces/:workspaceId/domains/dns-hosting/:zoneId` - `domainDns.plan`: `POST /v1/workspaces/:workspaceId/domains/dns-hosting` - `domainDns.replan`: `POST /v1/workspaces/:workspaceId/domains/dns-hosting/:zoneId/plan` - `domainDns.provision`: `POST /v1/workspaces/:workspaceId/domains/dns-hosting/:zoneId/provision` - `domainDns.update`: `POST /v1/workspaces/:workspaceId/domains/dns-hosting/:zoneId/records` - `domainDns.check`: `POST /v1/workspaces/:workspaceId/domains/dns-hosting/:zoneId/check` ## manage_heyreach_accounts Maintain the workspace's LinkedIn sender accounts in HeyReach: reconnect a dropped session, re-read an account's state, choose how much of its inbox HeyReach scrapes, or remove it. Use when an account read shows an invalid or stale session, or when a person asks to retire a sender. Connecting a new sender, submitting its LinkedIn PIN, and changing its proxy all carry a password, cookies, a PIN, or a proxy secret, and are a person's job. Removing an account still assigned to campaigns needs `force`, and stops those campaigns from sending as it. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:update, inbox:connect, inbox:update, inbox:delete Risk: destructive; confirmation: explicit; 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": [ "reconnect" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "accountId" ], "patternProperties": { "^(?!(?:workspaceId|action|accountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "accountId" ] } }, { "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": [ "resync" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "accountId" ], "patternProperties": { "^(?!(?:workspaceId|action|accountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "accountId" ] } }, { "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": [ "update_inbox_configuration" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "inboxScrapeMode": { "$ref": "#/$defs/HeyReachInboxScrapeMode" } }, "required": [ "workspaceId", "action", "accountId", "inboxScrapeMode" ], "patternProperties": { "^(?!(?:workspaceId|action|accountId|inboxScrapeMode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "accountId", "inboxScrapeMode" ] } }, { "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": [ "remove" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "force": { "type": "boolean" } }, "required": [ "workspaceId", "action", "accountId" ], "patternProperties": { "^(?!(?:workspaceId|action|accountId|force)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "accountId", "force" ] } } ], "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachInboxScrapeMode": { "type": "string", "enum": [ "AllTime", "HeyReachOnly" ] } } } ``` ### 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": [ "reconnect" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "accountId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|accountId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "accountId" ] }, { "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": [ "resync" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "accountId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|accountId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "accountId" ] }, { "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": [ "update_inbox_configuration" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "inboxScrapeMode": { "$ref": "#/$defs/HeyReachInboxScrapeMode" } }, "required": [ "workspaceId", "action", "accountId", "inboxScrapeMode" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|accountId|inboxScrapeMode)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "accountId", "inboxScrapeMode" ] }, { "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": [ "remove" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "force": { "type": "boolean" } }, "required": [ "workspaceId", "action", "accountId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|accountId|force)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "accountId", "force" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachInboxScrapeMode": { "type": "string", "enum": [ "AllTime", "HeyReachOnly" ] } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ``` ### Underlying API operations - `heyreachAccounts.reconnect`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId/reconnect` - `heyreachAccounts.resync`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId/resync` - `heyreachAccounts.updateInboxConfiguration`: `PUT /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId/inbox-configuration` - `heyreachAccounts.remove`: `DELETE /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId` ## manage_heyreach_campaigns Run the workspace's HeyReach LinkedIn campaigns: create one (from scratch or a template), change its settings, schedule, or action sequence, add, replace, or remove its senders, start, pause, or resume it, stop one lead, create a list, remove leads from a list, and set a lead's tags. Use to carry out an outreach plan a person has agreed to. Pausing and stopping a lead are always available; starting, resuming, and adding senders put real LinkedIn actions in motion and are refused on a frozen subscription. HeyReach cannot delete a campaign or a list, so create only what the person asked for — the server deduplicates retries of the same create. Creating campaigns and lists is disabled on preview deployments, which share a real HeyReach account. Tags must already exist in HeyReach; unknown tags are not created. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:update, campaign:create, campaign:update, campaign:launch, campaign:pause Risk: costly; confirmation: explicit; 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": [ "create" ] }, "create": { "$ref": "#/$defs/CreateHeyReachCampaignInput" } }, "required": [ "workspaceId", "action", "create" ], "patternProperties": { "^(?!(?:workspaceId|action|create)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "create" ] } }, { "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": [ "create_from_template" ] }, "fromTemplate": { "$ref": "#/$defs/CreateHeyReachCampaignFromTemplateInput" } }, "required": [ "workspaceId", "action", "fromTemplate" ], "patternProperties": { "^(?!(?:workspaceId|action|fromTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "fromTemplate" ] } }, { "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": [ "update_settings" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "settings": { "$ref": "#/$defs/UpdateHeyReachCampaignSettingsInput" } }, "required": [ "workspaceId", "action", "campaignId", "settings" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignId|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "settings" ] } }, { "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": [ "update_schedule" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "schedule": { "$ref": "#/$defs/HeyReachCampaignSchedule" } }, "required": [ "workspaceId", "action", "campaignId", "schedule" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignId|schedule)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "schedule" ] } }, { "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": [ "update_sequence" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "sequence": { "$ref": "#/$defs/HeyReachCampaignSequence_1" } }, "required": [ "workspaceId", "action", "campaignId", "sequence" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignId|sequence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "sequence" ] } }, { "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": [ "add_accounts" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "accounts": { "$ref": "#/$defs/HeyReachCampaignAccountsInput" } }, "required": [ "workspaceId", "action", "campaignId", "accounts" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "accounts" ] } }, { "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": [ "set_accounts" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "accounts": { "$ref": "#/$defs/HeyReachCampaignAccountsInput" } }, "required": [ "workspaceId", "action", "campaignId", "accounts" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "accounts" ] } }, { "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": [ "remove_accounts" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "accounts": { "$ref": "#/$defs/HeyReachCampaignAccountsInput" } }, "required": [ "workspaceId", "action", "campaignId", "accounts" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "accounts" ] } }, { "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": [ "pause" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignId" ] } }, { "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": [ "resume" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignId" ] } }, { "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" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignId" ] } }, { "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": [ "stop_lead" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "stopLead": { "$ref": "#/$defs/StopHeyReachLeadInput" } }, "required": [ "workspaceId", "action", "campaignId", "stopLead" ], "patternProperties": { "^(?!(?:workspaceId|action|campaignId|stopLead)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "stopLead" ] } }, { "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": [ "create_list" ] }, "list": { "$ref": "#/$defs/CreateHeyReachListInput" } }, "required": [ "workspaceId", "action", "list" ], "patternProperties": { "^(?!(?:workspaceId|action|list)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "list" ] } }, { "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": [ "remove_list_leads" ] }, "listId": { "$ref": "#/$defs/HeyReachId" }, "removeLeads": { "$ref": "#/$defs/RemoveHeyReachListLeadsInput" } }, "required": [ "workspaceId", "action", "listId", "removeLeads" ], "patternProperties": { "^(?!(?:workspaceId|action|listId|removeLeads)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "listId", "removeLeads" ] } }, { "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": [ "add_lead_tags" ] }, "tags": { "$ref": "#/$defs/SetHeyReachLeadTagsInput" } }, "required": [ "workspaceId", "action", "tags" ], "patternProperties": { "^(?!(?:workspaceId|action|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "tags" ] } }, { "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": [ "replace_lead_tags" ] }, "tags": { "$ref": "#/$defs/SetHeyReachLeadTagsInput" } }, "required": [ "workspaceId", "action", "tags" ], "patternProperties": { "^(?!(?:workspaceId|action|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "tags" ] } } ], "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachCampaignSchedule": { "type": "object", "properties": { "dailyStartTime": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$|^24:00:00$" }, "dailyEndTime": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$|^24:00:00$" }, "timeZoneId": { "type": "string", "minLength": 1, "maxLength": 100 }, "enabledMonday": { "type": "boolean" }, "enabledTuesday": { "type": "boolean" }, "enabledWednesday": { "type": "boolean" }, "enabledThursday": { "type": "boolean" }, "enabledFriday": { "type": "boolean" }, "enabledSaturday": { "type": "boolean" }, "enabledSunday": { "type": "boolean" }, "startDate": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, { "type": "null" } ] } }, "required": [ "dailyStartTime", "dailyEndTime", "timeZoneId" ], "patternProperties": { "^(?!(?:dailyStartTime|dailyEndTime|timeZoneId|enabledMonday|enabledTuesday|enabledWednesday|enabledThursday|enabledFriday|enabledSaturday|enabledSunday|startDate|endDate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dailyStartTime", "dailyEndTime", "timeZoneId", "enabledMonday", "enabledTuesday", "enabledWednesday", "enabledThursday", "enabledFriday", "enabledSaturday", "enabledSunday", "startDate", "endDate" ] } }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "HeyReachDocument": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "HeyReachSequenceNode": { "type": "object", "properties": { "nodeType": { "type": "string", "enum": [ "CONNECTION_REQUEST", "MESSAGE", "INMAIL", "VIEW_PROFILE", "FOLLOW", "LIKE_POST", "FIND_EMAIL", "CHECK_IS_CONNECTION", "CHECK_IS_OPEN_PROFILE", "SEND_LEAD_TO_INSTANTLY", "SEND_LEAD_TO_SMARTLEAD", "SEND_LEAD_TO_BISON", "END" ] }, "actionDelay": { "type": "integer", "minimum": 0, "maximum": 100 }, "actionDelayUnit": { "type": "string", "enum": [ "HOUR", "DAY" ] }, "externalReference": { "type": "string", "minLength": 0, "maxLength": 100 }, "payload": { "$ref": "#/$defs/HeyReachDocument" }, "unconditionalNode": { "$ref": "#/$defs/Suspend_" }, "conditionalNode": { "$ref": "#/$defs/HeyReachSequenceNode" } }, "required": [ "nodeType" ], "patternProperties": { "^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "nodeType", "actionDelay", "actionDelayUnit", "externalReference", "payload", "unconditionalNode", "conditionalNode" ] } }, "Suspend_": { "$ref": "#/$defs/HeyReachSequenceNode" }, "HeyReachCampaignSequence": { "type": "object", "properties": { "nodeType": { "type": "string", "enum": [ "CONNECTION_REQUEST", "MESSAGE", "INMAIL", "VIEW_PROFILE", "FOLLOW", "LIKE_POST", "FIND_EMAIL", "CHECK_IS_CONNECTION", "CHECK_IS_OPEN_PROFILE", "SEND_LEAD_TO_INSTANTLY", "SEND_LEAD_TO_SMARTLEAD", "SEND_LEAD_TO_BISON", "END" ] }, "actionDelay": { "type": "integer", "minimum": 0, "maximum": 100 }, "actionDelayUnit": { "type": "string", "enum": [ "HOUR", "DAY" ] }, "externalReference": { "type": "string", "minLength": 0, "maxLength": 100 }, "payload": { "$ref": "#/$defs/HeyReachDocument" }, "unconditionalNode": { "$ref": "#/$defs/Suspend_" }, "conditionalNode": { "$ref": "#/$defs/HeyReachSequenceNode" } }, "required": [ "nodeType" ], "patternProperties": { "^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "nodeType", "actionDelay", "actionDelayUnit", "externalReference", "payload", "unconditionalNode", "conditionalNode" ] } }, "CreateHeyReachCampaignInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "linkedInUserListId": { "$ref": "#/$defs/HeyReachId" }, "linkedInAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 1, "maxItems": 100 }, "excludeContactedFromOtherCampaigns": { "type": "boolean" }, "excludeHasOtherAccConversations": { "type": "boolean" }, "excludeContactedFromSenderInOtherCampaign": { "type": "boolean" }, "excludeListId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] }, "schedule": { "$ref": "#/$defs/HeyReachCampaignSchedule" }, "sequence": { "$ref": "#/$defs/HeyReachCampaignSequence" } }, "required": [ "name", "linkedInUserListId", "linkedInAccountIds" ], "patternProperties": { "^(?!(?:name|linkedInUserListId|linkedInAccountIds|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId|schedule|sequence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "linkedInUserListId", "linkedInAccountIds", "excludeContactedFromOtherCampaigns", "excludeHasOtherAccConversations", "excludeContactedFromSenderInOtherCampaign", "excludeListId", "schedule", "sequence" ] } }, "CreateHeyReachCampaignFromTemplateInput": { "type": "object", "properties": { "campaignIdForTemplate": { "$ref": "#/$defs/HeyReachId" }, "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "linkedInUserListId": { "$ref": "#/$defs/HeyReachId" }, "linkedInAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 1, "maxItems": 100 }, "excludeContactedFromOtherCampaigns": { "type": "boolean" }, "excludeHasOtherAccConversations": { "type": "boolean" }, "excludeContactedFromSenderInOtherCampaign": { "type": "boolean" }, "excludeListId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] } }, "required": [ "campaignIdForTemplate", "name", "linkedInUserListId", "linkedInAccountIds", "excludeContactedFromOtherCampaigns", "excludeHasOtherAccConversations", "excludeContactedFromSenderInOtherCampaign" ], "patternProperties": { "^(?!(?:campaignIdForTemplate|name|linkedInUserListId|linkedInAccountIds|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignIdForTemplate", "name", "linkedInUserListId", "linkedInAccountIds", "excludeContactedFromOtherCampaigns", "excludeHasOtherAccConversations", "excludeContactedFromSenderInOtherCampaign", "excludeListId" ] } }, "UpdateHeyReachCampaignSettingsInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "linkedInUserListId": { "$ref": "#/$defs/HeyReachId" }, "excludeContactedFromOtherCampaigns": { "type": "boolean" }, "excludeHasOtherAccConversations": { "type": "boolean" }, "excludeContactedFromSenderInOtherCampaign": { "type": "boolean" }, "excludeListId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] } }, "required": [ "name", "linkedInUserListId", "excludeContactedFromOtherCampaigns", "excludeHasOtherAccConversations", "excludeContactedFromSenderInOtherCampaign", "excludeListId" ], "patternProperties": { "^(?!(?:name|linkedInUserListId|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "linkedInUserListId", "excludeContactedFromOtherCampaigns", "excludeHasOtherAccConversations", "excludeContactedFromSenderInOtherCampaign", "excludeListId" ] } }, "HeyReachCampaignSequence_1": { "type": "object", "properties": { "nodeType": { "type": "string", "enum": [ "CONNECTION_REQUEST", "MESSAGE", "INMAIL", "VIEW_PROFILE", "FOLLOW", "LIKE_POST", "FIND_EMAIL", "CHECK_IS_CONNECTION", "CHECK_IS_OPEN_PROFILE", "SEND_LEAD_TO_INSTANTLY", "SEND_LEAD_TO_SMARTLEAD", "SEND_LEAD_TO_BISON", "END" ] }, "actionDelay": { "type": "integer", "minimum": 0, "maximum": 100 }, "actionDelayUnit": { "type": "string", "enum": [ "HOUR", "DAY" ] }, "externalReference": { "type": "string", "minLength": 0, "maxLength": 100 }, "payload": { "$ref": "#/$defs/HeyReachDocument" }, "unconditionalNode": { "$ref": "#/$defs/Suspend_" }, "conditionalNode": { "$ref": "#/$defs/HeyReachSequenceNode" } }, "required": [ "nodeType" ], "patternProperties": { "^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "nodeType", "actionDelay", "actionDelayUnit", "externalReference", "payload", "unconditionalNode", "conditionalNode" ] } }, "HeyReachCampaignAccountsInput": { "type": "object", "properties": { "linkedInAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 1, "maxItems": 100 } }, "required": [ "linkedInAccountIds" ], "patternProperties": { "^(?!(?:linkedInAccountIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "linkedInAccountIds" ] } ] } }, "LinkedInProfileUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "StopHeyReachLeadInput": { "type": "object", "properties": { "leadUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "leadMemberId": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "leadUrl" ], "patternProperties": { "^(?!(?:leadUrl|leadMemberId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadUrl", "leadMemberId" ] } }, "HeyReachListType": { "type": "string", "enum": [ "USER_LIST", "COMPANY_LIST" ] }, "CreateHeyReachListInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "type": { "$ref": "#/$defs/HeyReachListType" } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type" ] } }, "RemoveHeyReachListLeadsInput": { "type": "object", "properties": { "profileUrls": { "type": "array", "items": { "$ref": "#/$defs/LinkedInProfileUrl" }, "minItems": 1, "maxItems": 100 } }, "required": [ "profileUrls" ], "patternProperties": { "^(?!(?:profileUrls)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "profileUrls" ] } ] } }, "SetHeyReachLeadTagsInput": { "type": "object", "properties": { "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 100 } }, "required": [ "profileUrl", "tags" ], "patternProperties": { "^(?!(?:profileUrl|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileUrl", "tags" ] } } } } ``` ### 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": [ "create" ] }, "create": { "$ref": "#/$defs/CreateHeyReachCampaignInput" } }, "required": [ "workspaceId", "action", "create" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|create)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "create" ] }, { "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": [ "create_from_template" ] }, "fromTemplate": { "$ref": "#/$defs/CreateHeyReachCampaignFromTemplateInput" } }, "required": [ "workspaceId", "action", "fromTemplate" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|fromTemplate)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "fromTemplate" ] }, { "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": [ "update_settings" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "settings": { "$ref": "#/$defs/UpdateHeyReachCampaignSettingsInput" } }, "required": [ "workspaceId", "action", "campaignId", "settings" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|settings)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "settings" ] }, { "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": [ "update_schedule" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "schedule": { "$ref": "#/$defs/HeyReachCampaignSchedule" } }, "required": [ "workspaceId", "action", "campaignId", "schedule" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|schedule)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "schedule" ] }, { "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": [ "update_sequence" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "sequence": { "$ref": "#/$defs/HeyReachCampaignSequence_1" } }, "required": [ "workspaceId", "action", "campaignId", "sequence" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|sequence)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "sequence" ] }, { "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": [ "add_accounts" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "accounts": { "$ref": "#/$defs/HeyReachCampaignAccountsInput" } }, "required": [ "workspaceId", "action", "campaignId", "accounts" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "accounts" ] }, { "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": [ "set_accounts" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "accounts": { "$ref": "#/$defs/HeyReachCampaignAccountsInput" } }, "required": [ "workspaceId", "action", "campaignId", "accounts" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "accounts" ] }, { "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": [ "remove_accounts" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "accounts": { "$ref": "#/$defs/HeyReachCampaignAccountsInput" } }, "required": [ "workspaceId", "action", "campaignId", "accounts" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|accounts)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "accounts" ] }, { "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": [ "pause" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "campaignId" ] }, { "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": [ "resume" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "campaignId" ] }, { "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" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "action", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "campaignId" ] }, { "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": [ "stop_lead" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "stopLead": { "$ref": "#/$defs/StopHeyReachLeadInput" } }, "required": [ "workspaceId", "action", "campaignId", "stopLead" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|campaignId|stopLead)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "campaignId", "stopLead" ] }, { "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": [ "create_list" ] }, "list": { "$ref": "#/$defs/CreateHeyReachListInput" } }, "required": [ "workspaceId", "action", "list" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|list)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "list" ] }, { "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": [ "remove_list_leads" ] }, "listId": { "$ref": "#/$defs/HeyReachId" }, "removeLeads": { "$ref": "#/$defs/RemoveHeyReachListLeadsInput" } }, "required": [ "workspaceId", "action", "listId", "removeLeads" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|listId|removeLeads)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "listId", "removeLeads" ] }, { "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": [ "add_lead_tags" ] }, "tags": { "$ref": "#/$defs/SetHeyReachLeadTagsInput" } }, "required": [ "workspaceId", "action", "tags" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|tags)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "tags" ] }, { "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": [ "replace_lead_tags" ] }, "tags": { "$ref": "#/$defs/SetHeyReachLeadTagsInput" } }, "required": [ "workspaceId", "action", "tags" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|tags)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "tags" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachCampaignSchedule": { "type": "object", "properties": { "dailyStartTime": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$|^24:00:00$" }, "dailyEndTime": { "type": "string", "pattern": "^(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d$|^24:00:00$" }, "timeZoneId": { "type": "string", "minLength": 1, "maxLength": 100 }, "enabledMonday": { "type": "boolean" }, "enabledTuesday": { "type": "boolean" }, "enabledWednesday": { "type": "boolean" }, "enabledThursday": { "type": "boolean" }, "enabledFriday": { "type": "boolean" }, "enabledSaturday": { "type": "boolean" }, "enabledSunday": { "type": "boolean" }, "startDate": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, { "type": "null" } ] } }, "required": [ "dailyStartTime", "dailyEndTime", "timeZoneId" ], "patternProperties": { "^(?!(?:dailyStartTime|dailyEndTime|timeZoneId|enabledMonday|enabledTuesday|enabledWednesday|enabledThursday|enabledFriday|enabledSaturday|enabledSunday|startDate|endDate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dailyStartTime", "dailyEndTime", "timeZoneId", "enabledMonday", "enabledTuesday", "enabledWednesday", "enabledThursday", "enabledFriday", "enabledSaturday", "enabledSunday", "startDate", "endDate" ] } }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "HeyReachDocument": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "HeyReachSequenceNode": { "type": "object", "properties": { "nodeType": { "type": "string", "enum": [ "CONNECTION_REQUEST", "MESSAGE", "INMAIL", "VIEW_PROFILE", "FOLLOW", "LIKE_POST", "FIND_EMAIL", "CHECK_IS_CONNECTION", "CHECK_IS_OPEN_PROFILE", "SEND_LEAD_TO_INSTANTLY", "SEND_LEAD_TO_SMARTLEAD", "SEND_LEAD_TO_BISON", "END" ] }, "actionDelay": { "type": "integer", "minimum": 0, "maximum": 100 }, "actionDelayUnit": { "type": "string", "enum": [ "HOUR", "DAY" ] }, "externalReference": { "type": "string", "minLength": 0, "maxLength": 100 }, "payload": { "$ref": "#/$defs/HeyReachDocument" }, "unconditionalNode": { "$ref": "#/$defs/Suspend_" }, "conditionalNode": { "$ref": "#/$defs/HeyReachSequenceNode" } }, "required": [ "nodeType" ], "patternProperties": { "^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "nodeType", "actionDelay", "actionDelayUnit", "externalReference", "payload", "unconditionalNode", "conditionalNode" ] } }, "Suspend_": { "$ref": "#/$defs/HeyReachSequenceNode" }, "HeyReachCampaignSequence": { "type": "object", "properties": { "nodeType": { "type": "string", "enum": [ "CONNECTION_REQUEST", "MESSAGE", "INMAIL", "VIEW_PROFILE", "FOLLOW", "LIKE_POST", "FIND_EMAIL", "CHECK_IS_CONNECTION", "CHECK_IS_OPEN_PROFILE", "SEND_LEAD_TO_INSTANTLY", "SEND_LEAD_TO_SMARTLEAD", "SEND_LEAD_TO_BISON", "END" ] }, "actionDelay": { "type": "integer", "minimum": 0, "maximum": 100 }, "actionDelayUnit": { "type": "string", "enum": [ "HOUR", "DAY" ] }, "externalReference": { "type": "string", "minLength": 0, "maxLength": 100 }, "payload": { "$ref": "#/$defs/HeyReachDocument" }, "unconditionalNode": { "$ref": "#/$defs/Suspend_" }, "conditionalNode": { "$ref": "#/$defs/HeyReachSequenceNode" } }, "required": [ "nodeType" ], "patternProperties": { "^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "nodeType", "actionDelay", "actionDelayUnit", "externalReference", "payload", "unconditionalNode", "conditionalNode" ] } }, "CreateHeyReachCampaignInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "linkedInUserListId": { "$ref": "#/$defs/HeyReachId" }, "linkedInAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 1, "maxItems": 100 }, "excludeContactedFromOtherCampaigns": { "type": "boolean" }, "excludeHasOtherAccConversations": { "type": "boolean" }, "excludeContactedFromSenderInOtherCampaign": { "type": "boolean" }, "excludeListId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] }, "schedule": { "$ref": "#/$defs/HeyReachCampaignSchedule" }, "sequence": { "$ref": "#/$defs/HeyReachCampaignSequence" } }, "required": [ "name", "linkedInUserListId", "linkedInAccountIds" ], "patternProperties": { "^(?!(?:name|linkedInUserListId|linkedInAccountIds|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId|schedule|sequence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "linkedInUserListId", "linkedInAccountIds", "excludeContactedFromOtherCampaigns", "excludeHasOtherAccConversations", "excludeContactedFromSenderInOtherCampaign", "excludeListId", "schedule", "sequence" ] } }, "CreateHeyReachCampaignFromTemplateInput": { "type": "object", "properties": { "campaignIdForTemplate": { "$ref": "#/$defs/HeyReachId" }, "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "linkedInUserListId": { "$ref": "#/$defs/HeyReachId" }, "linkedInAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 1, "maxItems": 100 }, "excludeContactedFromOtherCampaigns": { "type": "boolean" }, "excludeHasOtherAccConversations": { "type": "boolean" }, "excludeContactedFromSenderInOtherCampaign": { "type": "boolean" }, "excludeListId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] } }, "required": [ "campaignIdForTemplate", "name", "linkedInUserListId", "linkedInAccountIds", "excludeContactedFromOtherCampaigns", "excludeHasOtherAccConversations", "excludeContactedFromSenderInOtherCampaign" ], "patternProperties": { "^(?!(?:campaignIdForTemplate|name|linkedInUserListId|linkedInAccountIds|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignIdForTemplate", "name", "linkedInUserListId", "linkedInAccountIds", "excludeContactedFromOtherCampaigns", "excludeHasOtherAccConversations", "excludeContactedFromSenderInOtherCampaign", "excludeListId" ] } }, "UpdateHeyReachCampaignSettingsInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "linkedInUserListId": { "$ref": "#/$defs/HeyReachId" }, "excludeContactedFromOtherCampaigns": { "type": "boolean" }, "excludeHasOtherAccConversations": { "type": "boolean" }, "excludeContactedFromSenderInOtherCampaign": { "type": "boolean" }, "excludeListId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] } }, "required": [ "name", "linkedInUserListId", "excludeContactedFromOtherCampaigns", "excludeHasOtherAccConversations", "excludeContactedFromSenderInOtherCampaign", "excludeListId" ], "patternProperties": { "^(?!(?:name|linkedInUserListId|excludeContactedFromOtherCampaigns|excludeHasOtherAccConversations|excludeContactedFromSenderInOtherCampaign|excludeListId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "linkedInUserListId", "excludeContactedFromOtherCampaigns", "excludeHasOtherAccConversations", "excludeContactedFromSenderInOtherCampaign", "excludeListId" ] } }, "HeyReachCampaignSequence_1": { "type": "object", "properties": { "nodeType": { "type": "string", "enum": [ "CONNECTION_REQUEST", "MESSAGE", "INMAIL", "VIEW_PROFILE", "FOLLOW", "LIKE_POST", "FIND_EMAIL", "CHECK_IS_CONNECTION", "CHECK_IS_OPEN_PROFILE", "SEND_LEAD_TO_INSTANTLY", "SEND_LEAD_TO_SMARTLEAD", "SEND_LEAD_TO_BISON", "END" ] }, "actionDelay": { "type": "integer", "minimum": 0, "maximum": 100 }, "actionDelayUnit": { "type": "string", "enum": [ "HOUR", "DAY" ] }, "externalReference": { "type": "string", "minLength": 0, "maxLength": 100 }, "payload": { "$ref": "#/$defs/HeyReachDocument" }, "unconditionalNode": { "$ref": "#/$defs/Suspend_" }, "conditionalNode": { "$ref": "#/$defs/HeyReachSequenceNode" } }, "required": [ "nodeType" ], "patternProperties": { "^(?!(?:nodeType|actionDelay|actionDelayUnit|externalReference|payload|unconditionalNode|conditionalNode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "nodeType", "actionDelay", "actionDelayUnit", "externalReference", "payload", "unconditionalNode", "conditionalNode" ] } }, "HeyReachCampaignAccountsInput": { "type": "object", "properties": { "linkedInAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 1, "maxItems": 100 } }, "required": [ "linkedInAccountIds" ], "patternProperties": { "^(?!(?:linkedInAccountIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "linkedInAccountIds" ] } ] } }, "LinkedInProfileUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "StopHeyReachLeadInput": { "type": "object", "properties": { "leadUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "leadMemberId": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "leadUrl" ], "patternProperties": { "^(?!(?:leadUrl|leadMemberId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadUrl", "leadMemberId" ] } }, "HeyReachListType": { "type": "string", "enum": [ "USER_LIST", "COMPANY_LIST" ] }, "CreateHeyReachListInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "type": { "$ref": "#/$defs/HeyReachListType" } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type" ] } }, "RemoveHeyReachListLeadsInput": { "type": "object", "properties": { "profileUrls": { "type": "array", "items": { "$ref": "#/$defs/LinkedInProfileUrl" }, "minItems": 1, "maxItems": 100 } }, "required": [ "profileUrls" ], "patternProperties": { "^(?!(?:profileUrls)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "profileUrls" ] } ] } }, "SetHeyReachLeadTagsInput": { "type": "object", "properties": { "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 100 } }, "required": [ "profileUrl", "tags" ], "patternProperties": { "^(?!(?:profileUrl|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileUrl", "tags" ] } } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachCampaignCreated": { "type": "object", "properties": { "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "campaignId" ], "patternProperties": { "^(?!(?:campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "campaignId" ] } ] } }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "HeyReachDocument": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "HeyReachText": { "type": "string", "minLength": 0, "maxLength": 10000 }, "HeyReachList": { "type": "object", "properties": { "id": { "$ref": "#/$defs/HeyReachId" }, "name": { "$ref": "#/$defs/HeyReachText" }, "totalItemsCount": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "count": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "listType": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "creationTime": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "campaignIds": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "maxItems": 1000 }, { "type": "null" } ] } }, "required": [ "id", "name", "totalItemsCount", "count", "listType", "creationTime", "campaignIds" ], "patternProperties": { "^(?!(?:id|name|totalItemsCount|count|listType|creationTime|campaignIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "totalItemsCount", "count", "listType", "creationTime", "campaignIds" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/HeyReachCampaignCreated" }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } }, { "$ref": "#/$defs/HeyReachDocument" }, { "$ref": "#/$defs/HeyReachList" } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/HeyReachCampaignCreated" }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } }, { "$ref": "#/$defs/HeyReachDocument" }, { "$ref": "#/$defs/HeyReachList" } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `heyreachCampaigns.create`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns` - `heyreachCampaigns.createFromTemplate`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/from-template` - `heyreachCampaigns.updateSettings`: `PUT /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/settings` - `heyreachCampaigns.updateSchedule`: `PUT /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/schedule` - `heyreachCampaigns.updateSequence`: `PUT /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/sequence` - `heyreachCampaigns.addAccounts`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/accounts` - `heyreachCampaigns.setAccounts`: `PUT /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/accounts` - `heyreachCampaigns.removeAccounts`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/accounts/remove` - `heyreachCampaigns.pause`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/pause` - `heyreachCampaigns.resume`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/resume` - `heyreachCampaigns.start`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/start` - `heyreachCampaigns.stopLead`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/leads/stop` - `heyreachLists.create`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/lists` - `heyreachLists.deleteLeads`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/lists/:listId/leads/remove` - `heyreachLeads.addTags`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/leads/tags` - `heyreachLeads.replaceTags`: `PUT /v1/workspaces/:workspaceId/integrations/heyreach/leads/tags` ## manage_heyreach_connection Keep the workspace's HeyReach connection healthy: re-validate the stored key, restore the reply subscription native campaigns stop on, subscribe to or remove HeyReach webhook events, or disconnect HeyReach entirely. Use when the connection read says reply tracking is not live, when a person asks to receive a HeyReach event type, or to retire the integration. Disconnect removes every subscription first and only then retires the key. This never enters or rotates the API key — that is a person's job in Settings. Disconnect and webhook removal are refused while a registration is still being confirmed; retry after two minutes. Disconnecting stops LinkedIn reply tracking for every native campaign. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:read, integration:update, integration:delete Risk: security_admin; confirmation: explicit; 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": [ "test" ] } }, "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": [ "ensure_reply_webhook" ] } }, "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": [ "disconnect" ] } }, "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": [ "create_webhook" ] }, "webhook": { "$ref": "#/$defs/CreateHeyReachWebhookInput" } }, "required": [ "workspaceId", "action", "webhook" ], "patternProperties": { "^(?!(?:workspaceId|action|webhook)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "webhook" ] } }, { "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": [ "delete_webhook" ] }, "webhookId": { "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", "webhookId" ], "patternProperties": { "^(?!(?:workspaceId|action|webhookId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "webhookId" ] } } ], "$defs": { "HeyReachWebhookEventType": { "type": "string", "enum": [ "CONNECTION_REQUEST_SENT", "CONNECTION_REQUEST_ACCEPTED", "MESSAGE_SENT", "MESSAGE_REPLY_RECEIVED", "INMAIL_SENT", "INMAIL_REPLY_RECEIVED", "EVERY_MESSAGE_REPLY_RECEIVED", "FOLLOW_SENT", "LIKED_POST", "VIEWED_PROFILE", "CAMPAIGN_COMPLETED", "LEAD_TAG_UPDATED" ] }, "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "CreateHeyReachWebhookInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "eventType": { "$ref": "#/$defs/HeyReachWebhookEventType" }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 } }, "required": [ "eventType" ], "patternProperties": { "^(?!(?:name|eventType|campaignIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "eventType", "campaignIds" ] } } } } ``` ### 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": [ "test" ] } }, "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": [ "ensure_reply_webhook" ] } }, "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": [ "disconnect" ] } }, "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": [ "create_webhook" ] }, "webhook": { "$ref": "#/$defs/CreateHeyReachWebhookInput" } }, "required": [ "workspaceId", "action", "webhook" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|webhook)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "webhook" ] }, { "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": [ "delete_webhook" ] }, "webhookId": { "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", "webhookId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|webhookId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "webhookId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "HeyReachWebhookEventType": { "type": "string", "enum": [ "CONNECTION_REQUEST_SENT", "CONNECTION_REQUEST_ACCEPTED", "MESSAGE_SENT", "MESSAGE_REPLY_RECEIVED", "INMAIL_SENT", "INMAIL_REPLY_RECEIVED", "EVERY_MESSAGE_REPLY_RECEIVED", "FOLLOW_SENT", "LIKED_POST", "VIEWED_PROFILE", "CAMPAIGN_COMPLETED", "LEAD_TAG_UPDATED" ] }, "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "CreateHeyReachWebhookInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 150 }, "eventType": { "$ref": "#/$defs/HeyReachWebhookEventType" }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 } }, "required": [ "eventType" ], "patternProperties": { "^(?!(?:name|eventType|campaignIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "eventType", "campaignIds" ] } } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HeyReachConnectionStatus": { "type": "object", "properties": { "connected": { "type": "boolean" }, "replyWebhookReady": { "type": "boolean" }, "connectionId": { "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" } ] }, "credential": { "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": { "$ref": "#/$defs/NonEmptyString" }, "kind": { "$ref": "#/$defs/NonEmptyString" }, "status": { "type": "string", "enum": [ "connected", "needs_reauthorization", "disabled", "disconnected" ] }, "fingerprint": { "$ref": "#/$defs/NonEmptyString" }, "lastFour": { "type": "string", "pattern": "^.{4}$" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastUsedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "provider", "kind", "status", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|provider|kind|status|fingerprint|lastFour|createdAt|updatedAt|lastUsedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "provider", "kind", "status", "fingerprint", "lastFour", "createdAt", "updatedAt", "lastUsedAt" ] } }, { "type": "null" } ] }, "connectedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastCheckedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "connected", "replyWebhookReady", "connectionId", "credential", "connectedAt", "lastCheckedAt" ], "patternProperties": { "^(?!(?:connected|replyWebhookReady|connectionId|credential|connectedAt|lastCheckedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "replyWebhookReady", "connectionId", "credential", "connectedAt", "lastCheckedAt" ] } }, "HeyReachDisconnectResult": { "type": "object", "properties": { "connected": { "type": "boolean", "enum": [ false ] }, "removedWebhookCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "connected", "removedWebhookCount", "disconnectedAt" ], "patternProperties": { "^(?!(?:connected|removedWebhookCount|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "removedWebhookCount", "disconnectedAt" ] } }, "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HeyReachWebhookEventType": { "type": "string", "enum": [ "CONNECTION_REQUEST_SENT", "CONNECTION_REQUEST_ACCEPTED", "MESSAGE_SENT", "MESSAGE_REPLY_RECEIVED", "INMAIL_SENT", "INMAIL_REPLY_RECEIVED", "EVERY_MESSAGE_REPLY_RECEIVED", "FOLLOW_SENT", "LIKED_POST", "VIEWED_PROFILE", "CAMPAIGN_COMPLETED", "LEAD_TAG_UPDATED" ] }, "HeyReachWebhookStatus": { "type": "string", "enum": [ "pending", "active", "failed", "deleting" ] }, "HeyReachWebhook": { "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" }, "remoteId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] }, "name": { "$ref": "#/$defs/ShortText" }, "eventType": { "$ref": "#/$defs/HeyReachWebhookEventType" }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "maxItems": 100 }, "status": { "$ref": "#/$defs/HeyReachWebhookStatus" }, "lastReceivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "remoteId", "name", "eventType", "campaignIds", "status", "lastReceivedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|remoteId|name|eventType|campaignIds|status|lastReceivedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "remoteId", "name", "eventType", "campaignIds", "status", "lastReceivedAt", "createdAt" ] } }, "HeyReachWebhookDeleted": { "type": "object", "properties": { "webhookId": { "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" }, "deleted": { "type": "boolean", "enum": [ true ] } }, "required": [ "webhookId", "deleted" ], "patternProperties": { "^(?!(?:webhookId|deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "webhookId", "deleted" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/HeyReachConnectionStatus" }, { "$ref": "#/$defs/HeyReachDisconnectResult" }, { "$ref": "#/$defs/HeyReachWebhook" }, { "$ref": "#/$defs/HeyReachWebhookDeleted" } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/HeyReachConnectionStatus" }, { "$ref": "#/$defs/HeyReachDisconnectResult" }, { "$ref": "#/$defs/HeyReachWebhook" }, { "$ref": "#/$defs/HeyReachWebhookDeleted" } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `heyreachConnection.test`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/test` - `heyreachConnection.ensureReplyWebhook`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/reply-webhook` - `heyreachConnection.disconnect`: `DELETE /v1/workspaces/:workspaceId/integrations/heyreach/disconnect` - `heyreachWebhooks.create`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/webhooks` - `heyreachWebhooks.delete`: `DELETE /v1/workspaces/:workspaceId/integrations/heyreach/webhooks/:webhookId` ## manage_inbox_settings Patches inbox settings, including customVariables under {{inbox.key}}. For per-inbox custom variable CRUD: read_inbox_health action=settings, then manage_inbox_settings action=update with the complete customVariables array: add creates, replacing a value edits, omitting a key deletes, [] clears. Unique snake_case keys up to 64 chars; nonblank values up to 10000 chars; at most 50 keys and 16384 UTF-8 bytes for the complete serialized JSON array; reserved names forbidden. Values remain escaped literal data. Also supports tracking, sync, tags, placement recipients, and bulk settings/tag/move operations. When asked to change inbox settings, verify a tracking domain, move inboxes, or designate a placement recipient. For warmup toggles or policy changes — use manage_warmup. For deletes — delete_inboxes. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: inbox:update Risk: write; confirmation: explicit; 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": [ "update" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "patch": { "type": "object", "properties": { "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 500 }, { "type": "null" } ] }, "minGapSeconds": { "type": "integer", "minimum": 120, "maximum": 21600 }, "initialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 100 }, "dailyIncrement": { "type": "integer", "minimum": 1, "maximum": 50 }, "campaignEmailRampUp": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "patternProperties": { "^(?!(?:customVariables|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|syncNonCampaignEmails|signature|customTrackingDomain|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "customVariables", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "syncNonCampaignEmails", "signature", "customTrackingDomain", "tagIds" ] }, "minProperties": 1, "maxProperties": 15 } }, "required": [ "workspaceId", "action", "inboxId", "patch" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|patch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "patch" ] } }, { "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": [ "verify_tracking_domain" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "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": [ "bulk_update" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "settings": { "type": "object", "properties": { "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "type": "integer", "minimum": 0, "maximum": 500 }, "minGapSeconds": { "type": "integer", "minimum": 120, "maximum": 21600 }, "campaignEmailRampUp": { "type": "boolean" }, "initialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 100 }, "dailyIncrement": { "type": "integer", "minimum": 1, "maximum": 50 }, "warmupEnabled": { "type": "boolean" }, "warmupFilterTag": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupIncludeFilterTag": { "type": "boolean" }, "dailyWarmupLimit": { "type": "integer", "minimum": 1, "maximum": 50 }, "warmupRampUp": { "type": "boolean" }, "warmupInitialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 50 }, "warmupDailyIncrement": { "type": "integer", "minimum": 1, "maximum": 20 }, "warmupRandomizedLimitEnabled": { "type": "boolean" }, "warmupRandomizedLimitPercent": { "type": "integer", "minimum": 0, "maximum": 100 }, "warmupBusinessType": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupScheduleEnabled": { "type": "boolean" }, "warmupTimezone": { "$ref": "#/$defs/ShortText" }, "warmupWeekdaysOnly": { "type": "boolean" }, "warmupStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupReplyRate": { "type": "integer", "minimum": 0, "maximum": 100 }, "syncNonCampaignEmails": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "patternProperties": { "^(?!(?:senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|campaignEmailRampUp|initialDailyLimit|dailyIncrement|warmupEnabled|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|syncNonCampaignEmails|signature|customTrackingDomain|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "campaignEmailRampUp", "initialDailyLimit", "dailyIncrement", "warmupEnabled", "warmupFilterTag", "warmupIncludeFilterTag", "dailyWarmupLimit", "warmupRampUp", "warmupInitialDailyLimit", "warmupDailyIncrement", "warmupRandomizedLimitEnabled", "warmupRandomizedLimitPercent", "warmupBusinessType", "warmupScheduleEnabled", "warmupTimezone", "warmupWeekdaysOnly", "warmupStartTime", "warmupEndTime", "warmupReplyRate", "syncNonCampaignEmails", "signature", "customTrackingDomain", "tagIds" ] }, "minProperties": 1, "maxProperties": 30 } }, "required": [ "inboxIds", "settings" ], "patternProperties": { "^(?!(?:inboxIds|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "settings" ] } } }, "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": [ "assign_tags" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 20 }, "mode": { "type": "string", "enum": [ "add", "remove" ] } }, "required": [ "inboxIds", "tagIds" ], "patternProperties": { "^(?!(?:inboxIds|tagIds|mode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "tagIds", "mode" ] } } }, "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": [ "move" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "targetWorkspaceId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "inboxIds", "targetWorkspaceId" ], "patternProperties": { "^(?!(?:inboxIds|targetWorkspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "targetWorkspaceId" ] } } }, "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": [ "designate_placement_recipient" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "confirmDedicated": { "type": "boolean", "enum": [ true ] } }, "required": [ "workspaceId", "action", "inboxId", "confirmDedicated" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|confirmDedicated)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "confirmDedicated" ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### 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": [ "update" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "patch": { "type": "object", "properties": { "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 500 }, { "type": "null" } ] }, "minGapSeconds": { "type": "integer", "minimum": 120, "maximum": 21600 }, "initialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 100 }, "dailyIncrement": { "type": "integer", "minimum": 1, "maximum": 50 }, "campaignEmailRampUp": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "patternProperties": { "^(?!(?:customVariables|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|syncNonCampaignEmails|signature|customTrackingDomain|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "customVariables", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "syncNonCampaignEmails", "signature", "customTrackingDomain", "tagIds" ] }, "minProperties": 1, "maxProperties": 15 } }, "required": [ "workspaceId", "action", "inboxId", "patch" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|patch)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "patch" ] }, { "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": [ "verify_tracking_domain" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "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": [ "bulk_update" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "settings": { "type": "object", "properties": { "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "type": "integer", "minimum": 0, "maximum": 500 }, "minGapSeconds": { "type": "integer", "minimum": 120, "maximum": 21600 }, "campaignEmailRampUp": { "type": "boolean" }, "initialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 100 }, "dailyIncrement": { "type": "integer", "minimum": 1, "maximum": 50 }, "warmupEnabled": { "type": "boolean" }, "warmupFilterTag": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupIncludeFilterTag": { "type": "boolean" }, "dailyWarmupLimit": { "type": "integer", "minimum": 1, "maximum": 50 }, "warmupRampUp": { "type": "boolean" }, "warmupInitialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 50 }, "warmupDailyIncrement": { "type": "integer", "minimum": 1, "maximum": 20 }, "warmupRandomizedLimitEnabled": { "type": "boolean" }, "warmupRandomizedLimitPercent": { "type": "integer", "minimum": 0, "maximum": 100 }, "warmupBusinessType": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupScheduleEnabled": { "type": "boolean" }, "warmupTimezone": { "$ref": "#/$defs/ShortText" }, "warmupWeekdaysOnly": { "type": "boolean" }, "warmupStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupReplyRate": { "type": "integer", "minimum": 0, "maximum": 100 }, "syncNonCampaignEmails": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "patternProperties": { "^(?!(?:senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|campaignEmailRampUp|initialDailyLimit|dailyIncrement|warmupEnabled|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|syncNonCampaignEmails|signature|customTrackingDomain|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "campaignEmailRampUp", "initialDailyLimit", "dailyIncrement", "warmupEnabled", "warmupFilterTag", "warmupIncludeFilterTag", "dailyWarmupLimit", "warmupRampUp", "warmupInitialDailyLimit", "warmupDailyIncrement", "warmupRandomizedLimitEnabled", "warmupRandomizedLimitPercent", "warmupBusinessType", "warmupScheduleEnabled", "warmupTimezone", "warmupWeekdaysOnly", "warmupStartTime", "warmupEndTime", "warmupReplyRate", "syncNonCampaignEmails", "signature", "customTrackingDomain", "tagIds" ] }, "minProperties": 1, "maxProperties": 30 } }, "required": [ "inboxIds", "settings" ], "patternProperties": { "^(?!(?:inboxIds|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "settings" ] } } }, "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": [ "assign_tags" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 20 }, "mode": { "type": "string", "enum": [ "add", "remove" ] } }, "required": [ "inboxIds", "tagIds" ], "patternProperties": { "^(?!(?:inboxIds|tagIds|mode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "tagIds", "mode" ] } } }, "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": [ "move" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "targetWorkspaceId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "inboxIds", "targetWorkspaceId" ], "patternProperties": { "^(?!(?:inboxIds|targetWorkspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "targetWorkspaceId" ] } } }, "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": [ "designate_placement_recipient" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "confirmDedicated": { "type": "boolean", "enum": [ true ] } }, "required": [ "workspaceId", "action", "inboxId", "confirmDedicated" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|confirmDedicated)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "confirmDedicated" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" }, "HexColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 120, "maximum": 21600 }, { "type": "null" } ] }, "initialDailyLimit": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 100 }, { "type": "null" } ] }, "dailyIncrement": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50 }, { "type": "null" } ] }, "campaignEmailRampUp": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "customTrackingDomainVerified": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "isPlacementTestRecipient": { "type": "boolean" }, "canSyncNonCampaignEmails": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } } }, "required": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ], "patternProperties": { "^(?!(?:id|emailAddress|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|signature|customVariables|customTrackingDomain|customTrackingDomainVerified|syncNonCampaignEmails|isPlacementTestRecipient|canSyncNonCampaignEmails|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ] } }, { "type": "object", "properties": { "verified": { "type": "boolean" }, "ready": { "type": "boolean" }, "cnameRecords": { "type": "array", "items": { "$ref": "#/$defs/DomainName" } }, "tls": { "anyOf": [ { "type": "object", "properties": { "supported": { "type": "boolean" }, "configured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "clientStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "supported", "configured", "clientStatus", "error" ], "patternProperties": { "^(?!(?:supported|configured|clientStatus|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "supported", "configured", "clientStatus", "error" ] } }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "verified", "ready", "cnameRecords", "tls", "error" ], "patternProperties": { "^(?!(?:verified|ready|cnameRecords|tls|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "verified", "ready", "cnameRecords", "tls", "error" ] } }, { "type": "object", "properties": { "outcomes": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "status": { "type": "string", "enum": [ "updated", "skipped", "failed" ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "inboxId", "status", "reason" ], "patternProperties": { "^(?!(?:inboxId|status|reason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "status", "reason" ] } } } }, "required": [ "outcomes" ], "patternProperties": { "^(?!(?:outcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "outcomes" ] } ] } }, { "type": "object", "properties": { "designated": { "type": "boolean", "enum": [ true ] } }, "required": [ "designated" ], "patternProperties": { "^(?!(?:designated)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "designated" ] } ] } } ] }, { "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" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 120, "maximum": 21600 }, { "type": "null" } ] }, "initialDailyLimit": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 100 }, { "type": "null" } ] }, "dailyIncrement": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50 }, { "type": "null" } ] }, "campaignEmailRampUp": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "customTrackingDomainVerified": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "isPlacementTestRecipient": { "type": "boolean" }, "canSyncNonCampaignEmails": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } } }, "required": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ], "patternProperties": { "^(?!(?:id|emailAddress|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|signature|customVariables|customTrackingDomain|customTrackingDomainVerified|syncNonCampaignEmails|isPlacementTestRecipient|canSyncNonCampaignEmails|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ] } }, { "type": "object", "properties": { "verified": { "type": "boolean" }, "ready": { "type": "boolean" }, "cnameRecords": { "type": "array", "items": { "$ref": "#/$defs/DomainName" } }, "tls": { "anyOf": [ { "type": "object", "properties": { "supported": { "type": "boolean" }, "configured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "clientStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "supported", "configured", "clientStatus", "error" ], "patternProperties": { "^(?!(?:supported|configured|clientStatus|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "supported", "configured", "clientStatus", "error" ] } }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "verified", "ready", "cnameRecords", "tls", "error" ], "patternProperties": { "^(?!(?:verified|ready|cnameRecords|tls|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "verified", "ready", "cnameRecords", "tls", "error" ] } }, { "type": "object", "properties": { "outcomes": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "status": { "type": "string", "enum": [ "updated", "skipped", "failed" ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "inboxId", "status", "reason" ], "patternProperties": { "^(?!(?:inboxId|status|reason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "status", "reason" ] } } } }, "required": [ "outcomes" ], "patternProperties": { "^(?!(?:outcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "outcomes" ] } ] } }, { "type": "object", "properties": { "designated": { "type": "boolean", "enum": [ true ] } }, "required": [ "designated" ], "patternProperties": { "^(?!(?:designated)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "designated" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `inboxSettings.update`: `PATCH /v1/workspaces/:workspaceId/inboxes/:inboxId/settings` - `inboxSettings.verifyTrackingDomain`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/verify-tracking-domain` - `inboxBulk.updateSettings`: `PATCH /v1/workspaces/:workspaceId/inboxes/bulk/settings` - `inboxBulk.assignTags`: `PATCH /v1/workspaces/:workspaceId/inboxes/bulk/tags` - `inboxBulk.move`: `POST /v1/workspaces/:workspaceId/inboxes/bulk/move` - `inboxPlacementDiagnostics.designateRecipient`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/placement-diagnostics/recipient` ## manage_inbox_tags List, create, update, or delete the inbox tags available inside a workspace. Use to organize the workspace's shared tag vocabulary for leads and threads. Tag names are unique per workspace; deleting a tag detaches it from every lead that referenced it. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: tag:read, tag:create, tag:update, tag:delete Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "search": { "$ref": "#/$defs/ShortText" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|search|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "search", "cursor", "limit" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "input": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "name", "color" ], "patternProperties": { "^(?!(?:name|color|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "color", "description" ] } } }, "required": [ "workspaceId", "action", "input" ], "patternProperties": { "^(?!(?:workspaceId|action|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "input" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "tagId": { "type": "string", "minLength": 1, "maxLength": 64 }, "input": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:name|color|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "color", "description" ] }, "minProperties": 1, "maxProperties": 3 } }, "required": [ "workspaceId", "action", "tagId", "input" ], "patternProperties": { "^(?!(?:workspaceId|action|tagId|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "tagId", "input" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "tagId": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "workspaceId", "action", "tagId" ], "patternProperties": { "^(?!(?:workspaceId|action|tagId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "tagId" ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "HexColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" } } } ``` ### 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": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "search": { "$ref": "#/$defs/ShortText" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|search|cursor|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "search", "cursor", "limit" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "input": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "type": "string", "maxLength": 500 } }, "required": [ "name", "color" ], "patternProperties": { "^(?!(?:name|color|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "color", "description" ] } } }, "required": [ "workspaceId", "action", "input" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|input)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "input" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "tagId": { "type": "string", "minLength": 1, "maxLength": 64 }, "input": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:name|color|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "color", "description" ] }, "minProperties": 1, "maxProperties": 3 } }, "required": [ "workspaceId", "action", "tagId", "input" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|tagId|input)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "tagId", "input" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "tagId": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "workspaceId", "action", "tagId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|tagId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "tagId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "HexColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "HexColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `inboxTags.list`: `GET /v1/workspaces/:workspaceId/settings/inbox-tags` - `inboxTags.create`: `POST /v1/workspaces/:workspaceId/settings/inbox-tags` - `inboxTags.update`: `PATCH /v1/workspaces/:workspaceId/settings/inbox-tags/:tagId` - `inboxTags.delete`: `DELETE /v1/workspaces/:workspaceId/settings/inbox-tags/:tagId` ## 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` ## manage_lead_contact_points Mark contact points bad/active (action=set_status) or reorder them (action=reorder); position 1 is the scalar mirror. Use to correct bad contact data or reprioritize outreach order on one lead. Reactivation of a call_disposition phone restores dialer wrong-number state — it is not silent. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: lead:update Risk: write; confirmation: explicit; 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" }, "leadId": { "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": [ "set_status", "reorder" ] }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "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" }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "orderedIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "workspaceId", "leadId", "action", "kind" ], "patternProperties": { "^(?!(?:workspaceId|leadId|action|kind|id|status|orderedIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "leadId", "action", "kind", "id", "status", "orderedIds" ] } } ``` ### 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" }, "leadId": { "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": [ "set_status", "reorder" ] }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "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" }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "orderedIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "workspaceId", "leadId", "action", "kind" ], "patternProperties": { "^(?!(?:workspaceId|leadId|action|kind|id|status|orderedIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "leadId", "action", "kind", "id", "status", "orderedIds" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ``` ### Underlying API operations - `leads.setContactPointStatus`: `POST /v1/workspaces/:workspaceId/leads/:leadId/contact-points/status` - `leads.reorderContactPoints`: `POST /v1/workspaces/:workspaceId/leads/:leadId/contact-points/reorder` ## manage_lead_lists Manage lead lists and folders with an explicit action: create, create_folder, get, list, tree, update, update_folder, move, delete, or delete_folder. The server derives replay keys from the request for create, create_folder, and move; other actions use resource state for idempotency. Use to organize leads into lists/folders or to inspect the workspace tree. Moves reject cycles and foreign parents; deleting a folder with child folders conflicts. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: leadList:read, leadList:create, leadList:update, leadList:delete Risk: write; confirmation: explicit; 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" }, "action": { "type": "string", "enum": [ "create", "create_folder", "get", "list", "tree", "update", "update_folder", "move", "delete", "delete_folder" ] }, "listId": { "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" }, "folderId": { "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" }, "customFieldNames": { "type": "array", "items": { "type": "string" } }, "parentId": { "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" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "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": "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": { "type": "string", "enum": [ "folder", "list" ] } }, "required": [ "id", "type" ], "patternProperties": { "^(?!(?:id|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type" ] } } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|listId|folderId|name|customFieldNames|parentId|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "listId", "folderId", "name", "customFieldNames", "parentId", "items" ] } } ``` ### 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" }, "action": { "type": "string", "enum": [ "create", "create_folder", "get", "list", "tree", "update", "update_folder", "move", "delete", "delete_folder" ] }, "listId": { "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" }, "folderId": { "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" }, "customFieldNames": { "type": "array", "items": { "type": "string" } }, "parentId": { "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" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "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": "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": { "type": "string", "enum": [ "folder", "list" ] } }, "required": [ "id", "type" ], "patternProperties": { "^(?!(?:id|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type" ] } } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|listId|folderId|name|customFieldNames|parentId|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "listId", "folderId", "name", "customFieldNames", "parentId", "items" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "LeadListTree": { "type": "object", "additionalProperties": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "$ref": "#/$defs/LeadStoredText" }, "type": { "type": "string", "enum": [ "folder", "list" ] }, "parentId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "children": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "name", "type", "parentId", "children" ], "patternProperties": { "^(?!(?:id|name|type|parentId|children)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "type", "parentId", "children" ] } } } }, "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" }, "name": { "$ref": "#/$defs/LeadStoredText" }, "customFieldNames": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/LeadStoredText" } }, { "type": "null" } ] }, "folderId": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "customFieldNames", "folderId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|customFieldNames|folderId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "customFieldNames", "folderId", "createdAt", "updatedAt" ] } }, { "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" }, "name": { "$ref": "#/$defs/LeadStoredText" }, "parentId": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "parentId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|parentId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "parentId", "createdAt", "updatedAt" ] } }, { "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" }, "name": { "$ref": "#/$defs/LeadStoredText" }, "customFieldNames": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/LeadStoredText" } }, { "type": "null" } ] }, "folderId": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "customFieldNames", "folderId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|customFieldNames|folderId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "customFieldNames", "folderId", "createdAt", "updatedAt" ] } } }, { "$ref": "#/$defs/LeadListTree" }, { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ] }, { "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" }, "name": { "$ref": "#/$defs/LeadStoredText" }, "customFieldNames": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/LeadStoredText" } }, { "type": "null" } ] }, "folderId": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "customFieldNames", "folderId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|customFieldNames|folderId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "customFieldNames", "folderId", "createdAt", "updatedAt" ] } }, { "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" }, "name": { "$ref": "#/$defs/LeadStoredText" }, "parentId": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "parentId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|parentId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "parentId", "createdAt", "updatedAt" ] } }, { "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" }, "name": { "$ref": "#/$defs/LeadStoredText" }, "customFieldNames": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/LeadStoredText" } }, { "type": "null" } ] }, "folderId": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "customFieldNames", "folderId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|customFieldNames|folderId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "customFieldNames", "folderId", "createdAt", "updatedAt" ] } } }, { "$ref": "#/$defs/LeadListTree" }, { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `leadLists.create`: `POST /v1/workspaces/:workspaceId/lead-lists` - `leadLists.createFolder`: `POST /v1/workspaces/:workspaceId/lead-lists/folders` - `leadLists.get`: `GET /v1/workspaces/:workspaceId/lead-lists/:listId` - `leadLists.list`: `GET /v1/workspaces/:workspaceId/lead-lists` - `leadLists.tree`: `GET /v1/workspaces/:workspaceId/lead-lists/tree` - `leadLists.update`: `PATCH /v1/workspaces/:workspaceId/lead-lists/:listId` - `leadLists.updateFolder`: `PATCH /v1/workspaces/:workspaceId/lead-lists/folders/:folderId` - `leadLists.move`: `PUT /v1/workspaces/:workspaceId/lead-lists/parent` - `leadLists.delete`: `DELETE /v1/workspaces/:workspaceId/lead-lists/:listId` - `leadLists.deleteFolder`: `DELETE /v1/workspaces/:workspaceId/lead-lists/folders/:folderId` ## 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` ## manage_organization Rename an Organization. Use when the user asks to rename an Organization they manage. Deleting or transferring an Organization is owner-only and must be done by the user in settings. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: org:update Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "organizationId": { "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": { "$ref": "#/$defs/ShortText" } }, "required": [ "organizationId", "name" ], "patternProperties": { "^(?!(?:organizationId|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "name" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "organizationId": { "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": { "$ref": "#/$defs/ShortText" } }, "required": [ "organizationId", "name" ], "patternProperties": { "^(?!(?:organizationId|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "name" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isOwner": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] } }, "visibleWorkspaceCount": { "type": "integer" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "slug": { "$ref": "#/$defs/ShortText" }, "owner": { "anyOf": [ { "type": "object", "properties": { "userId": { "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" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, { "type": "null" } ] } }, "required": [ "id", "name", "logo", "isOwner", "permissions", "visibleWorkspaceCount", "createdAt", "slug", "owner" ], "patternProperties": { "^(?!(?:id|name|logo|isOwner|permissions|visibleWorkspaceCount|createdAt|slug|owner)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "logo", "isOwner", "permissions", "visibleWorkspaceCount", "createdAt", "slug", "owner" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "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$" } } } ``` ### Underlying API operations - `organizations.update`: `PATCH /v1/organizations/:organizationId` ## manage_organization_members List Organization or Workspace members and change or remove their grants within the user's own permissions. Use to give a member roles, direct permissions, an all-Workspaces grant, or per-Workspace access, or to remove them. Grants can never exceed what the user holds; the owner changes only by ownership transfer. Use invitations to add new people. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: orgMember:read, orgMember:update, orgMember:remove, workspaceMember:read, workspaceMember:update, workspaceMember:remove Risk: destructive; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "listWorkspace" ] } ] }, "organizationId": { "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" } }, "required": [ "action", "organizationId", "workspaceId" ], "patternProperties": { "^(?!(?:action|organizationId|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "updateGrants" ] } ] }, "organizationId": { "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" }, "userId": { "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" }, "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 128 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "workspaceId", "roles", "direct" ], "patternProperties": { "^(?!(?:workspaceId|roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "direct" ] } }, "maxItems": 500 } }, "required": [ "action", "organizationId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|userId|organization|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "userId", "organization", "allWorkspaces", "workspaces" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "remove" ] } ] }, "organizationId": { "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" }, "userId": { "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", "organizationId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|userId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "userId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "removeFromWorkspace" ] } ] }, "organizationId": { "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" }, "userId": { "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", "organizationId", "workspaceId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|workspaceId|userId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "workspaceId", "userId" ] } } ], "$defs": { "RoleId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ManageOrganizationMembersInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "listWorkspace" ] } ] }, "organizationId": { "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" } }, "required": [ "action", "organizationId", "workspaceId" ], "patternProperties": { "^(?!(?:action|organizationId|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "updateGrants" ] } ] }, "organizationId": { "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" }, "userId": { "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" }, "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 128 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "workspaceId", "roles", "direct" ], "patternProperties": { "^(?!(?:workspaceId|roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "direct" ] } }, "maxItems": 500 } }, "required": [ "action", "organizationId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|userId|organization|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "userId", "organization", "allWorkspaces", "workspaces" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "remove" ] } ] }, "organizationId": { "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" }, "userId": { "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", "organizationId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|userId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "userId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "removeFromWorkspace" ] } ] }, "organizationId": { "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" }, "userId": { "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", "organizationId", "workspaceId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|workspaceId|userId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "workspaceId", "userId" ] } } ] } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "listWorkspace" ] } ] }, "organizationId": { "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" } }, "required": [ "action", "organizationId", "workspaceId" ], "patternProperties": { "^(?!(?:action|organizationId|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "updateGrants" ] } ] }, "organizationId": { "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" }, "userId": { "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" }, "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 128 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "workspaceId", "roles", "direct" ], "patternProperties": { "^(?!(?:workspaceId|roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "direct" ] } }, "maxItems": 500 } }, "required": [ "action", "organizationId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|userId|organization|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "userId", "organization", "allWorkspaces", "workspaces" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "remove" ] } ] }, "organizationId": { "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" }, "userId": { "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", "organizationId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|userId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "userId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "removeFromWorkspace" ] } ] }, "organizationId": { "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" }, "userId": { "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", "organizationId", "workspaceId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|workspaceId|userId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "workspaceId", "userId" ] } } ], "$defs": { "RoleId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ManageOrganizationMembersInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "listWorkspace" ] } ] }, "organizationId": { "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" } }, "required": [ "action", "organizationId", "workspaceId" ], "patternProperties": { "^(?!(?:action|organizationId|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "updateGrants" ] } ] }, "organizationId": { "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" }, "userId": { "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" }, "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 128 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "workspaceId", "roles", "direct" ], "patternProperties": { "^(?!(?:workspaceId|roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "direct" ] } }, "maxItems": 500 } }, "required": [ "action", "organizationId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|userId|organization|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "userId", "organization", "allWorkspaces", "workspaces" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "remove" ] } ] }, "organizationId": { "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" }, "userId": { "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", "organizationId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|userId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "userId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "removeFromWorkspace" ] } ] }, "organizationId": { "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" }, "userId": { "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", "organizationId", "workspaceId", "userId" ], "patternProperties": { "^(?!(?:action|organizationId|workspaceId|userId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "workspaceId", "userId" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "RoleId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ManageOrganizationMembersOutput": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "userId": { "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" }, "email": { "type": "string" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isOwner": { "type": "boolean" }, "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 128 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "workspaceId", "roles", "direct" ], "patternProperties": { "^(?!(?:workspaceId|roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "direct" ] } } }, "manageable": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isOwner", "organization", "allWorkspaces", "workspaces", "manageable" ], "patternProperties": { "^(?!(?:userId|name|email|image|isOwner|organization|allWorkspaces|workspaces|manageable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isOwner", "organization", "allWorkspaces", "workspaces", "manageable" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "userId": { "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" }, "email": { "type": "string" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isOwner": { "type": "boolean" }, "grant": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "inherited": { "type": "boolean" }, "manageable": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isOwner", "grant", "permissions", "inherited", "manageable" ], "patternProperties": { "^(?!(?:userId|name|email|image|isOwner|grant|permissions|inherited|manageable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isOwner", "grant", "permissions", "inherited", "manageable" ] } } }, { "type": "object", "properties": { "userId": { "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" }, "email": { "type": "string" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isOwner": { "type": "boolean" }, "organization": { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] }, "maxItems": 128 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "roles", "direct" ], "patternProperties": { "^(?!(?:roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "direct" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/RoleId" }, "maxItems": 32 }, "direct": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "maxItems": 512 } }, "required": [ "workspaceId", "roles", "direct" ], "patternProperties": { "^(?!(?:workspaceId|roles|direct)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "roles", "direct" ] } } }, "manageable": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isOwner", "organization", "allWorkspaces", "workspaces", "manageable" ], "patternProperties": { "^(?!(?:userId|name|email|image|isOwner|organization|allWorkspaces|workspaces|manageable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isOwner", "organization", "allWorkspaces", "workspaces", "manageable" ] } }, { "type": "object", "properties": { "removed": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "removed" ], "patternProperties": { "^(?!(?:removed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "removed" ] } ] } } ] } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/ManageOrganizationMembersOutput" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/ManageOrganizationMembersOutput" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `organizationAccess.listMembers`: `GET /v1/organizations/:organizationId/members` - `organizationAccess.listWorkspaceMembers`: `GET /v1/organizations/:organizationId/workspaces/:workspaceId/members` - `organizationAccess.updateMemberGrants`: `PUT /v1/organizations/:organizationId/members/:userId/grants` - `organizationAccess.removeMember`: `DELETE /v1/organizations/:organizationId/members/:userId` - `organizationAccess.removeWorkspaceMember`: `DELETE /v1/organizations/:organizationId/workspaces/:workspaceId/members/:userId` ## manage_organization_roles List, create, update, or delete an Organization's custom roles (Organization or Workspace scope). Use to define reusable permission sets; preview dependents before deleting an assigned role. System roles are immutable; a role can only contain permissions the user holds. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: role:read, role:manage Risk: destructive; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "organizationId": { "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": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "organization", "workspace" ] }, "permissions": { "type": "array", "items": { "type": "string" }, "maxItems": 512 } }, "required": [ "action", "organizationId", "name", "scope", "permissions" ], "patternProperties": { "^(?!(?:action|organizationId|name|scope|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "name", "scope", "permissions" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ShortText" }, "permissions": { "type": "array", "items": { "type": "string" }, "maxItems": 512 } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId|name|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId", "name", "permissions" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "dependents" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId" ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ManageOrganizationRolesInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "organizationId": { "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": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "organization", "workspace" ] }, "permissions": { "type": "array", "items": { "type": "string" }, "maxItems": 512 } }, "required": [ "action", "organizationId", "name", "scope", "permissions" ], "patternProperties": { "^(?!(?:action|organizationId|name|scope|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "name", "scope", "permissions" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ShortText" }, "permissions": { "type": "array", "items": { "type": "string" }, "maxItems": 512 } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId|name|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId", "name", "permissions" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "dependents" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId" ] } } ] } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "organizationId": { "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": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "organization", "workspace" ] }, "permissions": { "type": "array", "items": { "type": "string" }, "maxItems": 512 } }, "required": [ "action", "organizationId", "name", "scope", "permissions" ], "patternProperties": { "^(?!(?:action|organizationId|name|scope|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "name", "scope", "permissions" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ShortText" }, "permissions": { "type": "array", "items": { "type": "string" }, "maxItems": 512 } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId|name|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId", "name", "permissions" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "dependents" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId" ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ManageOrganizationRolesInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "organizationId": { "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", "organizationId" ], "patternProperties": { "^(?!(?:action|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "organizationId": { "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": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "organization", "workspace" ] }, "permissions": { "type": "array", "items": { "type": "string" }, "maxItems": 512 } }, "required": [ "action", "organizationId", "name", "scope", "permissions" ], "patternProperties": { "^(?!(?:action|organizationId|name|scope|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "name", "scope", "permissions" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ShortText" }, "permissions": { "type": "array", "items": { "type": "string" }, "maxItems": 512 } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId|name|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId", "name", "permissions" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "dependents" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "organizationId": { "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" }, "roleId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "action", "organizationId", "roleId" ], "patternProperties": { "^(?!(?:action|organizationId|roleId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "organizationId", "roleId" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "RoleId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "ManageOrganizationRolesOutput": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/RoleId" }, "name": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "organization", "workspace" ] }, "permissions": { "type": "array", "items": { "type": "string" } }, "system": { "type": "boolean" }, "assignedCount": { "type": "integer" } }, "required": [ "id", "name", "scope", "permissions", "system", "assignedCount" ], "patternProperties": { "^(?!(?:id|name|scope|permissions|system|assignedCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "scope", "permissions", "system", "assignedCount" ] } } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/RoleId" }, "name": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "organization", "workspace" ] }, "permissions": { "type": "array", "items": { "type": "string" } }, "system": { "type": "boolean" }, "assignedCount": { "type": "integer" } }, "required": [ "id", "name", "scope", "permissions", "system", "assignedCount" ], "patternProperties": { "^(?!(?:id|name|scope|permissions|system|assignedCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "scope", "permissions", "system", "assignedCount" ] } }, { "type": "object", "properties": { "roleId": { "$ref": "#/$defs/RoleId" }, "members": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } } } }, "required": [ "roleId", "members" ], "patternProperties": { "^(?!(?:roleId|members)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roleId", "members" ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] }, "affectedUserIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "deleted", "affectedUserIds" ], "patternProperties": { "^(?!(?:deleted|affectedUserIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "deleted", "affectedUserIds" ] } } ] } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/ManageOrganizationRolesOutput" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/ManageOrganizationRolesOutput" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `organizationRoles.list`: `GET /v1/organizations/:organizationId/roles` - `organizationRoles.create`: `POST /v1/organizations/:organizationId/roles` - `organizationRoles.update`: `PATCH /v1/organizations/:organizationId/roles/:roleId` - `organizationRoles.dependents`: `GET /v1/organizations/:organizationId/roles/:roleId/dependents` - `organizationRoles.delete`: `DELETE /v1/organizations/:organizationId/roles/:roleId` ## manage_own_profile Update the caller's own profile (name, image, onboarding flag) with a best-effort remote mirror. Use to change the signed-in member's own display fields. Cannot change another member's profile or any workspace resource. Scopes: workspace:update Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "hasCompletedOnboarding": { "type": "boolean" } }, "patternProperties": { "^(?!(?:name|image|hasCompletedOnboarding)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "image", "hasCompletedOnboarding" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "hasCompletedOnboarding": { "type": "boolean" } }, "patternProperties": { "^(?!(?:name|image|hasCompletedOnboarding)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "image", "hasCompletedOnboarding" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } } } ``` ### Output schema (structuredContent) ```json { "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" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "hasCompletedOnboarding": { "type": "boolean" } }, "required": [ "id", "name", "email", "image", "hasCompletedOnboarding" ], "patternProperties": { "^(?!(?:id|name|email|image|hasCompletedOnboarding)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "email", "image", "hasCompletedOnboarding" ] }, "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } } } ``` ### Underlying API operations - `me.updateProfile`: `PATCH /v1/me/profile` ## manage_recording_consent_policy Read and change whether the workspace records calls, which consent rule applies, and what disclosure is spoken to the other party. Use to report the current policy, or to apply a change a person has explicitly asked for — for example turning on jurisdiction-aware consent and supplying the script it will read aloud. This decides what every future call is legally allowed to do. Turning recording on where consent is not established, or turning the disclosure off, can make the workspace's calls unlawful in some jurisdictions. It is not a preference; never change it to unblock another task. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: dialer:read, dialer:manage_numbers Risk: security_admin; confirmation: explicit; 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" }, "action": { "type": "string", "enum": [ "read", "update" ] }, "update": { "type": "object", "properties": { "recordingEnabled": { "type": "boolean" }, "consentMode": { "type": "string", "enum": [ "always_all_party", "jurisdiction_aware", "always_one_party" ] }, "allPartyConsentDefault": { "type": "boolean" }, "unknownJurisdictionDefault": { "type": "string", "enum": [ "all_party", "one_party" ] }, "disclosureScript": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:recordingEnabled|consentMode|allPartyConsentDefault|unknownJurisdictionDefault|disclosureScript)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recordingEnabled", "consentMode", "allPartyConsentDefault", "unknownJurisdictionDefault", "disclosureScript" ] }, "minProperties": 1, "maxProperties": 5 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|update)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "update" ] }, "$defs": { "Description": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### 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" }, "action": { "type": "string", "enum": [ "read", "update" ] }, "update": { "type": "object", "properties": { "recordingEnabled": { "type": "boolean" }, "consentMode": { "type": "string", "enum": [ "always_all_party", "jurisdiction_aware", "always_one_party" ] }, "allPartyConsentDefault": { "type": "boolean" }, "unknownJurisdictionDefault": { "type": "string", "enum": [ "all_party", "one_party" ] }, "disclosureScript": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:recordingEnabled|consentMode|allPartyConsentDefault|unknownJurisdictionDefault|disclosureScript)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recordingEnabled", "consentMode", "allPartyConsentDefault", "unknownJurisdictionDefault", "disclosureScript" ] }, "minProperties": 1, "maxProperties": 5 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|update)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "update" ] }, "$defs": { "Description": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "recordingEnabled": { "type": "boolean" }, "consentMode": { "type": "string", "enum": [ "always_all_party", "jurisdiction_aware", "always_one_party" ] }, "allPartyConsentDefault": { "type": "boolean" }, "unknownJurisdictionDefault": { "type": "string", "enum": [ "all_party", "one_party" ] }, "disclosureScript": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "recordingEnabled", "consentMode", "allPartyConsentDefault", "unknownJurisdictionDefault", "disclosureScript", "updatedAt" ], "patternProperties": { "^(?!(?:recordingEnabled|consentMode|allPartyConsentDefault|unknownJurisdictionDefault|disclosureScript|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recordingEnabled", "consentMode", "allPartyConsentDefault", "unknownJurisdictionDefault", "disclosureScript", "updatedAt" ] }, "$defs": { "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `dialerRecordingSettings.get`: `GET /v1/workspaces/:workspaceId/dialer/recording-settings` - `dialerRecordingSettings.update`: `PATCH /v1/workspaces/:workspaceId/dialer/recording-settings` ## manage_reply_labels List workspace reply labels and built-in defaults, or create, update, and delete custom reply labels. Use to manage the labels that classify inbound replies for a workspace. Built-in labels are read-only through listDefaults; custom label names must stay unique and carry a valid sentiment. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: replyLabel:read, replyLabel:create, replyLabel:update, replyLabel:delete Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "search": { "$ref": "#/$defs/ShortText" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|search|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "search", "cursor", "limit" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "list_defaults" ] } ] } }, "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": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "input": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "hexColor": { "$ref": "#/$defs/HexColor" }, "description": { "type": "string", "maxLength": 500 }, "sentiment": { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, "aiLabelDetection": { "type": "boolean" } }, "required": [ "name", "hexColor" ], "patternProperties": { "^(?!(?:name|hexColor|description|sentiment|aiLabelDetection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "hexColor", "description", "sentiment", "aiLabelDetection" ] } } }, "required": [ "workspaceId", "action", "input" ], "patternProperties": { "^(?!(?:workspaceId|action|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "input" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "labelId": { "type": "string", "minLength": 1, "maxLength": 64 }, "input": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "hexColor": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "aiLabelDetection": { "type": "boolean" } }, "patternProperties": { "^(?!(?:name|hexColor|description|sentiment|aiLabelDetection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "hexColor", "description", "sentiment", "aiLabelDetection" ] }, "minProperties": 1, "maxProperties": 5 } }, "required": [ "workspaceId", "action", "labelId", "input" ], "patternProperties": { "^(?!(?:workspaceId|action|labelId|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "labelId", "input" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "labelId": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "workspaceId", "action", "labelId" ], "patternProperties": { "^(?!(?:workspaceId|action|labelId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "labelId" ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "HexColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" } } } ``` ### 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": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "search": { "$ref": "#/$defs/ShortText" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|search|cursor|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "search", "cursor", "limit" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "list_defaults" ] } ] } }, "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": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "input": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "hexColor": { "$ref": "#/$defs/HexColor" }, "description": { "type": "string", "maxLength": 500 }, "sentiment": { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, "aiLabelDetection": { "type": "boolean" } }, "required": [ "name", "hexColor" ], "patternProperties": { "^(?!(?:name|hexColor|description|sentiment|aiLabelDetection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "hexColor", "description", "sentiment", "aiLabelDetection" ] } } }, "required": [ "workspaceId", "action", "input" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|input)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "input" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "labelId": { "type": "string", "minLength": 1, "maxLength": 64 }, "input": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "hexColor": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "aiLabelDetection": { "type": "boolean" } }, "patternProperties": { "^(?!(?:name|hexColor|description|sentiment|aiLabelDetection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "hexColor", "description", "sentiment", "aiLabelDetection" ] }, "minProperties": 1, "maxProperties": 5 } }, "required": [ "workspaceId", "action", "labelId", "input" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|labelId|input)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "labelId", "input" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "labelId": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "workspaceId", "action", "labelId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|labelId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "labelId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "HexColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "HexColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "hexColor": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "aiLabelDetection": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|hexColor|description|sentiment|aiLabelDetection|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "type": "string", "enum": [ "Interested", "Not Interested", "Automatic Reply", "Out of Office", "Wrong Person", "Meeting Booked", "Meeting Completed" ] }, "hexColor": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "aiLabelDetection": { "type": "boolean" } }, "required": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection" ], "patternProperties": { "^(?!(?:id|name|hexColor|description|sentiment|aiLabelDetection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "hexColor": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "aiLabelDetection": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|hexColor|description|sentiment|aiLabelDetection|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "hexColor": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "aiLabelDetection": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|hexColor|description|sentiment|aiLabelDetection|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "type": "string", "enum": [ "Interested", "Not Interested", "Automatic Reply", "Out of Office", "Wrong Person", "Meeting Booked", "Meeting Completed" ] }, "hexColor": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "aiLabelDetection": { "type": "boolean" } }, "required": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection" ], "patternProperties": { "^(?!(?:id|name|hexColor|description|sentiment|aiLabelDetection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "hexColor": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "aiLabelDetection": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|hexColor|description|sentiment|aiLabelDetection|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "description", "sentiment", "aiLabelDetection", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `replyLabels.list`: `GET /v1/workspaces/:workspaceId/settings/reply-labels` - `replyLabels.listDefaults`: `GET /v1/workspaces/:workspaceId/settings/reply-labels/defaults` - `replyLabels.create`: `POST /v1/workspaces/:workspaceId/settings/reply-labels` - `replyLabels.update`: `PATCH /v1/workspaces/:workspaceId/settings/reply-labels/:labelId` - `replyLabels.delete`: `DELETE /v1/workspaces/:workspaceId/settings/reply-labels/:labelId` ## manage_sequence_templates Create, update, or delete a workspace-owned sequence template; the action field selects the mutation. Use to author or revise the workspace's reusable sequence library after read_sequence_templates shows the current shape. System templates are immutable and foreign templates reject writes; deletes and updates require explicit confirmation. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: template:create, template:update, template:delete Risk: write; confirmation: explicit; 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" }, "action": { "type": "string", "enum": [ "create", "update", "delete" ] }, "templateId": { "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" }, "input": { "anyOf": [ { "type": "object", "properties": { "name": { "$ref": "#/$defs/TemplateName" }, "description": { "anyOf": [ { "$ref": "#/$defs/TemplateDescription" }, { "type": "null" } ] }, "category": { "anyOf": [ { "$ref": "#/$defs/TemplateCategory" }, { "type": "null" } ] }, "steps": { "type": "array", "items": { "$ref": "#/$defs/TemplateStep" }, "maxItems": 50 } }, "required": [ "name", "steps" ], "patternProperties": { "^(?!(?:name|description|category|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "description", "category", "steps" ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/TemplateName" }, "description": { "anyOf": [ { "$ref": "#/$defs/TemplateDescription" }, { "type": "null" } ] }, "category": { "anyOf": [ { "$ref": "#/$defs/TemplateCategory" }, { "type": "null" } ] }, "steps": { "type": "array", "items": { "$ref": "#/$defs/TemplateStep" }, "maxItems": 50 } }, "patternProperties": { "^(?!(?:name|description|category|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "description", "category", "steps" ] }, "minProperties": 1, "maxProperties": 4 } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|templateId|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "templateId", "input" ] }, "$defs": { "TemplateName": { "type": "string", "minLength": 1, "maxLength": 200 }, "TemplateDescription": { "type": "string", "minLength": 1, "maxLength": 1000 }, "TemplateCategory": { "type": "string", "minLength": 1, "maxLength": 100 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "$ref": "#/$defs/Arrays_" }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "Arrays_": { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, "EditorStateJson": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "$ref": "#/$defs/Arrays_" }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "TemplateStep": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "email_content" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subject": { "anyOf": [ { "$ref": "#/$defs/EditorStateJson" }, { "type": "null" } ] }, "body": { "anyOf": [ { "$ref": "#/$defs/EditorStateJson" }, { "type": "null" } ] } }, "required": [ "variantOrder", "subject", "body" ], "patternProperties": { "^(?!(?:variantOrder|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "variantOrder", "subject", "body" ] } }, "minItems": 1 } }, "required": [ "type", "delayMinutes", "variants" ], "patternProperties": { "^(?!(?:type|delayMinutes|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "variants" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "manual_review" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notificationMessage": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "notificationMessage" ], "patternProperties": { "^(?!(?:type|delayMinutes|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "linked_in_connection_request" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionNote": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "connectionNote" ], "patternProperties": { "^(?!(?:type|delayMinutes|connectionNote)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "connectionNote" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "linked_in_in_mail" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subject": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "subject", "body" ], "patternProperties": { "^(?!(?:type|delayMinutes|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "phone_call" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "script": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "script" ], "patternProperties": { "^(?!(?:type|delayMinutes|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "script" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "text_message" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "message": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "message" ], "patternProperties": { "^(?!(?:type|delayMinutes|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "http_post_request" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "url": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "url", "headers", "bodyTemplate" ], "patternProperties": { "^(?!(?:type|delayMinutes|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "heyreach_campaign" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaignId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "campaignId" ], "patternProperties": { "^(?!(?:type|delayMinutes|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "attio_task" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "content": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type", "delayMinutes", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ], "patternProperties": { "^(?!(?:type|delayMinutes|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } } ] } } } ``` ### 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" }, "action": { "type": "string", "enum": [ "create", "update", "delete" ] }, "templateId": { "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" }, "input": { "anyOf": [ { "type": "object", "properties": { "name": { "$ref": "#/$defs/TemplateName" }, "description": { "anyOf": [ { "$ref": "#/$defs/TemplateDescription" }, { "type": "null" } ] }, "category": { "anyOf": [ { "$ref": "#/$defs/TemplateCategory" }, { "type": "null" } ] }, "steps": { "type": "array", "items": { "$ref": "#/$defs/TemplateStep" }, "maxItems": 50 } }, "required": [ "name", "steps" ], "patternProperties": { "^(?!(?:name|description|category|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "description", "category", "steps" ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/TemplateName" }, "description": { "anyOf": [ { "$ref": "#/$defs/TemplateDescription" }, { "type": "null" } ] }, "category": { "anyOf": [ { "$ref": "#/$defs/TemplateCategory" }, { "type": "null" } ] }, "steps": { "type": "array", "items": { "$ref": "#/$defs/TemplateStep" }, "maxItems": 50 } }, "patternProperties": { "^(?!(?:name|description|category|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "description", "category", "steps" ] }, "minProperties": 1, "maxProperties": 4 } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|templateId|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "templateId", "input" ] }, "$defs": { "TemplateName": { "type": "string", "minLength": 1, "maxLength": 200 }, "TemplateDescription": { "type": "string", "minLength": 1, "maxLength": 1000 }, "TemplateCategory": { "type": "string", "minLength": 1, "maxLength": 100 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "$ref": "#/$defs/Arrays_" }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "Arrays_": { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, "EditorStateJson": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "$ref": "#/$defs/Arrays_" }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "TemplateStep": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "email_content" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subject": { "anyOf": [ { "$ref": "#/$defs/EditorStateJson" }, { "type": "null" } ] }, "body": { "anyOf": [ { "$ref": "#/$defs/EditorStateJson" }, { "type": "null" } ] } }, "required": [ "variantOrder", "subject", "body" ], "patternProperties": { "^(?!(?:variantOrder|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "variantOrder", "subject", "body" ] } }, "minItems": 1 } }, "required": [ "type", "delayMinutes", "variants" ], "patternProperties": { "^(?!(?:type|delayMinutes|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "variants" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "manual_review" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notificationMessage": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "notificationMessage" ], "patternProperties": { "^(?!(?:type|delayMinutes|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "linked_in_connection_request" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionNote": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "connectionNote" ], "patternProperties": { "^(?!(?:type|delayMinutes|connectionNote)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "connectionNote" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "linked_in_in_mail" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subject": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "subject", "body" ], "patternProperties": { "^(?!(?:type|delayMinutes|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "phone_call" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "script": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "script" ], "patternProperties": { "^(?!(?:type|delayMinutes|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "script" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "text_message" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "message": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "message" ], "patternProperties": { "^(?!(?:type|delayMinutes|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "http_post_request" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "url": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "url", "headers", "bodyTemplate" ], "patternProperties": { "^(?!(?:type|delayMinutes|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "heyreach_campaign" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaignId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "campaignId" ], "patternProperties": { "^(?!(?:type|delayMinutes|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "attio_task" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "content": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type", "delayMinutes", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ], "patternProperties": { "^(?!(?:type|delayMinutes|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "TemplateName": { "type": "string", "minLength": 1, "maxLength": 200 }, "TemplateDescription": { "type": "string", "minLength": 1, "maxLength": 1000 }, "TemplateCategory": { "type": "string", "minLength": 1, "maxLength": 100 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "$ref": "#/$defs/Arrays_" }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "Arrays_": { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, "EditorStateJson": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "$ref": "#/$defs/Arrays_" }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "TemplateStep": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "email_content" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subject": { "anyOf": [ { "$ref": "#/$defs/EditorStateJson" }, { "type": "null" } ] }, "body": { "anyOf": [ { "$ref": "#/$defs/EditorStateJson" }, { "type": "null" } ] } }, "required": [ "variantOrder", "subject", "body" ], "patternProperties": { "^(?!(?:variantOrder|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "variantOrder", "subject", "body" ] } }, "minItems": 1 } }, "required": [ "type", "delayMinutes", "variants" ], "patternProperties": { "^(?!(?:type|delayMinutes|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "variants" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "manual_review" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notificationMessage": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "notificationMessage" ], "patternProperties": { "^(?!(?:type|delayMinutes|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "linked_in_connection_request" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionNote": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "connectionNote" ], "patternProperties": { "^(?!(?:type|delayMinutes|connectionNote)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "connectionNote" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "linked_in_in_mail" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subject": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "subject", "body" ], "patternProperties": { "^(?!(?:type|delayMinutes|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "phone_call" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "script": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "script" ], "patternProperties": { "^(?!(?:type|delayMinutes|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "script" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "text_message" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "message": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "message" ], "patternProperties": { "^(?!(?:type|delayMinutes|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "http_post_request" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "url": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "url", "headers", "bodyTemplate" ], "patternProperties": { "^(?!(?:type|delayMinutes|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "heyreach_campaign" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaignId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "campaignId" ], "patternProperties": { "^(?!(?:type|delayMinutes|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "attio_task" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "content": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type", "delayMinutes", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ], "patternProperties": { "^(?!(?:type|delayMinutes|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } } ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "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" }, "name": { "$ref": "#/$defs/TemplateName" }, "description": { "anyOf": [ { "$ref": "#/$defs/TemplateDescription" }, { "type": "null" } ] }, "category": { "anyOf": [ { "$ref": "#/$defs/TemplateCategory" }, { "type": "null" } ] }, "isSystem": { "type": "boolean" }, "organizationId": { "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" } ] }, "steps": { "type": "array", "items": { "$ref": "#/$defs/TemplateStep" }, "maxItems": 50 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|description|category|isSystem|organizationId|steps|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ] }, { "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" }, "name": { "$ref": "#/$defs/TemplateName" }, "description": { "anyOf": [ { "$ref": "#/$defs/TemplateDescription" }, { "type": "null" } ] }, "category": { "anyOf": [ { "$ref": "#/$defs/TemplateCategory" }, { "type": "null" } ] }, "isSystem": { "type": "boolean" }, "organizationId": { "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" } ] }, "steps": { "type": "array", "items": { "$ref": "#/$defs/TemplateStep" }, "maxItems": 50 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|description|category|isSystem|organizationId|steps|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `templates.create`: `POST /v1/workspaces/:workspaceId/templates` - `templates.update`: `PATCH /v1/workspaces/:workspaceId/templates/:templateId` - `templates.delete`: `DELETE /v1/workspaces/:workspaceId/templates/:templateId` ## manage_sms_conversations Work the SMS inbox on the workspace's dialing numbers: see which numbers can text, read threads and their messages, keep read and archive state, and send a text. Use to ground a claim about what was texted, to tidy the inbox, or — after a person has approved the wording and the recipient — to send one message from a number the caller owns. Sending reaches a real phone, costs money, and cannot be recalled. It is refused for a recipient on the Do-Not-Call list or one who has opted out, and for any number the caller does not personally own. Do not send bulk or speculative messages, and do not retry a send with a fresh request id — reuse the original so the retry joins the existing message instead of texting the person twice. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: unibox:read, unibox:reply, dialer:read, dialer:dial Risk: costly; confirmation: explicit; idempotency: required. ### 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" }, "action": { "type": "string", "enum": [ "list_numbers", "list_conversations", "read_conversation", "mark_read", "set_archived", "send" ] }, "numberId": { "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" }, "counterpartyE164": { "$ref": "#/$defs/E164PhoneNumber" }, "conversations": { "type": "object", "properties": { "numberId": { "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" }, "folder": { "type": "string", "enum": [ "inbox", "archived", "all" ] }, "search": { "type": "string", "minLength": 1, "maxLength": 200 }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 50 } }, "patternProperties": { "^(?!(?:numberId|folder|search|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "folder", "search", "cursor", "limit" ] } }, "conversation": { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 50 } }, "patternProperties": { "^(?!(?:cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit" ] } }, "markRead": { "type": "object", "properties": { "numberId": { "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" }, "counterpartyE164": { "$ref": "#/$defs/E164PhoneNumber" }, "seenThroughMessageId": { "$ref": "#/$defs/SmsMessageId" } }, "required": [ "numberId", "counterpartyE164", "seenThroughMessageId" ], "patternProperties": { "^(?!(?:numberId|counterpartyE164|seenThroughMessageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "counterpartyE164", "seenThroughMessageId" ] } }, "setArchived": { "type": "object", "properties": { "numberId": { "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" }, "counterpartyE164": { "$ref": "#/$defs/E164PhoneNumber" }, "archived": { "type": "boolean" } }, "required": [ "numberId", "counterpartyE164", "archived" ], "patternProperties": { "^(?!(?:numberId|counterpartyE164|archived)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "counterpartyE164", "archived" ] } }, "send": { "type": "object", "properties": { "numberId": { "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" }, "toE164": { "type": "string", "minLength": 1, "maxLength": 40 }, "body": { "type": "string", "minLength": 1, "maxLength": 1600 } }, "required": [ "numberId", "toE164", "body" ], "patternProperties": { "^(?!(?:numberId|toE164|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "toE164", "body" ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|numberId|counterpartyE164|conversations|conversation|markRead|setArchived|send)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "numberId", "counterpartyE164", "conversations", "conversation", "markRead", "setArchived", "send" ] }, "$defs": { "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "SmsMessageId": { "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" } } } ``` ### 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" }, "action": { "type": "string", "enum": [ "list_numbers", "list_conversations", "read_conversation", "mark_read", "set_archived", "send" ] }, "numberId": { "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" }, "counterpartyE164": { "$ref": "#/$defs/E164PhoneNumber" }, "conversations": { "type": "object", "properties": { "numberId": { "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" }, "folder": { "type": "string", "enum": [ "inbox", "archived", "all" ] }, "search": { "type": "string", "minLength": 1, "maxLength": 200 }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 50 } }, "patternProperties": { "^(?!(?:numberId|folder|search|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "folder", "search", "cursor", "limit" ] } }, "conversation": { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 50 } }, "patternProperties": { "^(?!(?:cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit" ] } }, "markRead": { "type": "object", "properties": { "numberId": { "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" }, "counterpartyE164": { "$ref": "#/$defs/E164PhoneNumber" }, "seenThroughMessageId": { "$ref": "#/$defs/SmsMessageId" } }, "required": [ "numberId", "counterpartyE164", "seenThroughMessageId" ], "patternProperties": { "^(?!(?:numberId|counterpartyE164|seenThroughMessageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "counterpartyE164", "seenThroughMessageId" ] } }, "setArchived": { "type": "object", "properties": { "numberId": { "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" }, "counterpartyE164": { "$ref": "#/$defs/E164PhoneNumber" }, "archived": { "type": "boolean" } }, "required": [ "numberId", "counterpartyE164", "archived" ], "patternProperties": { "^(?!(?:numberId|counterpartyE164|archived)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "counterpartyE164", "archived" ] } }, "send": { "type": "object", "properties": { "numberId": { "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" }, "toE164": { "type": "string", "minLength": 1, "maxLength": 40 }, "body": { "type": "string", "minLength": 1, "maxLength": 1600 } }, "required": [ "numberId", "toE164", "body" ], "patternProperties": { "^(?!(?:numberId|toE164|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "toE164", "body" ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|numberId|counterpartyE164|conversations|conversation|markRead|setArchived|send)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "numberId", "counterpartyE164", "conversations", "conversation", "markRead", "setArchived", "send" ] }, "$defs": { "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "SmsMessageId": { "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" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "SmsMessageId": { "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" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "capabilities": { "anyOf": [ { "type": "object", "properties": { "voice": { "type": "boolean" }, "sms": { "type": "boolean" }, "mms": { "type": "boolean" } }, "required": [ "voice", "sms", "mms" ], "patternProperties": { "^(?!(?:voice|sms|mms)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voice", "sms", "mms" ] } }, { "type": "null" } ] }, "assignedUserId": { "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" } ] }, "assignedToCurrentUser": { "type": "boolean" }, "canSend": { "type": "boolean" }, "sendBlockedReason": { "anyOf": [ { "type": "string", "enum": [ "dialer_access_required", "reply_permission_required", "number_not_assigned", "number_unavailable", "recipient_dnc", "recipient_opted_out", "self_send" ] }, { "type": "null" } ] } }, "required": [ "id", "phoneE164", "status", "capabilities", "assignedUserId", "assignedToCurrentUser", "canSend", "sendBlockedReason" ], "patternProperties": { "^(?!(?:id|phoneE164|status|capabilities|assignedUserId|assignedToCurrentUser|canSend|sendBlockedReason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneE164", "status", "capabilities", "assignedUserId", "assignedToCurrentUser", "canSend", "sendBlockedReason" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "numberId": { "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" }, "senderNumber": { "$ref": "#/$defs/E164PhoneNumber" }, "counterpartyE164": { "$ref": "#/$defs/E164PhoneNumber" }, "displayName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastInboundAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unreadCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "isUnread": { "type": "boolean" }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "isArchived": { "type": "boolean" }, "lastMessage": { "type": "object", "properties": { "id": { "$ref": "#/$defs/SmsMessageId" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "body": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 1600 }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "registered", "submitting", "queued", "sent", "delivered", "delivery_failed", "failed", "receiving", "received", "receive_failed", "unknown" ] }, "attemptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "attachmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sentByUserId": { "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" } ] } }, "required": [ "id", "direction", "body", "status", "attemptedAt", "attachmentCount", "sentByUserId" ], "patternProperties": { "^(?!(?:id|direction|body|status|attemptedAt|attachmentCount|sentByUserId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "direction", "body", "status", "attemptedAt", "attachmentCount", "sentByUserId" ] } } }, "required": [ "numberId", "senderNumber", "counterpartyE164", "displayName", "companyName", "lastInboundAt", "unreadCount", "isUnread", "archivedAt", "isArchived", "lastMessage" ], "patternProperties": { "^(?!(?:numberId|senderNumber|counterpartyE164|displayName|companyName|lastInboundAt|unreadCount|isUnread|archivedAt|isArchived|lastMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "senderNumber", "counterpartyE164", "displayName", "companyName", "lastInboundAt", "unreadCount", "isUnread", "archivedAt", "isArchived", "lastMessage" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "conversation": { "type": "object", "properties": { "numberId": { "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" }, "senderNumber": { "$ref": "#/$defs/E164PhoneNumber" }, "counterpartyE164": { "$ref": "#/$defs/E164PhoneNumber" }, "displayName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "isArchived": { "type": "boolean" }, "canSend": { "type": "boolean" }, "sendBlockedReason": { "anyOf": [ { "type": "string", "enum": [ "dialer_access_required", "reply_permission_required", "number_not_assigned", "number_unavailable", "recipient_dnc", "recipient_opted_out", "self_send" ] }, { "type": "null" } ] } }, "required": [ "numberId", "senderNumber", "counterpartyE164", "displayName", "companyName", "archivedAt", "isArchived", "canSend", "sendBlockedReason" ], "patternProperties": { "^(?!(?:numberId|senderNumber|counterpartyE164|displayName|companyName|archivedAt|isArchived|canSend|sendBlockedReason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "senderNumber", "counterpartyE164", "displayName", "companyName", "archivedAt", "isArchived", "canSend", "sendBlockedReason" ] } }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/SmsMessageId" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "fromE164": { "$ref": "#/$defs/E164PhoneNumber" }, "toE164": { "$ref": "#/$defs/E164PhoneNumber" }, "body": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 1600 }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "registered", "submitting", "queued", "sent", "delivered", "delivery_failed", "failed", "receiving", "received", "receive_failed", "unknown" ] }, "attemptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "deliveredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "failedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "object", "properties": { "code": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "message": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "code", "message" ], "patternProperties": { "^(?!(?:code|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "code", "message" ] } }, { "type": "null" } ] }, "sentByUserId": { "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" } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ProviderId" }, "contentType": { "$ref": "#/$defs/ShortText" }, "sizeBytes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "url": { "$ref": "#/$defs/HttpUrl" }, "urlExpiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "contentType", "sizeBytes", "url", "urlExpiresAt" ], "patternProperties": { "^(?!(?:id|contentType|sizeBytes|url|urlExpiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "contentType", "sizeBytes", "url", "urlExpiresAt" ] } } } }, "required": [ "id", "direction", "fromE164", "toE164", "body", "status", "attemptedAt", "deliveredAt", "failedAt", "error", "sentByUserId", "attachments" ], "patternProperties": { "^(?!(?:id|direction|fromE164|toE164|body|status|attemptedAt|deliveredAt|failedAt|error|sentByUserId|attachments)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "direction", "fromE164", "toE164", "body", "status", "attemptedAt", "deliveredAt", "failedAt", "error", "sentByUserId", "attachments" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "conversation", "items", "nextCursor" ], "patternProperties": { "^(?!(?:conversation|items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "conversation", "items", "nextCursor" ] } }, { "type": "object", "properties": { "readThroughAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "readThroughMessageId": { "$ref": "#/$defs/SmsMessageId" } }, "required": [ "readThroughAt", "readThroughMessageId" ], "patternProperties": { "^(?!(?:readThroughAt|readThroughMessageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "readThroughAt", "readThroughMessageId" ] } }, { "type": "object", "properties": { "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "archivedAt" ], "patternProperties": { "^(?!(?:archivedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "archivedAt" ] } ] } }, { "type": "object", "properties": { "messageId": { "$ref": "#/$defs/SmsMessageId" }, "status": { "type": "string", "enum": [ "registered", "submitting", "queued", "sent", "delivered", "delivery_failed", "failed", "receiving", "received", "receive_failed", "unknown" ] }, "deduplicated": { "type": "boolean" }, "enqueued": { "type": "boolean" } }, "required": [ "messageId", "status", "deduplicated", "enqueued" ], "patternProperties": { "^(?!(?:messageId|status|deduplicated|enqueued)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "status", "deduplicated", "enqueued" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "phoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "status": { "type": "string", "enum": [ "active", "warming", "inactive", "error", "alert", "flagged", "retired" ] }, "capabilities": { "anyOf": [ { "type": "object", "properties": { "voice": { "type": "boolean" }, "sms": { "type": "boolean" }, "mms": { "type": "boolean" } }, "required": [ "voice", "sms", "mms" ], "patternProperties": { "^(?!(?:voice|sms|mms)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voice", "sms", "mms" ] } }, { "type": "null" } ] }, "assignedUserId": { "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" } ] }, "assignedToCurrentUser": { "type": "boolean" }, "canSend": { "type": "boolean" }, "sendBlockedReason": { "anyOf": [ { "type": "string", "enum": [ "dialer_access_required", "reply_permission_required", "number_not_assigned", "number_unavailable", "recipient_dnc", "recipient_opted_out", "self_send" ] }, { "type": "null" } ] } }, "required": [ "id", "phoneE164", "status", "capabilities", "assignedUserId", "assignedToCurrentUser", "canSend", "sendBlockedReason" ], "patternProperties": { "^(?!(?:id|phoneE164|status|capabilities|assignedUserId|assignedToCurrentUser|canSend|sendBlockedReason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneE164", "status", "capabilities", "assignedUserId", "assignedToCurrentUser", "canSend", "sendBlockedReason" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "numberId": { "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" }, "senderNumber": { "$ref": "#/$defs/E164PhoneNumber" }, "counterpartyE164": { "$ref": "#/$defs/E164PhoneNumber" }, "displayName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastInboundAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unreadCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "isUnread": { "type": "boolean" }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "isArchived": { "type": "boolean" }, "lastMessage": { "type": "object", "properties": { "id": { "$ref": "#/$defs/SmsMessageId" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "body": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 1600 }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "registered", "submitting", "queued", "sent", "delivered", "delivery_failed", "failed", "receiving", "received", "receive_failed", "unknown" ] }, "attemptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "attachmentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sentByUserId": { "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" } ] } }, "required": [ "id", "direction", "body", "status", "attemptedAt", "attachmentCount", "sentByUserId" ], "patternProperties": { "^(?!(?:id|direction|body|status|attemptedAt|attachmentCount|sentByUserId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "direction", "body", "status", "attemptedAt", "attachmentCount", "sentByUserId" ] } } }, "required": [ "numberId", "senderNumber", "counterpartyE164", "displayName", "companyName", "lastInboundAt", "unreadCount", "isUnread", "archivedAt", "isArchived", "lastMessage" ], "patternProperties": { "^(?!(?:numberId|senderNumber|counterpartyE164|displayName|companyName|lastInboundAt|unreadCount|isUnread|archivedAt|isArchived|lastMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "senderNumber", "counterpartyE164", "displayName", "companyName", "lastInboundAt", "unreadCount", "isUnread", "archivedAt", "isArchived", "lastMessage" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "conversation": { "type": "object", "properties": { "numberId": { "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" }, "senderNumber": { "$ref": "#/$defs/E164PhoneNumber" }, "counterpartyE164": { "$ref": "#/$defs/E164PhoneNumber" }, "displayName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "isArchived": { "type": "boolean" }, "canSend": { "type": "boolean" }, "sendBlockedReason": { "anyOf": [ { "type": "string", "enum": [ "dialer_access_required", "reply_permission_required", "number_not_assigned", "number_unavailable", "recipient_dnc", "recipient_opted_out", "self_send" ] }, { "type": "null" } ] } }, "required": [ "numberId", "senderNumber", "counterpartyE164", "displayName", "companyName", "archivedAt", "isArchived", "canSend", "sendBlockedReason" ], "patternProperties": { "^(?!(?:numberId|senderNumber|counterpartyE164|displayName|companyName|archivedAt|isArchived|canSend|sendBlockedReason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "numberId", "senderNumber", "counterpartyE164", "displayName", "companyName", "archivedAt", "isArchived", "canSend", "sendBlockedReason" ] } }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/SmsMessageId" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "fromE164": { "$ref": "#/$defs/E164PhoneNumber" }, "toE164": { "$ref": "#/$defs/E164PhoneNumber" }, "body": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 1600 }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "registered", "submitting", "queued", "sent", "delivered", "delivery_failed", "failed", "receiving", "received", "receive_failed", "unknown" ] }, "attemptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "deliveredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "failedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "object", "properties": { "code": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "message": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "code", "message" ], "patternProperties": { "^(?!(?:code|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "code", "message" ] } }, { "type": "null" } ] }, "sentByUserId": { "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" } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ProviderId" }, "contentType": { "$ref": "#/$defs/ShortText" }, "sizeBytes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "url": { "$ref": "#/$defs/HttpUrl" }, "urlExpiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "contentType", "sizeBytes", "url", "urlExpiresAt" ], "patternProperties": { "^(?!(?:id|contentType|sizeBytes|url|urlExpiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "contentType", "sizeBytes", "url", "urlExpiresAt" ] } } } }, "required": [ "id", "direction", "fromE164", "toE164", "body", "status", "attemptedAt", "deliveredAt", "failedAt", "error", "sentByUserId", "attachments" ], "patternProperties": { "^(?!(?:id|direction|fromE164|toE164|body|status|attemptedAt|deliveredAt|failedAt|error|sentByUserId|attachments)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "direction", "fromE164", "toE164", "body", "status", "attemptedAt", "deliveredAt", "failedAt", "error", "sentByUserId", "attachments" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "conversation", "items", "nextCursor" ], "patternProperties": { "^(?!(?:conversation|items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "conversation", "items", "nextCursor" ] } }, { "type": "object", "properties": { "readThroughAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "readThroughMessageId": { "$ref": "#/$defs/SmsMessageId" } }, "required": [ "readThroughAt", "readThroughMessageId" ], "patternProperties": { "^(?!(?:readThroughAt|readThroughMessageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "readThroughAt", "readThroughMessageId" ] } }, { "type": "object", "properties": { "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "archivedAt" ], "patternProperties": { "^(?!(?:archivedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "archivedAt" ] } ] } }, { "type": "object", "properties": { "messageId": { "$ref": "#/$defs/SmsMessageId" }, "status": { "type": "string", "enum": [ "registered", "submitting", "queued", "sent", "delivered", "delivery_failed", "failed", "receiving", "received", "receive_failed", "unknown" ] }, "deduplicated": { "type": "boolean" }, "enqueued": { "type": "boolean" } }, "required": [ "messageId", "status", "deduplicated", "enqueued" ], "patternProperties": { "^(?!(?:messageId|status|deduplicated|enqueued)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "status", "deduplicated", "enqueued" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `sms.numbers`: `GET /v1/workspaces/:workspaceId/sms/numbers` - `sms.conversations`: `GET /v1/workspaces/:workspaceId/sms/conversations` - `sms.conversation`: `GET /v1/workspaces/:workspaceId/sms/conversations/:numberId/:counterpartyE164` - `sms.markRead`: `POST /v1/workspaces/:workspaceId/sms/conversations/read` - `sms.setArchived`: `POST /v1/workspaces/:workspaceId/sms/conversations/archive` - `sms.send`: `POST /v1/workspaces/:workspaceId/sms/messages` ## manage_subscription Start a plan purchase, plan change, or payment-method update and hand a person the Stripe-hosted page that completes it. Use when a person wants to upgrade, switch billing cycle, or fix a failed payment. Return the `url` to them and poll the subscription until the change lands. Nothing is charged until the person completes the hosted page; never ask for card details. A frozen Organization can still use this — it is the way out. Return the authorization or checkout handoff to the person. The agent may initiate and inspect status, but must not complete the human approval. Scopes: billing:manage, billing:read Risk: costly; confirmation: human_completion; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "change_plan" ] }, "request": { "type": "object", "properties": { "plan": { "type": "string", "enum": [ "starter", "growth", "pro" ] }, "billingCycle": { "type": "string", "enum": [ "monthly", "annual" ] }, "successUrl": { "$ref": "#/$defs/HttpUrl" }, "cancelUrl": { "$ref": "#/$defs/HttpUrl" }, "returnUrl": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "plan", "successUrl", "cancelUrl" ], "patternProperties": { "^(?!(?:plan|billingCycle|successUrl|cancelUrl|returnUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "plan", "billingCycle", "successUrl", "cancelUrl", "returnUrl" ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "update_payment_method" ] }, "request": { "type": "object", "properties": { "returnUrl": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "returnUrl" ], "patternProperties": { "^(?!(?:returnUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "returnUrl" ] } ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } } ] } }, "required": [ "organizationId", "action" ], "patternProperties": { "^(?!(?:organizationId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "action" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "organizationId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "change_plan" ] }, "request": { "type": "object", "properties": { "plan": { "type": "string", "enum": [ "starter", "growth", "pro" ] }, "billingCycle": { "type": "string", "enum": [ "monthly", "annual" ] }, "successUrl": { "$ref": "#/$defs/HttpUrl" }, "cancelUrl": { "$ref": "#/$defs/HttpUrl" }, "returnUrl": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "plan", "successUrl", "cancelUrl" ], "patternProperties": { "^(?!(?:plan|billingCycle|successUrl|cancelUrl|returnUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "plan", "billingCycle", "successUrl", "cancelUrl", "returnUrl" ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "update_payment_method" ] }, "request": { "type": "object", "properties": { "returnUrl": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "returnUrl" ], "patternProperties": { "^(?!(?:returnUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "returnUrl" ] } ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } } ] } }, "required": [ "organizationId", "action" ], "patternProperties": { "^(?!(?:organizationId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "action" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "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$" }, "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "checkout", "portal" ] }, "url": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "kind", "url" ], "patternProperties": { "^(?!(?:kind|url)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "url" ] } }, { "type": "object", "properties": { "subscriptions": { "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" }, "plan": { "type": "string", "enum": [ "trial", "starter", "growth", "pro" ] }, "status": { "type": "string", "enum": [ "incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid", "paused", "frozen" ] }, "billingCycle": { "anyOf": [ { "type": "string", "enum": [ "monthly", "annual" ] }, { "type": "null" } ] }, "seats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trialStart": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "trialEnd": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cancelAtPeriodEnd": { "type": "boolean" }, "pastDueSince": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "stripeSubscriptionId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "priceId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "frozen": { "type": "boolean" }, "limits": { "anyOf": [ { "type": "object", "properties": { "maxEmailsPerMonth": { "type": "integer", "minimum": -1 }, "maxInboxes": { "type": "integer", "minimum": -1 }, "maxCampaigns": { "type": "integer", "minimum": -1 }, "maxContactsPerCampaign": { "type": "integer", "minimum": -1 }, "whiteLabelEnabled": { "type": "boolean" }, "prioritySupport": { "type": "boolean" }, "warmupPoolTier": { "type": "string", "enum": [ "standard", "premium" ] }, "maxWarmupEmailsPerDay": { "type": "integer", "minimum": -1 }, "maxWarmupInboxes": { "type": "integer", "minimum": -1 }, "privatePoolEnabled": { "type": "boolean" }, "dedicatedEgressEnabled": { "type": "boolean" }, "maxActiveEgressIps": { "type": "integer", "minimum": -1 }, "egressInfrastructureBudgetCents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "byokEnabled": { "type": "boolean" }, "fullMailboxSyncEnabled": { "type": "boolean" } }, "required": [ "maxEmailsPerMonth", "maxInboxes", "maxCampaigns", "maxContactsPerCampaign", "whiteLabelEnabled", "prioritySupport", "warmupPoolTier", "maxWarmupEmailsPerDay", "maxWarmupInboxes", "privatePoolEnabled", "dedicatedEgressEnabled", "maxActiveEgressIps", "egressInfrastructureBudgetCents", "byokEnabled", "fullMailboxSyncEnabled" ], "patternProperties": { "^(?!(?:maxEmailsPerMonth|maxInboxes|maxCampaigns|maxContactsPerCampaign|whiteLabelEnabled|prioritySupport|warmupPoolTier|maxWarmupEmailsPerDay|maxWarmupInboxes|privatePoolEnabled|dedicatedEgressEnabled|maxActiveEgressIps|egressInfrastructureBudgetCents|byokEnabled|fullMailboxSyncEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "maxEmailsPerMonth", "maxInboxes", "maxCampaigns", "maxContactsPerCampaign", "whiteLabelEnabled", "prioritySupport", "warmupPoolTier", "maxWarmupEmailsPerDay", "maxWarmupInboxes", "privatePoolEnabled", "dedicatedEgressEnabled", "maxActiveEgressIps", "egressInfrastructureBudgetCents", "byokEnabled", "fullMailboxSyncEnabled" ] } }, { "type": "null" } ] } }, "required": [ "id", "plan", "status", "billingCycle", "seats", "trialStart", "trialEnd", "periodStart", "periodEnd", "cancelAtPeriodEnd", "pastDueSince", "stripeCustomerId", "stripeSubscriptionId", "priceId", "frozen", "limits" ], "patternProperties": { "^(?!(?:id|plan|status|billingCycle|seats|trialStart|trialEnd|periodStart|periodEnd|cancelAtPeriodEnd|pastDueSince|stripeCustomerId|stripeSubscriptionId|priceId|frozen|limits)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "plan", "status", "billingCycle", "seats", "trialStart", "trialEnd", "periodStart", "periodEnd", "cancelAtPeriodEnd", "pastDueSince", "stripeCustomerId", "stripeSubscriptionId", "priceId", "frozen", "limits" ] } }, "maxItems": 20 } }, "required": [ "subscriptions" ], "patternProperties": { "^(?!(?:subscriptions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "subscriptions" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "checkout", "portal" ] }, "url": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "kind", "url" ], "patternProperties": { "^(?!(?:kind|url)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "url" ] } }, { "type": "object", "properties": { "subscriptions": { "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" }, "plan": { "type": "string", "enum": [ "trial", "starter", "growth", "pro" ] }, "status": { "type": "string", "enum": [ "incomplete", "incomplete_expired", "trialing", "active", "past_due", "canceled", "unpaid", "paused", "frozen" ] }, "billingCycle": { "anyOf": [ { "type": "string", "enum": [ "monthly", "annual" ] }, { "type": "null" } ] }, "seats": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trialStart": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "trialEnd": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "periodStart": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "periodEnd": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "cancelAtPeriodEnd": { "type": "boolean" }, "pastDueSince": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "stripeCustomerId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "stripeSubscriptionId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "priceId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "frozen": { "type": "boolean" }, "limits": { "anyOf": [ { "type": "object", "properties": { "maxEmailsPerMonth": { "type": "integer", "minimum": -1 }, "maxInboxes": { "type": "integer", "minimum": -1 }, "maxCampaigns": { "type": "integer", "minimum": -1 }, "maxContactsPerCampaign": { "type": "integer", "minimum": -1 }, "whiteLabelEnabled": { "type": "boolean" }, "prioritySupport": { "type": "boolean" }, "warmupPoolTier": { "type": "string", "enum": [ "standard", "premium" ] }, "maxWarmupEmailsPerDay": { "type": "integer", "minimum": -1 }, "maxWarmupInboxes": { "type": "integer", "minimum": -1 }, "privatePoolEnabled": { "type": "boolean" }, "dedicatedEgressEnabled": { "type": "boolean" }, "maxActiveEgressIps": { "type": "integer", "minimum": -1 }, "egressInfrastructureBudgetCents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "byokEnabled": { "type": "boolean" }, "fullMailboxSyncEnabled": { "type": "boolean" } }, "required": [ "maxEmailsPerMonth", "maxInboxes", "maxCampaigns", "maxContactsPerCampaign", "whiteLabelEnabled", "prioritySupport", "warmupPoolTier", "maxWarmupEmailsPerDay", "maxWarmupInboxes", "privatePoolEnabled", "dedicatedEgressEnabled", "maxActiveEgressIps", "egressInfrastructureBudgetCents", "byokEnabled", "fullMailboxSyncEnabled" ], "patternProperties": { "^(?!(?:maxEmailsPerMonth|maxInboxes|maxCampaigns|maxContactsPerCampaign|whiteLabelEnabled|prioritySupport|warmupPoolTier|maxWarmupEmailsPerDay|maxWarmupInboxes|privatePoolEnabled|dedicatedEgressEnabled|maxActiveEgressIps|egressInfrastructureBudgetCents|byokEnabled|fullMailboxSyncEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "maxEmailsPerMonth", "maxInboxes", "maxCampaigns", "maxContactsPerCampaign", "whiteLabelEnabled", "prioritySupport", "warmupPoolTier", "maxWarmupEmailsPerDay", "maxWarmupInboxes", "privatePoolEnabled", "dedicatedEgressEnabled", "maxActiveEgressIps", "egressInfrastructureBudgetCents", "byokEnabled", "fullMailboxSyncEnabled" ] } }, { "type": "null" } ] } }, "required": [ "id", "plan", "status", "billingCycle", "seats", "trialStart", "trialEnd", "periodStart", "periodEnd", "cancelAtPeriodEnd", "pastDueSince", "stripeCustomerId", "stripeSubscriptionId", "priceId", "frozen", "limits" ], "patternProperties": { "^(?!(?:id|plan|status|billingCycle|seats|trialStart|trialEnd|periodStart|periodEnd|cancelAtPeriodEnd|pastDueSince|stripeCustomerId|stripeSubscriptionId|priceId|frozen|limits)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "plan", "status", "billingCycle", "seats", "trialStart", "trialEnd", "periodStart", "periodEnd", "cancelAtPeriodEnd", "pastDueSince", "stripeCustomerId", "stripeSubscriptionId", "priceId", "frozen", "limits" ] } }, "maxItems": 20 } }, "required": [ "subscriptions" ], "patternProperties": { "^(?!(?:subscriptions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "subscriptions" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `billing.getSubscription`: `GET /v1/organizations/:organizationId/billing/subscription` - `billing.upgrade`: `POST /v1/organizations/:organizationId/billing/upgrade` - `billing.billingPortal`: `POST /v1/organizations/:organizationId/billing/portal` ## manage_verification_preferences Read or update the workspace's email-verification sharing posture: communal-cache mode, strict catch-all, freshness window, and provider display. Use to audit or change how verdicts flow into the communal cache and how aggressively catch-all verdicts escalate. Does not manage keys or run verification; payment mode is locked to BYOK. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: emailVerification:manage_sharing, emailVerification:read Risk: write; confirmation: explicit; 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" }, "action": { "type": "string", "enum": [ "get", "update" ] }, "patch": { "type": "object", "properties": { "sharingMode": { "type": "string", "enum": [ "contribute_and_consume", "consume_only", "private" ] }, "paymentMode": { "anyOf": [ { "type": "string", "enum": [ "byok" ] } ] }, "strictCatchAll": { "type": "boolean" }, "freshnessWindowSeconds": { "type": "integer", "minimum": 0, "maximum": 7776000 }, "providerDisplayMode": { "type": "string", "enum": [ "named", "generic" ] } }, "patternProperties": { "^(?!(?:sharingMode|paymentMode|strictCatchAll|freshnessWindowSeconds|providerDisplayMode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sharingMode", "paymentMode", "strictCatchAll", "freshnessWindowSeconds", "providerDisplayMode" ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|patch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "patch" ] } } ``` ### 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" }, "action": { "type": "string", "enum": [ "get", "update" ] }, "patch": { "type": "object", "properties": { "sharingMode": { "type": "string", "enum": [ "contribute_and_consume", "consume_only", "private" ] }, "paymentMode": { "anyOf": [ { "type": "string", "enum": [ "byok" ] } ] }, "strictCatchAll": { "type": "boolean" }, "freshnessWindowSeconds": { "type": "integer", "minimum": 0, "maximum": 7776000 }, "providerDisplayMode": { "type": "string", "enum": [ "named", "generic" ] } }, "patternProperties": { "^(?!(?:sharingMode|paymentMode|strictCatchAll|freshnessWindowSeconds|providerDisplayMode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sharingMode", "paymentMode", "strictCatchAll", "freshnessWindowSeconds", "providerDisplayMode" ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|patch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "patch" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "sharingMode": { "type": "string", "enum": [ "contribute_and_consume", "consume_only", "private" ] }, "paymentMode": { "anyOf": [ { "type": "string", "enum": [ "byok" ] } ] }, "strictCatchAll": { "type": "boolean" }, "freshnessWindowSeconds": { "type": "integer", "minimum": 0, "maximum": 7776000 }, "providerDisplayMode": { "type": "string", "enum": [ "named", "generic" ] } }, "required": [ "sharingMode", "paymentMode", "strictCatchAll", "freshnessWindowSeconds", "providerDisplayMode" ], "patternProperties": { "^(?!(?:sharingMode|paymentMode|strictCatchAll|freshnessWindowSeconds|providerDisplayMode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sharingMode", "paymentMode", "strictCatchAll", "freshnessWindowSeconds", "providerDisplayMode" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "sharingMode": { "type": "string", "enum": [ "contribute_and_consume", "consume_only", "private" ] }, "paymentMode": { "anyOf": [ { "type": "string", "enum": [ "byok" ] } ] }, "strictCatchAll": { "type": "boolean" }, "freshnessWindowSeconds": { "type": "integer", "minimum": 0, "maximum": 7776000 }, "providerDisplayMode": { "type": "string", "enum": [ "named", "generic" ] } }, "required": [ "sharingMode", "paymentMode", "strictCatchAll", "freshnessWindowSeconds", "providerDisplayMode" ], "patternProperties": { "^(?!(?:sharingMode|paymentMode|strictCatchAll|freshnessWindowSeconds|providerDisplayMode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sharingMode", "paymentMode", "strictCatchAll", "freshnessWindowSeconds", "providerDisplayMode" ] } }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `emailVerification.sharingPreferences`: `GET /v1/workspaces/:workspaceId/verification/sharing` - `emailVerification.updateSharing`: `PATCH /v1/workspaces/:workspaceId/verification/sharing` ## manage_voicemail_greetings Keep the library of pre-recorded greetings a rep can drop into a prospect's voicemail: list them, register a newly uploaded one, and delete one nobody uses. Use to report which greetings exist and whether each is ready to drop, to finish an upload the person has already made, or to retire a greeting that is out of date. This does not record audio and does not drop a voicemail — dropping one is part of a live call and belongs to a human at a softphone. Only MP3 and WAV reach a carrier directly; anything else is transcoded first and cannot be dropped until its status says so. Deleting a greeting also deletes its audio. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: dialer:read, dialer:manage_voicemails Risk: destructive; confirmation: explicit; 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" }, "action": { "type": "string", "enum": [ "list", "create_upload_intent", "finalize", "delete" ] }, "voicemailId": { "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" }, "uploadIntent": { "type": "object", "properties": { "fileName": { "type": "string", "minLength": 1, "maxLength": 255 }, "contentType": { "type": "string", "enum": [ "audio/mpeg", "audio/mp3", "audio/wav", "audio/x-wav", "audio/mp4", "audio/m4a", "audio/x-m4a", "audio/ogg", "audio/webm" ] }, "sizeBytes": { "type": "integer", "minimum": 1, "maximum": 10485760 } }, "required": [ "fileName", "contentType", "sizeBytes" ], "patternProperties": { "^(?!(?:fileName|contentType|sizeBytes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fileName", "contentType", "sizeBytes" ] } }, "finalize": { "type": "object", "properties": { "uploadId": { "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" }, "fileName": { "type": "string", "minLength": 1, "maxLength": 255 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "contentType": { "type": "string", "enum": [ "audio/mpeg", "audio/mp3", "audio/wav", "audio/x-wav", "audio/mp4", "audio/m4a", "audio/x-m4a", "audio/ogg", "audio/webm" ] }, "sizeBytes": { "type": "integer", "minimum": 1, "maximum": 10485760 }, "durationSeconds": { "type": "integer", "minimum": 0, "maximum": 120 } }, "required": [ "uploadId", "fileName", "name", "contentType", "sizeBytes" ], "patternProperties": { "^(?!(?:uploadId|fileName|name|contentType|sizeBytes|durationSeconds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "uploadId", "fileName", "name", "contentType", "sizeBytes", "durationSeconds" ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|voicemailId|uploadIntent|finalize)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "voicemailId", "uploadIntent", "finalize" ] } } ``` ### 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" }, "action": { "type": "string", "enum": [ "list", "create_upload_intent", "finalize", "delete" ] }, "voicemailId": { "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" }, "uploadIntent": { "type": "object", "properties": { "fileName": { "type": "string", "minLength": 1, "maxLength": 255 }, "contentType": { "type": "string", "enum": [ "audio/mpeg", "audio/mp3", "audio/wav", "audio/x-wav", "audio/mp4", "audio/m4a", "audio/x-m4a", "audio/ogg", "audio/webm" ] }, "sizeBytes": { "type": "integer", "minimum": 1, "maximum": 10485760 } }, "required": [ "fileName", "contentType", "sizeBytes" ], "patternProperties": { "^(?!(?:fileName|contentType|sizeBytes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fileName", "contentType", "sizeBytes" ] } }, "finalize": { "type": "object", "properties": { "uploadId": { "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" }, "fileName": { "type": "string", "minLength": 1, "maxLength": 255 }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "contentType": { "type": "string", "enum": [ "audio/mpeg", "audio/mp3", "audio/wav", "audio/x-wav", "audio/mp4", "audio/m4a", "audio/x-m4a", "audio/ogg", "audio/webm" ] }, "sizeBytes": { "type": "integer", "minimum": 1, "maximum": 10485760 }, "durationSeconds": { "type": "integer", "minimum": 0, "maximum": 120 } }, "required": [ "uploadId", "fileName", "name", "contentType", "sizeBytes" ], "patternProperties": { "^(?!(?:uploadId|fileName|name|contentType|sizeBytes|durationSeconds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "uploadId", "fileName", "name", "contentType", "sizeBytes", "durationSeconds" ] } } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|voicemailId|uploadIntent|finalize)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "voicemailId", "uploadIntent", "finalize" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "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$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "durationSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "transcodingStatus": { "type": "string", "enum": [ "not_required", "pending", "processing", "completed", "failed" ] }, "transcodingError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "playbackUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "playbackUrlExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "playbackUnavailableReason": { "anyOf": [ { "type": "string", "enum": [ "missing_object", "storage_error", "not_prepared" ] }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "durationSeconds", "transcodingStatus", "transcodingError", "playbackUrl", "playbackUrlExpiresAt", "playbackUnavailableReason", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|durationSeconds|transcodingStatus|transcodingError|playbackUrl|playbackUrlExpiresAt|playbackUnavailableReason|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "durationSeconds", "transcodingStatus", "transcodingError", "playbackUrl", "playbackUrlExpiresAt", "playbackUnavailableReason", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "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" }, "name": { "$ref": "#/$defs/ShortText" }, "durationSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "transcodingStatus": { "type": "string", "enum": [ "not_required", "pending", "processing", "completed", "failed" ] }, "transcodingError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "playbackUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "playbackUrlExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "playbackUnavailableReason": { "anyOf": [ { "type": "string", "enum": [ "missing_object", "storage_error", "not_prepared" ] }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "durationSeconds", "transcodingStatus", "transcodingError", "playbackUrl", "playbackUrlExpiresAt", "playbackUnavailableReason", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|durationSeconds|transcodingStatus|transcodingError|playbackUrl|playbackUrlExpiresAt|playbackUnavailableReason|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "durationSeconds", "transcodingStatus", "transcodingError", "playbackUrl", "playbackUrlExpiresAt", "playbackUnavailableReason", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "uploadId": { "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" }, "uploadUrl": { "$ref": "#/$defs/HttpUrl" }, "method": { "anyOf": [ { "type": "string", "enum": [ "PUT" ] } ] }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "uploadId", "uploadUrl", "method", "expiresAt" ], "patternProperties": { "^(?!(?:uploadId|uploadUrl|method|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "uploadId", "uploadUrl", "method", "expiresAt" ] } }, { "type": "object", "properties": { "voicemailId": { "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" }, "deletedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "voicemailId", "deletedAt" ], "patternProperties": { "^(?!(?:voicemailId|deletedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voicemailId", "deletedAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "durationSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "transcodingStatus": { "type": "string", "enum": [ "not_required", "pending", "processing", "completed", "failed" ] }, "transcodingError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "playbackUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "playbackUrlExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "playbackUnavailableReason": { "anyOf": [ { "type": "string", "enum": [ "missing_object", "storage_error", "not_prepared" ] }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "durationSeconds", "transcodingStatus", "transcodingError", "playbackUrl", "playbackUrlExpiresAt", "playbackUnavailableReason", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|durationSeconds|transcodingStatus|transcodingError|playbackUrl|playbackUrlExpiresAt|playbackUnavailableReason|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "durationSeconds", "transcodingStatus", "transcodingError", "playbackUrl", "playbackUrlExpiresAt", "playbackUnavailableReason", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "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" }, "name": { "$ref": "#/$defs/ShortText" }, "durationSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "transcodingStatus": { "type": "string", "enum": [ "not_required", "pending", "processing", "completed", "failed" ] }, "transcodingError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "playbackUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "playbackUrlExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "playbackUnavailableReason": { "anyOf": [ { "type": "string", "enum": [ "missing_object", "storage_error", "not_prepared" ] }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "durationSeconds", "transcodingStatus", "transcodingError", "playbackUrl", "playbackUrlExpiresAt", "playbackUnavailableReason", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|durationSeconds|transcodingStatus|transcodingError|playbackUrl|playbackUrlExpiresAt|playbackUnavailableReason|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "durationSeconds", "transcodingStatus", "transcodingError", "playbackUrl", "playbackUrlExpiresAt", "playbackUnavailableReason", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "uploadId": { "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" }, "uploadUrl": { "$ref": "#/$defs/HttpUrl" }, "method": { "anyOf": [ { "type": "string", "enum": [ "PUT" ] } ] }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "uploadId", "uploadUrl", "method", "expiresAt" ], "patternProperties": { "^(?!(?:uploadId|uploadUrl|method|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "uploadId", "uploadUrl", "method", "expiresAt" ] } }, { "type": "object", "properties": { "voicemailId": { "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" }, "deletedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "voicemailId", "deletedAt" ], "patternProperties": { "^(?!(?:voicemailId|deletedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "voicemailId", "deletedAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `dialerVoicemails.list`: `GET /v1/workspaces/:workspaceId/dialer/voicemails` - `dialerVoicemails.createUploadIntent`: `POST /v1/workspaces/:workspaceId/dialer/voicemails/upload-url` - `dialerVoicemails.finalize`: `POST /v1/workspaces/:workspaceId/dialer/voicemails` - `dialerVoicemails.delete`: `DELETE /v1/workspaces/:workspaceId/dialer/voicemails/:voicemailId` ## manage_warmup Toggles warmup enrollment and patches warmup limits, ramp, schedule, and policy overrides, in single-inbox and bulk form. When asked to enable/disable warmup or change warmup configuration. For non-warmup settings — use manage_inbox_settings. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: inbox:warmup_manage Risk: write; confirmation: explicit; 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": [ "get" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "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": [ "update" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "patch": { "type": "object", "properties": { "warmupEnabled": { "type": "boolean" }, "warmupFilterTag": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupIncludeFilterTag": { "type": "boolean" }, "dailyWarmupLimit": { "type": "integer", "minimum": 1, "maximum": 50 }, "warmupRampUp": { "type": "boolean" }, "warmupInitialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 50 }, "warmupDailyIncrement": { "type": "integer", "minimum": 1, "maximum": 20 }, "warmupRandomizedLimitEnabled": { "type": "boolean" }, "warmupRandomizedLimitPercent": { "type": "integer", "minimum": 0, "maximum": 100 }, "warmupBusinessType": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupScheduleEnabled": { "type": "boolean" }, "warmupTimezone": { "$ref": "#/$defs/ShortText" }, "warmupWeekdaysOnly": { "type": "boolean" }, "warmupStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupReplyRate": { "type": "integer", "minimum": 0, "maximum": 100 }, "advancedPolicy": { "type": "object", "properties": { "engagement": { "type": "object", "properties": { "replyRate": { "type": "integer", "minimum": 0, "maximum": 100 } }, "patternProperties": { "^(?!(?:replyRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "replyRate" ] } ] } } }, "patternProperties": { "^(?!(?:engagement)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "engagement" ] } ] } } }, "patternProperties": { "^(?!(?:warmupEnabled|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|advancedPolicy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "warmupEnabled", "warmupFilterTag", "warmupIncludeFilterTag", "dailyWarmupLimit", "warmupRampUp", "warmupInitialDailyLimit", "warmupDailyIncrement", "warmupRandomizedLimitEnabled", "warmupRandomizedLimitPercent", "warmupBusinessType", "warmupScheduleEnabled", "warmupTimezone", "warmupWeekdaysOnly", "warmupStartTime", "warmupEndTime", "warmupReplyRate", "advancedPolicy" ] }, "minProperties": 1, "maxProperties": 17 } }, "required": [ "workspaceId", "action", "inboxId", "patch" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|patch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "patch" ] } }, { "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": [ "toggle" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "payload": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "patternProperties": { "^(?!(?:enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "enabled" ] } ] } } }, "required": [ "workspaceId", "action", "inboxId", "payload" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "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": [ "send_test" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "payload": { "type": "object", "properties": { "to": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "to" ], "patternProperties": { "^(?!(?:to)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "to" ] } ] } } }, "required": [ "workspaceId", "action", "inboxId", "payload" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "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": [ "bulk_enable" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "enabled": { "type": "boolean" } }, "required": [ "inboxIds", "enabled" ], "patternProperties": { "^(?!(?:inboxIds|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "enabled" ] } } }, "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": [ "bulk_policy" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "policy": { "type": "object", "properties": { "engagement": { "type": "object", "properties": { "replyRate": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "replyRate" ], "patternProperties": { "^(?!(?:replyRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "replyRate" ] } ] } } }, "required": [ "engagement" ], "patternProperties": { "^(?!(?:engagement)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "engagement" ] } ] } } }, "required": [ "inboxIds", "policy" ], "patternProperties": { "^(?!(?:inboxIds|policy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "policy" ] } } }, "required": [ "workspaceId", "action", "payload" ], "patternProperties": { "^(?!(?:workspaceId|action|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "payload" ] } } ], "$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", "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": [ "get" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "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": [ "update" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "patch": { "type": "object", "properties": { "warmupEnabled": { "type": "boolean" }, "warmupFilterTag": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupIncludeFilterTag": { "type": "boolean" }, "dailyWarmupLimit": { "type": "integer", "minimum": 1, "maximum": 50 }, "warmupRampUp": { "type": "boolean" }, "warmupInitialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 50 }, "warmupDailyIncrement": { "type": "integer", "minimum": 1, "maximum": 20 }, "warmupRandomizedLimitEnabled": { "type": "boolean" }, "warmupRandomizedLimitPercent": { "type": "integer", "minimum": 0, "maximum": 100 }, "warmupBusinessType": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupScheduleEnabled": { "type": "boolean" }, "warmupTimezone": { "$ref": "#/$defs/ShortText" }, "warmupWeekdaysOnly": { "type": "boolean" }, "warmupStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupReplyRate": { "type": "integer", "minimum": 0, "maximum": 100 }, "advancedPolicy": { "type": "object", "properties": { "engagement": { "type": "object", "properties": { "replyRate": { "type": "integer", "minimum": 0, "maximum": 100 } }, "patternProperties": { "^(?!(?:replyRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "replyRate" ] } ] } } }, "patternProperties": { "^(?!(?:engagement)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "engagement" ] } ] } } }, "patternProperties": { "^(?!(?:warmupEnabled|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|advancedPolicy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "warmupEnabled", "warmupFilterTag", "warmupIncludeFilterTag", "dailyWarmupLimit", "warmupRampUp", "warmupInitialDailyLimit", "warmupDailyIncrement", "warmupRandomizedLimitEnabled", "warmupRandomizedLimitPercent", "warmupBusinessType", "warmupScheduleEnabled", "warmupTimezone", "warmupWeekdaysOnly", "warmupStartTime", "warmupEndTime", "warmupReplyRate", "advancedPolicy" ] }, "minProperties": 1, "maxProperties": 17 } }, "required": [ "workspaceId", "action", "inboxId", "patch" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|patch)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "patch" ] }, { "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": [ "toggle" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "payload": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "patternProperties": { "^(?!(?:enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "enabled" ] } ] } } }, "required": [ "workspaceId", "action", "inboxId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "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": [ "send_test" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "payload": { "type": "object", "properties": { "to": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "to" ], "patternProperties": { "^(?!(?:to)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "to" ] } ] } } }, "required": [ "workspaceId", "action", "inboxId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "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": [ "bulk_enable" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "enabled": { "type": "boolean" } }, "required": [ "inboxIds", "enabled" ], "patternProperties": { "^(?!(?:inboxIds|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "enabled" ] } } }, "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": [ "bulk_policy" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "policy": { "type": "object", "properties": { "engagement": { "type": "object", "properties": { "replyRate": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "replyRate" ], "patternProperties": { "^(?!(?:replyRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "replyRate" ] } ] } } }, "required": [ "engagement" ], "patternProperties": { "^(?!(?:engagement)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "engagement" ] } ] } } }, "required": [ "inboxIds", "policy" ], "patternProperties": { "^(?!(?:inboxIds|policy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "policy" ] } } }, "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" ] } ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "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" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "warmupEnabled": { "type": "boolean" }, "isPlacementTestRecipient": { "type": "boolean" }, "warmupFilterTag": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupIncludeFilterTag": { "type": "boolean" }, "dailyWarmupLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRampUp": { "type": "boolean" }, "warmupInitialDailyLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupDailyIncrement": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRandomizedLimitEnabled": { "type": "boolean" }, "warmupRandomizedLimitPercent": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "warmupBusinessType": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupScheduleEnabled": { "type": "boolean" }, "warmupTimezone": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupWeekdaysOnly": { "type": "boolean" }, "warmupStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupReplyRate": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "warmupStartedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "pool": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "configId": { "$ref": "#/$defs/OpaqueId" }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "underfillStrategy": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "configId", "name", "underfillStrategy" ], "patternProperties": { "^(?!(?:id|configId|name|underfillStrategy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "configId", "name", "underfillStrategy" ] } }, { "type": "null" } ] }, "policyOverride": { "anyOf": [ { "type": "object", "properties": { "engagement": { "type": "object", "properties": { "replyRate": { "type": "integer", "minimum": 0, "maximum": 100 } }, "patternProperties": { "^(?!(?:replyRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "replyRate" ] } ] } } }, "patternProperties": { "^(?!(?:engagement)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "engagement" ] } ] } }, { "type": "null" } ] }, "effectivePolicy": { "$ref": "#/$defs/Union_" } }, "required": [ "id", "emailAddress", "provider", "warmupEnabled", "isPlacementTestRecipient", "warmupFilterTag", "warmupIncludeFilterTag", "dailyWarmupLimit", "warmupRampUp", "warmupInitialDailyLimit", "warmupDailyIncrement", "warmupRandomizedLimitEnabled", "warmupRandomizedLimitPercent", "warmupBusinessType", "warmupScheduleEnabled", "warmupTimezone", "warmupWeekdaysOnly", "warmupStartTime", "warmupEndTime", "warmupReplyRate", "warmupStartedAt", "pool", "policyOverride", "effectivePolicy" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|warmupEnabled|isPlacementTestRecipient|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|warmupStartedAt|pool|policyOverride|effectivePolicy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "warmupEnabled", "isPlacementTestRecipient", "warmupFilterTag", "warmupIncludeFilterTag", "dailyWarmupLimit", "warmupRampUp", "warmupInitialDailyLimit", "warmupDailyIncrement", "warmupRandomizedLimitEnabled", "warmupRandomizedLimitPercent", "warmupBusinessType", "warmupScheduleEnabled", "warmupTimezone", "warmupWeekdaysOnly", "warmupStartTime", "warmupEndTime", "warmupReplyRate", "warmupStartedAt", "pool", "policyOverride", "effectivePolicy" ] } }, { "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" }, "warmupEnabled": { "type": "boolean" } }, "required": [ "id", "warmupEnabled" ], "patternProperties": { "^(?!(?:id|warmupEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "warmupEnabled" ] } }, { "type": "object", "properties": { "outcomes": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "status": { "type": "string", "enum": [ "updated", "skipped", "failed" ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "inboxId", "status", "reason" ], "patternProperties": { "^(?!(?:inboxId|status|reason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "status", "reason" ] } } } }, "required": [ "outcomes" ], "patternProperties": { "^(?!(?:outcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "outcomes" ] } ] } }, { "type": "object", "properties": { "runId": { "$ref": "#/$defs/OpaqueId" }, "requestId": { "$ref": "#/$defs/OpaqueId" }, "operation": { "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" ] } } }, "required": [ "runId", "requestId", "operation" ], "patternProperties": { "^(?!(?:runId|requestId|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "requestId", "operation" ] } } ] }, { "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" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "warmupEnabled": { "type": "boolean" }, "isPlacementTestRecipient": { "type": "boolean" }, "warmupFilterTag": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupIncludeFilterTag": { "type": "boolean" }, "dailyWarmupLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRampUp": { "type": "boolean" }, "warmupInitialDailyLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupDailyIncrement": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRandomizedLimitEnabled": { "type": "boolean" }, "warmupRandomizedLimitPercent": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "warmupBusinessType": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupScheduleEnabled": { "type": "boolean" }, "warmupTimezone": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "warmupWeekdaysOnly": { "type": "boolean" }, "warmupStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86399 }, { "type": "null" } ] }, "warmupReplyRate": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "warmupStartedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "pool": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "configId": { "$ref": "#/$defs/OpaqueId" }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "underfillStrategy": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "configId", "name", "underfillStrategy" ], "patternProperties": { "^(?!(?:id|configId|name|underfillStrategy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "configId", "name", "underfillStrategy" ] } }, { "type": "null" } ] }, "policyOverride": { "anyOf": [ { "type": "object", "properties": { "engagement": { "type": "object", "properties": { "replyRate": { "type": "integer", "minimum": 0, "maximum": 100 } }, "patternProperties": { "^(?!(?:replyRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "replyRate" ] } ] } } }, "patternProperties": { "^(?!(?:engagement)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "engagement" ] } ] } }, { "type": "null" } ] }, "effectivePolicy": { "$ref": "#/$defs/Union_" } }, "required": [ "id", "emailAddress", "provider", "warmupEnabled", "isPlacementTestRecipient", "warmupFilterTag", "warmupIncludeFilterTag", "dailyWarmupLimit", "warmupRampUp", "warmupInitialDailyLimit", "warmupDailyIncrement", "warmupRandomizedLimitEnabled", "warmupRandomizedLimitPercent", "warmupBusinessType", "warmupScheduleEnabled", "warmupTimezone", "warmupWeekdaysOnly", "warmupStartTime", "warmupEndTime", "warmupReplyRate", "warmupStartedAt", "pool", "policyOverride", "effectivePolicy" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|warmupEnabled|isPlacementTestRecipient|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|warmupStartedAt|pool|policyOverride|effectivePolicy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "warmupEnabled", "isPlacementTestRecipient", "warmupFilterTag", "warmupIncludeFilterTag", "dailyWarmupLimit", "warmupRampUp", "warmupInitialDailyLimit", "warmupDailyIncrement", "warmupRandomizedLimitEnabled", "warmupRandomizedLimitPercent", "warmupBusinessType", "warmupScheduleEnabled", "warmupTimezone", "warmupWeekdaysOnly", "warmupStartTime", "warmupEndTime", "warmupReplyRate", "warmupStartedAt", "pool", "policyOverride", "effectivePolicy" ] } }, { "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" }, "warmupEnabled": { "type": "boolean" } }, "required": [ "id", "warmupEnabled" ], "patternProperties": { "^(?!(?:id|warmupEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "warmupEnabled" ] } }, { "type": "object", "properties": { "outcomes": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "status": { "type": "string", "enum": [ "updated", "skipped", "failed" ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "inboxId", "status", "reason" ], "patternProperties": { "^(?!(?:inboxId|status|reason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "status", "reason" ] } } } }, "required": [ "outcomes" ], "patternProperties": { "^(?!(?:outcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "outcomes" ] } ] } }, { "type": "object", "properties": { "runId": { "$ref": "#/$defs/OpaqueId" }, "requestId": { "$ref": "#/$defs/OpaqueId" }, "operation": { "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" ] } } }, "required": [ "runId", "requestId", "operation" ], "patternProperties": { "^(?!(?:runId|requestId|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "requestId", "operation" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `inboxSettings.toggleWarmup`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/warmup` - `inboxWarmupSettings.get`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/warmup-settings` - `inboxWarmupSettings.update`: `PATCH /v1/workspaces/:workspaceId/inboxes/:inboxId/warmup-settings` - `inboxWarmupSettings.sendTest`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/warmup-settings/test` - `inboxBulk.setWarmupEnabled`: `PATCH /v1/workspaces/:workspaceId/inboxes/bulk/warmup` - `inboxBulk.updateWarmupPolicy`: `PATCH /v1/workspaces/:workspaceId/inboxes/bulk/warmup-policy` ## manage_webhooks Manage Workspace webhooks, exact custom headers, campaign/tag/folder/name inclusion and exclusions, label scope, sample tests, server-filtered delivery history and explicit retries. campaignScope modes: all, campaigns, tags (match any/all selected tags), folders (any selected subtree), names (terms, match any/all), rules (nested AND/OR/NOT). In rules mode, match all/any joins conditions; each rule has field campaigns/folders/tags with ids, names with terms, tagged/filed with boolean value, or group with rules. Tags/names accept match any/all; groups default to all. Every rule accepts exclude for NOT. A campaign has many tags but one folder. All modes support excludeCampaignIds, excludeTagIds, excludeFolderIds, excludeNameContains, taggedOnly and filedOnly. Global exclusions win. Deleted references fail closed even inside NOT/OR; folder membership follows live moves. Use to manage event subscriptions and to fire a test delivery after the target URL is configured. Deletion is a separate confirmed capability; the signing secret is write-only and never returned after creation. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: webhook:read, webhook:create, webhook:update Risk: write; confirmation: explicit; 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" }, "action": { "type": "string", "enum": [ "list", "create", "update", "test", "deliveries", "delivery", "retry" ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "webhookId": { "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" }, "deliveryId": { "type": "string" }, "query": { "anyOf": [ { "type": "object", "properties": { "order": { "type": "string", "enum": [ "newest", "oldest" ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "enabled": { "type": "string", "enum": [ "true", "false" ] }, "eventType": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "search": { "$ref": "#/$defs/ShortText" } }, "patternProperties": { "^(?!(?:order|cursor|limit|enabled|eventType|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "order", "cursor", "limit", "enabled", "eventType", "search" ] } }, { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "webhookId": { "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" }, "search": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "eventType": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "mode": { "type": "string", "enum": [ "live", "test" ] }, "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "order": { "type": "string", "enum": [ "newest", "oldest" ] } }, "patternProperties": { "^(?!(?:cursor|limit|webhookId|search|status|eventType|mode|from|to|order)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit", "webhookId", "search", "status", "eventType", "mode", "from", "to", "order" ] } } ] }, "input": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048 }, "campaignId": { "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" } ] }, "campaignScope": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "headers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[!#$%&'*+.^_`|~0-9A-Za-z-]+$" }, "value": { "anyOf": [ { "type": "string", "maxLength": 4096, "pattern": "^[\\x20-\\x7e]*$" }, { "type": "null" } ] } }, "required": [ "name" ], "additionalProperties": true }, "maxItems": 20 }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" }, "signing": { "type": "string", "enum": [ "unsigned", "generate" ] } }, "required": [ "name", "url", "eventTypes" ], "patternProperties": { "^(?!(?:name|url|campaignId|campaignScope|labelIds|headers|eventTypes|isSlackWebhook|signing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "url", "campaignId", "campaignScope", "labelIds", "headers", "eventTypes", "isSlackWebhook", "signing" ] } }, { "type": "object", "properties": { "expectedRevision": { "type": "integer" }, "campaignScope": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "headers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[!#$%&'*+.^_`|~0-9A-Za-z-]+$" }, "value": { "anyOf": [ { "type": "string", "maxLength": 4096, "pattern": "^[\\x20-\\x7e]*$" }, { "type": "null" } ] } }, "required": [ "name" ], "additionalProperties": true }, "maxItems": 20 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048 }, "campaignId": { "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" } ] }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" }, "enabled": { "type": "boolean" }, "signing": { "anyOf": [ { "type": "string", "enum": [ "clear" ] } ] } }, "patternProperties": { "^(?!(?:expectedRevision|campaignScope|labelIds|headers|name|url|campaignId|eventTypes|isSlackWebhook|enabled|signing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "campaignScope", "labelIds", "headers", "name", "url", "campaignId", "eventTypes", "isSlackWebhook", "enabled", "signing" ] }, "minProperties": 1, "maxProperties": 11 }, { "anyOf": [ { "type": "object", "properties": { "webhookId": { "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" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0 }, "eventType": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] } }, "required": [ "webhookId" ], "patternProperties": { "^(?!(?:webhookId|expectedRevision|eventType)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "webhookId", "expectedRevision", "eventType" ] } }, { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "secret": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "campaignId": { "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" } ] }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" } }, "required": [ "url", "eventTypes" ], "patternProperties": { "^(?!(?:url|secret|campaignId|eventTypes|isSlackWebhook)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "url", "secret", "campaignId", "eventTypes", "isSlackWebhook" ] } } ] }, { "type": "object", "properties": { "expectedRevision": { "type": "integer" }, "acknowledgeDuplicateRisk": { "type": "boolean" } }, "required": [ "expectedRevision", "acknowledgeDuplicateRisk" ], "patternProperties": { "^(?!(?:expectedRevision|acknowledgeDuplicateRisk)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "acknowledgeDuplicateRisk" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|cursor|limit|webhookId|deliveryId|query|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "cursor", "limit", "webhookId", "deliveryId", "query", "input" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "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 } } } ``` ### 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" }, "action": { "type": "string", "enum": [ "list", "create", "update", "test", "deliveries", "delivery", "retry" ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "webhookId": { "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" }, "deliveryId": { "type": "string" }, "query": { "anyOf": [ { "type": "object", "properties": { "order": { "type": "string", "enum": [ "newest", "oldest" ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "enabled": { "type": "string", "enum": [ "true", "false" ] }, "eventType": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "search": { "$ref": "#/$defs/ShortText" } }, "patternProperties": { "^(?!(?:order|cursor|limit|enabled|eventType|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "order", "cursor", "limit", "enabled", "eventType", "search" ] } }, { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "webhookId": { "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" }, "search": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "eventType": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "mode": { "type": "string", "enum": [ "live", "test" ] }, "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "order": { "type": "string", "enum": [ "newest", "oldest" ] } }, "patternProperties": { "^(?!(?:cursor|limit|webhookId|search|status|eventType|mode|from|to|order)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit", "webhookId", "search", "status", "eventType", "mode", "from", "to", "order" ] } } ] }, "input": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048 }, "campaignId": { "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" } ] }, "campaignScope": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "headers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[!#$%&'*+.^_`|~0-9A-Za-z-]+$" }, "value": { "anyOf": [ { "type": "string", "maxLength": 4096, "pattern": "^[\\x20-\\x7e]*$" }, { "type": "null" } ] } }, "required": [ "name" ], "additionalProperties": true }, "maxItems": 20 }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" }, "signing": { "type": "string", "enum": [ "unsigned", "generate" ] } }, "required": [ "name", "url", "eventTypes" ], "patternProperties": { "^(?!(?:name|url|campaignId|campaignScope|labelIds|headers|eventTypes|isSlackWebhook|signing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "url", "campaignId", "campaignScope", "labelIds", "headers", "eventTypes", "isSlackWebhook", "signing" ] } }, { "type": "object", "properties": { "expectedRevision": { "type": "integer" }, "campaignScope": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "headers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[!#$%&'*+.^_`|~0-9A-Za-z-]+$" }, "value": { "anyOf": [ { "type": "string", "maxLength": 4096, "pattern": "^[\\x20-\\x7e]*$" }, { "type": "null" } ] } }, "required": [ "name" ], "additionalProperties": true }, "maxItems": 20 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "type": "string", "maxLength": 2048 }, "campaignId": { "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" } ] }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" }, "enabled": { "type": "boolean" }, "signing": { "anyOf": [ { "type": "string", "enum": [ "clear" ] } ] } }, "patternProperties": { "^(?!(?:expectedRevision|campaignScope|labelIds|headers|name|url|campaignId|eventTypes|isSlackWebhook|enabled|signing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "campaignScope", "labelIds", "headers", "name", "url", "campaignId", "eventTypes", "isSlackWebhook", "enabled", "signing" ] }, "minProperties": 1, "maxProperties": 11 }, { "anyOf": [ { "type": "object", "properties": { "webhookId": { "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" }, "expectedRevision": { "type": "integer", "exclusiveMinimum": 0 }, "eventType": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] } }, "required": [ "webhookId" ], "patternProperties": { "^(?!(?:webhookId|expectedRevision|eventType)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "webhookId", "expectedRevision", "eventType" ] } }, { "type": "object", "properties": { "url": { "type": "string", "maxLength": 2048 }, "secret": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "campaignId": { "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" } ] }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" } }, "required": [ "url", "eventTypes" ], "patternProperties": { "^(?!(?:url|secret|campaignId|eventTypes|isSlackWebhook)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "url", "secret", "campaignId", "eventTypes", "isSlackWebhook" ] } } ] }, { "type": "object", "properties": { "expectedRevision": { "type": "integer" }, "acknowledgeDuplicateRisk": { "type": "boolean" } }, "required": [ "expectedRevision", "acknowledgeDuplicateRisk" ], "patternProperties": { "^(?!(?:expectedRevision|acknowledgeDuplicateRisk)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "acknowledgeDuplicateRisk" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|cursor|limit|webhookId|deliveryId|query|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "cursor", "limit", "webhookId", "deliveryId", "query", "input" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "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 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "$ref": "#/$defs/HttpUrl" }, "campaignId": { "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" } ] }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" }, "enabled": { "type": "boolean" }, "revision": { "type": "integer" }, "headerNames": { "type": "array", "items": { "type": "string" } }, "campaignScope": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "array", "items": { "type": "string" } }, "secretFingerprint": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "secretRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|campaignId|campaignName|eventTypes|isSlackWebhook|enabled|revision|headerNames|campaignScope|labelIds|secretFingerprint|secretRotatedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "$ref": "#/$defs/HttpUrl" }, "campaignId": { "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" } ] }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" }, "enabled": { "type": "boolean" }, "revision": { "type": "integer" }, "headerNames": { "type": "array", "items": { "type": "string" } }, "campaignScope": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "array", "items": { "type": "string" } }, "secretFingerprint": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "secretRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|campaignId|campaignName|eventTypes|isSlackWebhook|enabled|revision|headerNames|campaignScope|labelIds|secretFingerprint|secretRotatedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt" ] } }, { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "$ref": "#/$defs/HttpUrl" }, "campaignId": { "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" } ] }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" }, "enabled": { "type": "boolean" }, "revision": { "type": "integer" }, "headerNames": { "type": "array", "items": { "type": "string" } }, "campaignScope": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "array", "items": { "type": "string" } }, "secretFingerprint": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "secretRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "signingSecret": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|campaignId|campaignName|eventTypes|isSlackWebhook|enabled|revision|headerNames|campaignScope|labelIds|secretFingerprint|secretRotatedAt|createdAt|updatedAt|signingSecret)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt", "signingSecret" ] } }, { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "webhookId": { "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" }, "search": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "eventType": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "mode": { "type": "string", "enum": [ "live", "test" ] }, "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "order": { "type": "string", "enum": [ "newest", "oldest" ] } }, "patternProperties": { "^(?!(?:cursor|limit|webhookId|search|status|eventType|mode|from|to|order)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit", "webhookId", "search", "status", "eventType", "mode", "from", "to", "order" ] } }, { "type": "object", "properties": { "expectedRevision": { "type": "integer" }, "acknowledgeDuplicateRisk": { "type": "boolean" } }, "required": [ "expectedRevision", "acknowledgeDuplicateRisk" ], "patternProperties": { "^(?!(?:expectedRevision|acknowledgeDuplicateRisk)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "acknowledgeDuplicateRisk" ] } }, { "type": "object", "properties": { "success": { "type": "boolean" }, "statusCode": { "type": "integer" }, "statusText": { "$ref": "#/$defs/NonEmptyString" }, "responseTimeMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "error": { "$ref": "#/$defs/NonEmptyString" }, "eventType": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] } }, "required": [ "success", "responseTimeMs", "eventType" ], "patternProperties": { "^(?!(?:success|statusCode|statusText|responseTimeMs|error|eventType)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "statusCode", "statusText", "responseTimeMs", "error", "eventType" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "delivery": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "attempt": { "type": "integer" }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "finishedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "attempt", "startedAt", "finishedAt", "statusCode", "durationMs", "failureCategory" ], "patternProperties": { "^(?!(?:attempt|startedAt|finishedAt|statusCode|durationMs|failureCategory)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attempt", "startedAt", "finishedAt", "statusCode", "durationMs", "failureCategory" ] } } } }, "required": [ "delivery", "attempts" ], "patternProperties": { "^(?!(?:delivery|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivery", "attempts" ] } }, { "type": "object", "properties": { "delivery": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "attempt": { "type": "integer" }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "finishedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "attempt", "startedAt", "finishedAt", "statusCode", "durationMs", "failureCategory" ], "patternProperties": { "^(?!(?:attempt|startedAt|finishedAt|statusCode|durationMs|failureCategory)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attempt", "startedAt", "finishedAt", "statusCode", "durationMs", "failureCategory" ] } } } }, "required": [ "delivery", "attempts" ], "patternProperties": { "^(?!(?:delivery|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivery", "attempts" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "$ref": "#/$defs/HttpUrl" }, "campaignId": { "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" } ] }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" }, "enabled": { "type": "boolean" }, "revision": { "type": "integer" }, "headerNames": { "type": "array", "items": { "type": "string" } }, "campaignScope": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "array", "items": { "type": "string" } }, "secretFingerprint": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "secretRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|campaignId|campaignName|eventTypes|isSlackWebhook|enabled|revision|headerNames|campaignScope|labelIds|secretFingerprint|secretRotatedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "$ref": "#/$defs/HttpUrl" }, "campaignId": { "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" } ] }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" }, "enabled": { "type": "boolean" }, "revision": { "type": "integer" }, "headerNames": { "type": "array", "items": { "type": "string" } }, "campaignScope": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "array", "items": { "type": "string" } }, "secretFingerprint": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "secretRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|campaignId|campaignName|eventTypes|isSlackWebhook|enabled|revision|headerNames|campaignScope|labelIds|secretFingerprint|secretRotatedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt" ] } }, { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "url": { "$ref": "#/$defs/HttpUrl" }, "campaignId": { "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" } ] }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "eventTypes": { "type": "array", "items": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "minItems": 1, "maxItems": 64 }, "isSlackWebhook": { "type": "boolean" }, "enabled": { "type": "boolean" }, "revision": { "type": "integer" }, "headerNames": { "type": "array", "items": { "type": "string" } }, "campaignScope": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "labelIds": { "type": "array", "items": { "type": "string" } }, "secretFingerprint": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "secretRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "signingSecret": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|campaignId|campaignName|eventTypes|isSlackWebhook|enabled|revision|headerNames|campaignScope|labelIds|secretFingerprint|secretRotatedAt|createdAt|updatedAt|signingSecret)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "campaignId", "campaignName", "eventTypes", "isSlackWebhook", "enabled", "revision", "headerNames", "campaignScope", "labelIds", "secretFingerprint", "secretRotatedAt", "createdAt", "updatedAt", "signingSecret" ] } }, { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "webhookId": { "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" }, "search": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "eventType": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] }, "mode": { "type": "string", "enum": [ "live", "test" ] }, "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "order": { "type": "string", "enum": [ "newest", "oldest" ] } }, "patternProperties": { "^(?!(?:cursor|limit|webhookId|search|status|eventType|mode|from|to|order)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit", "webhookId", "search", "status", "eventType", "mode", "from", "to", "order" ] } }, { "type": "object", "properties": { "expectedRevision": { "type": "integer" }, "acknowledgeDuplicateRisk": { "type": "boolean" } }, "required": [ "expectedRevision", "acknowledgeDuplicateRisk" ], "patternProperties": { "^(?!(?:expectedRevision|acknowledgeDuplicateRisk)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "expectedRevision", "acknowledgeDuplicateRisk" ] } }, { "type": "object", "properties": { "success": { "type": "boolean" }, "statusCode": { "type": "integer" }, "statusText": { "$ref": "#/$defs/NonEmptyString" }, "responseTimeMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "error": { "$ref": "#/$defs/NonEmptyString" }, "eventType": { "type": "string", "enum": [ "first_email_reply", "all_email_replies", "all_positive_replies", "all_emails_sent", "all_bounced_emails", "all_delivery_updates", "campaign_auto_paused", "marked_interested", "marked_not_interested", "marked_out_of_office", "marked_automatic_reply", "marked_meeting_booked", "marked_meeting_completed", "marked_wrong_person", "marked_closed", "marked_same_company_lead", "label_applied", "label_removed", "reminder_created", "reminder_due", "reminder_cancelled", "unibox_email_sent" ] } }, "required": [ "success", "responseTimeMs", "eventType" ], "patternProperties": { "^(?!(?:success|statusCode|statusText|responseTimeMs|error|eventType)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "statusCode", "statusText", "responseTimeMs", "error", "eventType" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "delivery": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "attempt": { "type": "integer" }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "finishedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "attempt", "startedAt", "finishedAt", "statusCode", "durationMs", "failureCategory" ], "patternProperties": { "^(?!(?:attempt|startedAt|finishedAt|statusCode|durationMs|failureCategory)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attempt", "startedAt", "finishedAt", "statusCode", "durationMs", "failureCategory" ] } } } }, "required": [ "delivery", "attempts" ], "patternProperties": { "^(?!(?:delivery|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivery", "attempts" ] } }, { "type": "object", "properties": { "delivery": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "attempt": { "type": "integer" }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "finishedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "attempt", "startedAt", "finishedAt", "statusCode", "durationMs", "failureCategory" ], "patternProperties": { "^(?!(?:attempt|startedAt|finishedAt|statusCode|durationMs|failureCategory)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attempt", "startedAt", "finishedAt", "statusCode", "durationMs", "failureCategory" ] } } } }, "required": [ "delivery", "attempts" ], "patternProperties": { "^(?!(?:delivery|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivery", "attempts" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" }, "webhookName": { "type": "string" }, "eventId": { "type": "string" }, "eventType": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sending", "delivered", "failed", "uncertain", "cancelled" ] }, "isTest": { "type": "boolean" }, "revision": { "type": "integer" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "failureCategory": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nextAttemptAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|webhookId|webhookName|eventId|eventType|status|isTest|revision|attempts|statusCode|durationMs|failureCategory|nextAttemptAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "webhookName", "eventId", "eventType", "status", "isTest", "revision", "attempts", "statusCode", "durationMs", "failureCategory", "nextAttemptAt", "createdAt", "updatedAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `webhooks.list`: `GET /v1/workspaces/:workspaceId/webhooks` - `webhooks.create`: `POST /v1/workspaces/:workspaceId/webhooks` - `webhooks.update`: `PATCH /v1/workspaces/:workspaceId/webhooks/:webhookId` - `webhooks.test`: `POST /v1/workspaces/:workspaceId/webhooks/test-delivery` - `webhooks.deliveries`: `GET /v1/workspaces/:workspaceId/webhook-deliveries` - `webhooks.delivery`: `GET /v1/workspaces/:workspaceId/webhook-deliveries/:deliveryId` - `webhooks.retry`: `POST /v1/workspaces/:workspaceId/webhook-deliveries/:deliveryId/retry` ## manage_website_routes Manage workspace website routes independently of domain registrar DNS operations. Use to list or inspect configured website routes, add a hostname route, update or retire a route, or check its provider reconciliation state. New routes return an opaque ownership TXT challenge; remove only that TXT record when ownershipRecord.removable is true, and retain certificate-validation CNAME, website routing and mail records. Use manage_domain_dns for registrar DNS records. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: domain:manage_dns Risk: destructive; confirmation: explicit; 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" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "list" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "get" ] }, "routeId": { "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": [ "kind", "routeId" ], "patternProperties": { "^(?!(?:kind|routeId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "routeId" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "create" ] }, "request": { "type": "object", "properties": { "targetUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "mode": { "type": "string", "enum": [ "redirect", "proxy" ] }, "pathMode": { "type": "string", "enum": [ "preserve", "prefix" ] }, "hostname": { "$ref": "#/$defs/DomainName" } }, "required": [ "targetUrl", "mode", "pathMode", "hostname" ], "patternProperties": { "^(?!(?:targetUrl|mode|pathMode|hostname)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "targetUrl", "mode", "pathMode", "hostname" ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "save" ] }, "routeId": { "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": { "type": "object", "properties": { "targetUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "mode": { "type": "string", "enum": [ "redirect", "proxy" ] }, "pathMode": { "type": "string", "enum": [ "preserve", "prefix" ] }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "desiredState": { "type": "string", "enum": [ "enabled", "retired" ] } }, "required": [ "targetUrl", "mode", "pathMode", "expectedRevision", "desiredState" ], "patternProperties": { "^(?!(?:targetUrl|mode|pathMode|expectedRevision|desiredState)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "targetUrl", "mode", "pathMode", "expectedRevision", "desiredState" ] } } }, "required": [ "kind", "routeId", "request" ], "patternProperties": { "^(?!(?:kind|routeId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "routeId", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "check" ] }, "routeId": { "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": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "expectedRevision" ], "patternProperties": { "^(?!(?:expectedRevision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "expectedRevision" ] } ] } } }, "required": [ "kind", "routeId", "request" ], "patternProperties": { "^(?!(?:kind|routeId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "routeId", "request" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] }, "$defs": { "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" } } } ``` ### 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" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "list" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "get" ] }, "routeId": { "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": [ "kind", "routeId" ], "patternProperties": { "^(?!(?:kind|routeId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "routeId" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "create" ] }, "request": { "type": "object", "properties": { "targetUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "mode": { "type": "string", "enum": [ "redirect", "proxy" ] }, "pathMode": { "type": "string", "enum": [ "preserve", "prefix" ] }, "hostname": { "$ref": "#/$defs/DomainName" } }, "required": [ "targetUrl", "mode", "pathMode", "hostname" ], "patternProperties": { "^(?!(?:targetUrl|mode|pathMode|hostname)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "targetUrl", "mode", "pathMode", "hostname" ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "save" ] }, "routeId": { "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": { "type": "object", "properties": { "targetUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "mode": { "type": "string", "enum": [ "redirect", "proxy" ] }, "pathMode": { "type": "string", "enum": [ "preserve", "prefix" ] }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "desiredState": { "type": "string", "enum": [ "enabled", "retired" ] } }, "required": [ "targetUrl", "mode", "pathMode", "expectedRevision", "desiredState" ], "patternProperties": { "^(?!(?:targetUrl|mode|pathMode|expectedRevision|desiredState)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "targetUrl", "mode", "pathMode", "expectedRevision", "desiredState" ] } } }, "required": [ "kind", "routeId", "request" ], "patternProperties": { "^(?!(?:kind|routeId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "routeId", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "check" ] }, "routeId": { "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": { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "expectedRevision" ], "patternProperties": { "^(?!(?:expectedRevision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "expectedRevision" ] } ] } } }, "required": [ "kind", "routeId", "request" ], "patternProperties": { "^(?!(?:kind|routeId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "routeId", "request" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] }, "$defs": { "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "routes": { "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" }, "hostname": { "$ref": "#/$defs/DomainName" }, "provider": { "type": "string", "enum": [ "aws_cloudfront" ] }, "mode": { "type": "string", "enum": [ "redirect", "proxy" ] }, "target": { "type": "string" }, "pathMode": { "type": "string", "enum": [ "preserve", "prefix" ] }, "desiredRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "desiredState": { "type": "string", "enum": [ "enabled", "retired" ] }, "activeProvider": { "anyOf": [ { "type": "string", "enum": [ "aws_cloudfront" ] }, { "type": "null" } ] }, "activeRevision": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "activeMode": { "anyOf": [ { "type": "string", "enum": [ "redirect", "proxy" ] }, { "type": "null" } ] }, "activeTarget": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phase": { "type": "string", "enum": [ "not_configured", "waiting_dns", "waiting_tls", "waiting_publication", "active", "degraded", "retired", "needs_attention" ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "ownership_required", "certificate_pending", "certificate_failed", "route_pending", "dns_pending", "health_mismatch", "origin_unavailable", "origin_redirects", "provider_unavailable", "provider_drift", "retiring", "provider_managed_dns", "deployment_unconfigured" ] }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownershipRecord": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TXT" ] }, "value": { "type": "string" }, "removable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value", "removable" ] } }, "validationRecords": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "CNAME" ] }, "value": { "type": "string" } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value" ] } } }, "routingEndpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ], "patternProperties": { "^(?!(?:id|hostname|provider|mode|target|pathMode|desiredRevision|desiredState|activeProvider|activeRevision|activeMode|activeTarget|phase|reason|checkedAt|ownershipRecord|validationRecords|routingEndpoint)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ] } } }, "truncated": { "type": "boolean" } }, "required": [ "routes", "truncated" ], "patternProperties": { "^(?!(?:routes|truncated)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "routes", "truncated" ] } }, { "type": "object", "properties": { "route": { "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" }, "hostname": { "$ref": "#/$defs/DomainName" }, "provider": { "type": "string", "enum": [ "aws_cloudfront" ] }, "mode": { "type": "string", "enum": [ "redirect", "proxy" ] }, "target": { "type": "string" }, "pathMode": { "type": "string", "enum": [ "preserve", "prefix" ] }, "desiredRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "desiredState": { "type": "string", "enum": [ "enabled", "retired" ] }, "activeProvider": { "anyOf": [ { "type": "string", "enum": [ "aws_cloudfront" ] }, { "type": "null" } ] }, "activeRevision": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "activeMode": { "anyOf": [ { "type": "string", "enum": [ "redirect", "proxy" ] }, { "type": "null" } ] }, "activeTarget": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phase": { "type": "string", "enum": [ "not_configured", "waiting_dns", "waiting_tls", "waiting_publication", "active", "degraded", "retired", "needs_attention" ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "ownership_required", "certificate_pending", "certificate_failed", "route_pending", "dns_pending", "health_mismatch", "origin_unavailable", "origin_redirects", "provider_unavailable", "provider_drift", "retiring", "provider_managed_dns", "deployment_unconfigured" ] }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownershipRecord": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TXT" ] }, "value": { "type": "string" }, "removable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value", "removable" ] } }, "validationRecords": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "CNAME" ] }, "value": { "type": "string" } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value" ] } } }, "routingEndpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ], "patternProperties": { "^(?!(?:id|hostname|provider|mode|target|pathMode|desiredRevision|desiredState|activeProvider|activeRevision|activeMode|activeTarget|phase|reason|checkedAt|ownershipRecord|validationRecords|routingEndpoint)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ] } }, "history": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string" }, "status": { "type": "string" }, "reason": { "anyOf": [ { "type": "string", "enum": [ "ownership_required", "certificate_pending", "certificate_failed", "route_pending", "dns_pending", "health_mismatch", "origin_unavailable", "origin_redirects", "provider_unavailable", "provider_drift", "retiring", "provider_managed_dns", "deployment_unconfigured" ] }, { "type": "null" } ] }, "occurredAt": { "type": "string" } }, "required": [ "id", "revision", "kind", "status", "reason", "occurredAt" ], "patternProperties": { "^(?!(?:id|revision|kind|status|reason|occurredAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "revision", "kind", "status", "reason", "occurredAt" ] } } } }, "required": [ "route", "history" ], "patternProperties": { "^(?!(?:route|history)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "route", "history" ] } }, { "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" }, "hostname": { "$ref": "#/$defs/DomainName" }, "provider": { "type": "string", "enum": [ "aws_cloudfront" ] }, "mode": { "type": "string", "enum": [ "redirect", "proxy" ] }, "target": { "type": "string" }, "pathMode": { "type": "string", "enum": [ "preserve", "prefix" ] }, "desiredRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "desiredState": { "type": "string", "enum": [ "enabled", "retired" ] }, "activeProvider": { "anyOf": [ { "type": "string", "enum": [ "aws_cloudfront" ] }, { "type": "null" } ] }, "activeRevision": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "activeMode": { "anyOf": [ { "type": "string", "enum": [ "redirect", "proxy" ] }, { "type": "null" } ] }, "activeTarget": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phase": { "type": "string", "enum": [ "not_configured", "waiting_dns", "waiting_tls", "waiting_publication", "active", "degraded", "retired", "needs_attention" ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "ownership_required", "certificate_pending", "certificate_failed", "route_pending", "dns_pending", "health_mismatch", "origin_unavailable", "origin_redirects", "provider_unavailable", "provider_drift", "retiring", "provider_managed_dns", "deployment_unconfigured" ] }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownershipRecord": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TXT" ] }, "value": { "type": "string" }, "removable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value", "removable" ] } }, "validationRecords": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "CNAME" ] }, "value": { "type": "string" } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value" ] } } }, "routingEndpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ], "patternProperties": { "^(?!(?:id|hostname|provider|mode|target|pathMode|desiredRevision|desiredState|activeProvider|activeRevision|activeMode|activeTarget|phase|reason|checkedAt|ownershipRecord|validationRecords|routingEndpoint)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "routes": { "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" }, "hostname": { "$ref": "#/$defs/DomainName" }, "provider": { "type": "string", "enum": [ "aws_cloudfront" ] }, "mode": { "type": "string", "enum": [ "redirect", "proxy" ] }, "target": { "type": "string" }, "pathMode": { "type": "string", "enum": [ "preserve", "prefix" ] }, "desiredRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "desiredState": { "type": "string", "enum": [ "enabled", "retired" ] }, "activeProvider": { "anyOf": [ { "type": "string", "enum": [ "aws_cloudfront" ] }, { "type": "null" } ] }, "activeRevision": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "activeMode": { "anyOf": [ { "type": "string", "enum": [ "redirect", "proxy" ] }, { "type": "null" } ] }, "activeTarget": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phase": { "type": "string", "enum": [ "not_configured", "waiting_dns", "waiting_tls", "waiting_publication", "active", "degraded", "retired", "needs_attention" ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "ownership_required", "certificate_pending", "certificate_failed", "route_pending", "dns_pending", "health_mismatch", "origin_unavailable", "origin_redirects", "provider_unavailable", "provider_drift", "retiring", "provider_managed_dns", "deployment_unconfigured" ] }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownershipRecord": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TXT" ] }, "value": { "type": "string" }, "removable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value", "removable" ] } }, "validationRecords": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "CNAME" ] }, "value": { "type": "string" } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value" ] } } }, "routingEndpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ], "patternProperties": { "^(?!(?:id|hostname|provider|mode|target|pathMode|desiredRevision|desiredState|activeProvider|activeRevision|activeMode|activeTarget|phase|reason|checkedAt|ownershipRecord|validationRecords|routingEndpoint)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ] } } }, "truncated": { "type": "boolean" } }, "required": [ "routes", "truncated" ], "patternProperties": { "^(?!(?:routes|truncated)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "routes", "truncated" ] } }, { "type": "object", "properties": { "route": { "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" }, "hostname": { "$ref": "#/$defs/DomainName" }, "provider": { "type": "string", "enum": [ "aws_cloudfront" ] }, "mode": { "type": "string", "enum": [ "redirect", "proxy" ] }, "target": { "type": "string" }, "pathMode": { "type": "string", "enum": [ "preserve", "prefix" ] }, "desiredRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "desiredState": { "type": "string", "enum": [ "enabled", "retired" ] }, "activeProvider": { "anyOf": [ { "type": "string", "enum": [ "aws_cloudfront" ] }, { "type": "null" } ] }, "activeRevision": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "activeMode": { "anyOf": [ { "type": "string", "enum": [ "redirect", "proxy" ] }, { "type": "null" } ] }, "activeTarget": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phase": { "type": "string", "enum": [ "not_configured", "waiting_dns", "waiting_tls", "waiting_publication", "active", "degraded", "retired", "needs_attention" ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "ownership_required", "certificate_pending", "certificate_failed", "route_pending", "dns_pending", "health_mismatch", "origin_unavailable", "origin_redirects", "provider_unavailable", "provider_drift", "retiring", "provider_managed_dns", "deployment_unconfigured" ] }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownershipRecord": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TXT" ] }, "value": { "type": "string" }, "removable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value", "removable" ] } }, "validationRecords": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "CNAME" ] }, "value": { "type": "string" } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value" ] } } }, "routingEndpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ], "patternProperties": { "^(?!(?:id|hostname|provider|mode|target|pathMode|desiredRevision|desiredState|activeProvider|activeRevision|activeMode|activeTarget|phase|reason|checkedAt|ownershipRecord|validationRecords|routingEndpoint)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ] } }, "history": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string" }, "status": { "type": "string" }, "reason": { "anyOf": [ { "type": "string", "enum": [ "ownership_required", "certificate_pending", "certificate_failed", "route_pending", "dns_pending", "health_mismatch", "origin_unavailable", "origin_redirects", "provider_unavailable", "provider_drift", "retiring", "provider_managed_dns", "deployment_unconfigured" ] }, { "type": "null" } ] }, "occurredAt": { "type": "string" } }, "required": [ "id", "revision", "kind", "status", "reason", "occurredAt" ], "patternProperties": { "^(?!(?:id|revision|kind|status|reason|occurredAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "revision", "kind", "status", "reason", "occurredAt" ] } } } }, "required": [ "route", "history" ], "patternProperties": { "^(?!(?:route|history)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "route", "history" ] } }, { "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" }, "hostname": { "$ref": "#/$defs/DomainName" }, "provider": { "type": "string", "enum": [ "aws_cloudfront" ] }, "mode": { "type": "string", "enum": [ "redirect", "proxy" ] }, "target": { "type": "string" }, "pathMode": { "type": "string", "enum": [ "preserve", "prefix" ] }, "desiredRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "desiredState": { "type": "string", "enum": [ "enabled", "retired" ] }, "activeProvider": { "anyOf": [ { "type": "string", "enum": [ "aws_cloudfront" ] }, { "type": "null" } ] }, "activeRevision": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "activeMode": { "anyOf": [ { "type": "string", "enum": [ "redirect", "proxy" ] }, { "type": "null" } ] }, "activeTarget": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phase": { "type": "string", "enum": [ "not_configured", "waiting_dns", "waiting_tls", "waiting_publication", "active", "degraded", "retired", "needs_attention" ] }, "reason": { "anyOf": [ { "type": "string", "enum": [ "ownership_required", "certificate_pending", "certificate_failed", "route_pending", "dns_pending", "health_mismatch", "origin_unavailable", "origin_redirects", "provider_unavailable", "provider_drift", "retiring", "provider_managed_dns", "deployment_unconfigured" ] }, { "type": "null" } ] }, "checkedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownershipRecord": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "TXT" ] }, "value": { "type": "string" }, "removable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value|removable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value", "removable" ] } }, "validationRecords": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "CNAME" ] }, "value": { "type": "string" } }, "required": [ "name", "type", "value" ], "patternProperties": { "^(?!(?:name|type|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "value" ] } } }, "routingEndpoint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ], "patternProperties": { "^(?!(?:id|hostname|provider|mode|target|pathMode|desiredRevision|desiredState|activeProvider|activeRevision|activeMode|activeTarget|phase|reason|checkedAt|ownershipRecord|validationRecords|routingEndpoint)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "hostname", "provider", "mode", "target", "pathMode", "desiredRevision", "desiredState", "activeProvider", "activeRevision", "activeMode", "activeTarget", "phase", "reason", "checkedAt", "ownershipRecord", "validationRecords", "routingEndpoint" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `websiteRoutes.list`: `GET /v1/workspaces/:workspaceId/domains/website-routes` - `websiteRoutes.get`: `GET /v1/workspaces/:workspaceId/domains/website-routes/:routeId` - `websiteRoutes.create`: `POST /v1/workspaces/:workspaceId/domains/website-routes` - `websiteRoutes.save`: `PUT /v1/workspaces/:workspaceId/domains/website-routes/:routeId` - `websiteRoutes.check`: `POST /v1/workspaces/:workspaceId/domains/website-routes/:routeId/check` ## manage_workflow_connectors Retire a connector or change what it exposes: disconnect a provider key, an app connection, an MCP server, or a Clay/Floqer connection; re-read an external or MXToolbox catalog; and replace the tool allowlist an agent block may call on a connected app. Use to clean up a connector nobody uses, to narrow what an agent block may call through one, or to re-read a catalog after the customer changed something on the provider's side. Disconnecting is refused while a workflow that needs the provider is live, and is otherwise the thing that pauses those workflows — the result names every one it stopped. Re-reading a catalog can discover that a routine was deleted, which pauses the workflows referencing it. Widening a tool allowlist widens what an unattended agent block may do with the customer's account, so it is a security change, not a setting. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:update, integration:delete Risk: destructive; confirmation: explicit; 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": [ "disconnect_provider" ] }, "provider": { "$ref": "#/$defs/ProviderKeyConnector" } }, "required": [ "workspaceId", "action", "provider" ], "patternProperties": { "^(?!(?:workspaceId|action|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "provider" ] } }, { "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": [ "disconnect_external" ] }, "externalProvider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "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" } }, "required": [ "workspaceId", "action", "externalProvider", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|action|externalProvider|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "externalProvider", "connectionId" ] } }, { "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": [ "refresh_external_catalog" ] }, "externalProvider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "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" } }, "required": [ "workspaceId", "action", "externalProvider", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|action|externalProvider|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "externalProvider", "connectionId" ] } }, { "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": [ "disconnect_app" ] }, "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" } }, "required": [ "workspaceId", "action", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|action|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "connectionId" ] } }, { "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": [ "set_app_tool_permissions" ] }, "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" }, "toolPermissions": { "type": "object", "properties": { "toolNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 40 } }, "required": [ "toolNames" ], "patternProperties": { "^(?!(?:toolNames)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "toolNames" ] } ] } } }, "required": [ "workspaceId", "action", "connectionId", "toolPermissions" ], "patternProperties": { "^(?!(?:workspaceId|action|connectionId|toolPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "connectionId", "toolPermissions" ] } }, { "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": [ "sync_app" ] }, "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" } }, "required": [ "workspaceId", "action", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|action|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "connectionId" ] } }, { "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": [ "remove_mcp_server" ] }, "serverId": { "$ref": "#/$defs/WorkflowMcpServerId" } }, "required": [ "workspaceId", "action", "serverId" ], "patternProperties": { "^(?!(?:workspaceId|action|serverId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "serverId" ] } }, { "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": [ "disconnect_mxtoolbox" ] }, "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" } }, "required": [ "workspaceId", "action", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|action|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "connectionId" ] } }, { "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": [ "refresh_mxtoolbox_catalog" ] }, "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" } }, "required": [ "workspaceId", "action", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|action|connectionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "connectionId" ] } } ], "$defs": { "ProviderKeyConnector": { "type": "string", "enum": [ "apollo", "prospeo", "conductor" ] }, "ExternalWorkflowProvider": { "type": "string", "enum": [ "clay", "floqer" ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "WorkflowMcpServerId": { "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" } } } ``` ### 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": [ "disconnect_provider" ] }, "provider": { "$ref": "#/$defs/ProviderKeyConnector" } }, "required": [ "workspaceId", "action", "provider" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|provider)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "provider" ] }, { "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": [ "disconnect_external" ] }, "externalProvider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "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" } }, "required": [ "workspaceId", "action", "externalProvider", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|externalProvider|connectionId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "externalProvider", "connectionId" ] }, { "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": [ "refresh_external_catalog" ] }, "externalProvider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "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" } }, "required": [ "workspaceId", "action", "externalProvider", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|externalProvider|connectionId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "externalProvider", "connectionId" ] }, { "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": [ "disconnect_app" ] }, "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" } }, "required": [ "workspaceId", "action", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|connectionId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "connectionId" ] }, { "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": [ "set_app_tool_permissions" ] }, "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" }, "toolPermissions": { "type": "object", "properties": { "toolNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 40 } }, "required": [ "toolNames" ], "patternProperties": { "^(?!(?:toolNames)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "toolNames" ] } ] } } }, "required": [ "workspaceId", "action", "connectionId", "toolPermissions" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|connectionId|toolPermissions)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "connectionId", "toolPermissions" ] }, { "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": [ "sync_app" ] }, "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" } }, "required": [ "workspaceId", "action", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|connectionId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "connectionId" ] }, { "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": [ "remove_mcp_server" ] }, "serverId": { "$ref": "#/$defs/WorkflowMcpServerId" } }, "required": [ "workspaceId", "action", "serverId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|serverId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "serverId" ] }, { "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": [ "disconnect_mxtoolbox" ] }, "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" } }, "required": [ "workspaceId", "action", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|connectionId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "connectionId" ] }, { "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": [ "refresh_mxtoolbox_catalog" ] }, "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" } }, "required": [ "workspaceId", "action", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|connectionId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "connectionId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "ProviderKeyConnector": { "type": "string", "enum": [ "apollo", "prospeo", "conductor" ] }, "ExternalWorkflowProvider": { "type": "string", "enum": [ "clay", "floqer" ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "WorkflowMcpServerId": { "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" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "WorkflowConnectorProvider": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer" ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ExternalWorkflowProvider": { "type": "string", "enum": [ "clay", "floqer" ] }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ConnectorMediumText": { "type": "string", "minLength": 1, "maxLength": 500 }, "ConnectorLongText": { "type": "string", "minLength": 1, "maxLength": 8192 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "WorkflowMcpServerId": { "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" }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "provider": { "$ref": "#/$defs/WorkflowConnectorProvider" }, "connected": { "type": "boolean", "enum": [ false ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "provider", "connected", "disconnectedAt" ], "patternProperties": { "^(?!(?:provider|connected|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connected", "disconnectedAt" ] } }, { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "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" }, "connected": { "type": "boolean", "enum": [ false ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "pausedWorkflowIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 } }, "required": [ "provider", "id", "connected", "disconnectedAt", "pausedWorkflowIds" ], "patternProperties": { "^(?!(?:provider|id|connected|disconnectedAt|pausedWorkflowIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "connected", "disconnectedAt", "pausedWorkflowIds" ] } }, { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "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" }, "catalog": { "type": "object", "properties": { "fetchedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "workspaceRef": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "$ref": "#/$defs/ConnectorLongText" }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "function", "workflow", "shortcut" ] }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "key": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4096 }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "string", "number", "integer", "boolean", "object", "array", "unsupported" ] }, "required": { "type": "boolean" }, "defaultValue": { "anyOf": [ { "$ref": "#/$defs/ConnectorMediumText" }, { "type": "null" } ] } }, "required": [ "key", "name", "description", "type", "required", "defaultValue" ], "patternProperties": { "^(?!(?:key|name|description|type|required|defaultValue)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "name", "description", "type", "required", "defaultValue" ] } }, "maxItems": 100 }, "outputs": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 }, "available": { "type": "boolean" }, "schemaAvailable": { "type": "boolean" } }, "required": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ], "patternProperties": { "^(?!(?:id|name|description|kind|inputs|outputs|available|schemaAvailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ] } }, "maxItems": 1000 } }, "required": [ "fetchedAt", "workspaceRef", "targets" ], "patternProperties": { "^(?!(?:fetchedAt|workspaceRef|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fetchedAt", "workspaceRef", "targets" ] } }, "pausedWorkflowIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 } }, "required": [ "provider", "id", "catalog", "pausedWorkflowIds" ], "patternProperties": { "^(?!(?:provider|id|catalog|pausedWorkflowIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "catalog", "pausedWorkflowIds" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "connected": { "type": "boolean", "enum": [ false ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "connected", "disconnectedAt" ], "patternProperties": { "^(?!(?:id|connected|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "connected", "disconnectedAt" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "name": { "$ref": "#/$defs/ShortText" }, "url": { "$ref": "#/$defs/HttpUrl" }, "composio": { "anyOf": [ { "type": "object", "properties": { "toolkitSlug": { "$ref": "#/$defs/ShortText" }, "custom": { "type": "boolean" }, "noAuth": { "type": "boolean" }, "authorizationPending": { "type": "boolean" } }, "required": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ], "patternProperties": { "^(?!(?:toolkitSlug|custom|noAuth|authorizationPending)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ] } }, { "type": "null" } ] }, "allowedToolNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 40 }, "active": { "type": "boolean" }, "authorizationConfigured": { "type": "boolean" }, "credentialRefId": { "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" } ] }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|composio|allowedToolNames|active|authorizationConfigured|credentialRefId|lastValidatedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "syncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "syncedCount" ], "patternProperties": { "^(?!(?:id|syncedCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "syncedCount" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "removed": { "type": "boolean", "enum": [ true ] } }, "required": [ "id", "removed" ], "patternProperties": { "^(?!(?:id|removed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "removed" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "mxtoolbox" ] }, "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" }, "connected": { "type": "boolean", "enum": [ false ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "pausedWorkflowIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 } }, "required": [ "provider", "id", "connected", "disconnectedAt", "pausedWorkflowIds" ], "patternProperties": { "^(?!(?:provider|id|connected|disconnectedAt|pausedWorkflowIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "connected", "disconnectedAt", "pausedWorkflowIds" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "mxtoolbox" ] }, "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" }, "catalog": { "type": "object", "properties": { "fetchedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, "minItems": 1, "maxItems": 1000 } }, "required": [ "fetchedAt", "entries" ], "patternProperties": { "^(?!(?:fetchedAt|entries)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fetchedAt", "entries" ] } } }, "required": [ "provider", "id", "catalog" ], "patternProperties": { "^(?!(?:provider|id|catalog)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "catalog" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "provider": { "$ref": "#/$defs/WorkflowConnectorProvider" }, "connected": { "type": "boolean", "enum": [ false ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "provider", "connected", "disconnectedAt" ], "patternProperties": { "^(?!(?:provider|connected|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connected", "disconnectedAt" ] } }, { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "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" }, "connected": { "type": "boolean", "enum": [ false ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "pausedWorkflowIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 } }, "required": [ "provider", "id", "connected", "disconnectedAt", "pausedWorkflowIds" ], "patternProperties": { "^(?!(?:provider|id|connected|disconnectedAt|pausedWorkflowIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "connected", "disconnectedAt", "pausedWorkflowIds" ] } }, { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "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" }, "catalog": { "type": "object", "properties": { "fetchedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "workspaceRef": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "$ref": "#/$defs/ConnectorLongText" }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "function", "workflow", "shortcut" ] }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "key": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4096 }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "string", "number", "integer", "boolean", "object", "array", "unsupported" ] }, "required": { "type": "boolean" }, "defaultValue": { "anyOf": [ { "$ref": "#/$defs/ConnectorMediumText" }, { "type": "null" } ] } }, "required": [ "key", "name", "description", "type", "required", "defaultValue" ], "patternProperties": { "^(?!(?:key|name|description|type|required|defaultValue)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "name", "description", "type", "required", "defaultValue" ] } }, "maxItems": 100 }, "outputs": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 }, "available": { "type": "boolean" }, "schemaAvailable": { "type": "boolean" } }, "required": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ], "patternProperties": { "^(?!(?:id|name|description|kind|inputs|outputs|available|schemaAvailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ] } }, "maxItems": 1000 } }, "required": [ "fetchedAt", "workspaceRef", "targets" ], "patternProperties": { "^(?!(?:fetchedAt|workspaceRef|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fetchedAt", "workspaceRef", "targets" ] } }, "pausedWorkflowIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 } }, "required": [ "provider", "id", "catalog", "pausedWorkflowIds" ], "patternProperties": { "^(?!(?:provider|id|catalog|pausedWorkflowIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "catalog", "pausedWorkflowIds" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "connected": { "type": "boolean", "enum": [ false ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "connected", "disconnectedAt" ], "patternProperties": { "^(?!(?:id|connected|disconnectedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "connected", "disconnectedAt" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "name": { "$ref": "#/$defs/ShortText" }, "url": { "$ref": "#/$defs/HttpUrl" }, "composio": { "anyOf": [ { "type": "object", "properties": { "toolkitSlug": { "$ref": "#/$defs/ShortText" }, "custom": { "type": "boolean" }, "noAuth": { "type": "boolean" }, "authorizationPending": { "type": "boolean" } }, "required": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ], "patternProperties": { "^(?!(?:toolkitSlug|custom|noAuth|authorizationPending)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ] } }, { "type": "null" } ] }, "allowedToolNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 40 }, "active": { "type": "boolean" }, "authorizationConfigured": { "type": "boolean" }, "credentialRefId": { "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" } ] }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|composio|allowedToolNames|active|authorizationConfigured|credentialRefId|lastValidatedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "syncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "syncedCount" ], "patternProperties": { "^(?!(?:id|syncedCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "syncedCount" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "removed": { "type": "boolean", "enum": [ true ] } }, "required": [ "id", "removed" ], "patternProperties": { "^(?!(?:id|removed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "removed" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "mxtoolbox" ] }, "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" }, "connected": { "type": "boolean", "enum": [ false ] }, "disconnectedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "pausedWorkflowIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 } }, "required": [ "provider", "id", "connected", "disconnectedAt", "pausedWorkflowIds" ], "patternProperties": { "^(?!(?:provider|id|connected|disconnectedAt|pausedWorkflowIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "connected", "disconnectedAt", "pausedWorkflowIds" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "mxtoolbox" ] }, "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" }, "catalog": { "type": "object", "properties": { "fetchedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, "minItems": 1, "maxItems": 1000 } }, "required": [ "fetchedAt", "entries" ], "patternProperties": { "^(?!(?:fetchedAt|entries)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fetchedAt", "entries" ] } } }, "required": [ "provider", "id", "catalog" ], "patternProperties": { "^(?!(?:provider|id|catalog)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "catalog" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `workflowConnectors.disconnectApollo`: `DELETE /v1/workspaces/:workspaceId/workflows/integrations/apollo` - `workflowConnectors.disconnectProspeo`: `DELETE /v1/workspaces/:workspaceId/workflows/integrations/prospeo` - `workflowConnectors.disconnectConductor`: `DELETE /v1/workspaces/:workspaceId/workflows/integrations/conductor` - `workflowConnectors.disconnectExternal`: `DELETE /v1/workspaces/:workspaceId/workflows/integrations/external/:provider/:connectionId` - `workflowConnectors.refreshExternalCatalog`: `POST /v1/workspaces/:workspaceId/workflows/integrations/external/:provider/:connectionId/refresh` - `workflowIntegrations.permissions`: `PUT /v1/workspaces/:workspaceId/workflows/integrations/apps/:connectionId/permissions` - `workflowIntegrations.sync`: `POST /v1/workspaces/:workspaceId/workflows/integrations/apps/:connectionId/sync` - `workflowIntegrations.disconnect`: `DELETE /v1/workspaces/:workspaceId/workflows/integrations/apps/:connectionId` - `workflowMcpServers.remove`: `DELETE /v1/workspaces/:workspaceId/workflows/mcp-servers/:serverId` - `workflowDomainHealth.refreshCatalog`: `POST /v1/workspaces/:workspaceId/workflows/integrations/mxtoolbox/:connectionId/refresh` - `workflowDomainHealth.disconnectMxtoolbox`: `DELETE /v1/workspaces/:workspaceId/workflows/integrations/mxtoolbox/:connectionId` ## manage_workflows Author a workflow's graph and decide whether it is live: create a draft, save an edit, publish the draft as the runnable version, turn a published workflow on or off, and delete one. Trigger data.campaignFilter uses the same filter as webhook campaignScope: modes all/campaigns/tags/folders/names/rules, ids for selections, match any/all for selected tags and name terms. Rules compose nested AND/OR/NOT: field campaigns/folders/tags with ids, names with terms, tagged/filed with boolean value, or group with rules; root/groups default to match all, tags/names to any, exclude negates each rule. A campaign has many tags but one folder. excludeCampaignIds/excludeTagIds/excludeFolderIds/excludeNameContains, taggedOnly and filedOnly are available in every mode. Folder filters include live descendants. Global exclusions win; deleted references fail closed even inside NOT/OR. This supersedes legacy positiveReplyAllCampaigns/positiveReplyCampaignIds when set. Use to build or change automation. A draft only has to be well formed, so iterate freely; publishing is the step that checks every runnability rule and freezes what the executor will load. Publishing or activating a graph that sends mail, enriches contacts, or starts an AI follow-up loop commits the workspace to spending, and needs an active subscription plus — for the thread-automation blocks — the ai_follow_up feature. Deleting ends every run the workflow still owns, including loops waiting on a reply, and cannot be undone. Pausing a workflow that others enrol into alerts them too. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workflow:create, workflow:update, workflow:publish, workflow:delete Risk: destructive; confirmation: explicit; 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": [ "create" ] }, "create": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "recipe": { "type": "string", "enum": [ "blank", "positive_reply_to_dialer", "plusvibe_to_dialer", "dialer_to_plusvibe", "positive_reply_labels", "email_health_recovery", "domain_blacklist", "domain_rotation", "inbox_rotation", "thread_follow_up", "no_show_playbook" ] }, "callListId": { "$ref": "#/$defs/CallListId" }, "sequenceId": { "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": [ "name" ], "patternProperties": { "^(?!(?:name|recipe|callListId|sequenceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "recipe", "callListId", "sequenceId" ] } } }, "required": [ "workspaceId", "action", "create" ], "patternProperties": { "^(?!(?:workspaceId|action|create)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "create" ] } }, { "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": [ "save" ] }, "workflowId": { "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" }, "save": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "graph": { "type": "object", "properties": { "schemaVersion": { "anyOf": [ { "type": "number", "enum": [ 1 ] } ] }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "patternProperties": { "^(?!(?:x|y)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y" ] } }, "data": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "id", "type", "position", "data" ], "patternProperties": { "^(?!(?:id|type|position|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "position", "data" ] } }, "maxItems": 200 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "minLength": 1, "maxLength": 128 }, "target": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceHandle": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] } }, "required": [ "id", "source", "target" ], "patternProperties": { "^(?!(?:id|source|target|sourceHandle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "source", "target", "sourceHandle" ] } }, "maxItems": 400 } }, "required": [ "schemaVersion", "nodes", "edges" ], "patternProperties": { "^(?!(?:schemaVersion|nodes|edges)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "nodes", "edges" ] } } }, "required": [ "name", "graph" ], "patternProperties": { "^(?!(?:name|graph)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "graph" ] } } }, "required": [ "workspaceId", "action", "workflowId", "save" ], "patternProperties": { "^(?!(?:workspaceId|action|workflowId|save)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "workflowId", "save" ] } }, { "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": [ "publish" ] }, "workflowId": { "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", "workflowId" ], "patternProperties": { "^(?!(?:workspaceId|action|workflowId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "workflowId" ] } }, { "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": [ "activate" ] }, "workflowId": { "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", "workflowId" ], "patternProperties": { "^(?!(?:workspaceId|action|workflowId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "workflowId" ] } }, { "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": [ "pause" ] }, "workflowId": { "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", "workflowId" ], "patternProperties": { "^(?!(?:workspaceId|action|workflowId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "workflowId" ] } }, { "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": [ "remove" ] }, "workflowId": { "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", "workflowId" ], "patternProperties": { "^(?!(?:workspaceId|action|workflowId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "workflowId" ] } } ], "$defs": { "CallListId": { "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" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] } } } ``` ### 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": [ "create" ] }, "create": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "recipe": { "type": "string", "enum": [ "blank", "positive_reply_to_dialer", "plusvibe_to_dialer", "dialer_to_plusvibe", "positive_reply_labels", "email_health_recovery", "domain_blacklist", "domain_rotation", "inbox_rotation", "thread_follow_up", "no_show_playbook" ] }, "callListId": { "$ref": "#/$defs/CallListId" }, "sequenceId": { "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": [ "name" ], "patternProperties": { "^(?!(?:name|recipe|callListId|sequenceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "recipe", "callListId", "sequenceId" ] } } }, "required": [ "workspaceId", "action", "create" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|create)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "create" ] }, { "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": [ "save" ] }, "workflowId": { "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" }, "save": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "graph": { "type": "object", "properties": { "schemaVersion": { "anyOf": [ { "type": "number", "enum": [ 1 ] } ] }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "patternProperties": { "^(?!(?:x|y)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y" ] } }, "data": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "id", "type", "position", "data" ], "patternProperties": { "^(?!(?:id|type|position|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "position", "data" ] } }, "maxItems": 200 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "minLength": 1, "maxLength": 128 }, "target": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceHandle": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] } }, "required": [ "id", "source", "target" ], "patternProperties": { "^(?!(?:id|source|target|sourceHandle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "source", "target", "sourceHandle" ] } }, "maxItems": 400 } }, "required": [ "schemaVersion", "nodes", "edges" ], "patternProperties": { "^(?!(?:schemaVersion|nodes|edges)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "nodes", "edges" ] } } }, "required": [ "name", "graph" ], "patternProperties": { "^(?!(?:name|graph)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "graph" ] } } }, "required": [ "workspaceId", "action", "workflowId", "save" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|workflowId|save)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "workflowId", "save" ] }, { "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": [ "publish" ] }, "workflowId": { "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", "workflowId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|workflowId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "workflowId" ] }, { "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": [ "activate" ] }, "workflowId": { "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", "workflowId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|workflowId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "workflowId" ] }, { "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": [ "pause" ] }, "workflowId": { "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", "workflowId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|workflowId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "workflowId" ] }, { "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": [ "remove" ] }, "workflowId": { "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", "workflowId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|workflowId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "workflowId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "CallListId": { "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" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "WorkflowVersionId": { "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" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] } }, "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "deleting" ] }, "publishedVersionId": { "anyOf": [ { "$ref": "#/$defs/WorkflowVersionId" }, { "type": "null" } ] }, "triggerType": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, { "type": "null" } ] }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "version": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowVersionId" }, "workflowId": { "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" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "graph": { "type": "object", "properties": { "schemaVersion": { "anyOf": [ { "type": "number", "enum": [ 1 ] } ] }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "patternProperties": { "^(?!(?:x|y)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y" ] } }, "data": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "id", "type", "position", "data" ], "patternProperties": { "^(?!(?:id|type|position|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "position", "data" ] } }, "maxItems": 200 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "minLength": 1, "maxLength": 128 }, "target": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceHandle": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] } }, "required": [ "id", "source", "target" ], "patternProperties": { "^(?!(?:id|source|target|sourceHandle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "source", "target", "sourceHandle" ] } }, "maxItems": 400 } }, "required": [ "schemaVersion", "nodes", "edges" ], "patternProperties": { "^(?!(?:schemaVersion|nodes|edges)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "nodes", "edges" ] } }, "publishedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workflowId|version|graph|publishedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ] } }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt", "version" ], "patternProperties": { "^(?!(?:id|name|status|publishedVersionId|triggerType|alertCount|createdAt|updatedAt|version)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt", "version" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowVersionId" }, "workflowId": { "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" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "graph": { "type": "object", "properties": { "schemaVersion": { "anyOf": [ { "type": "number", "enum": [ 1 ] } ] }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "patternProperties": { "^(?!(?:x|y)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y" ] } }, "data": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "id", "type", "position", "data" ], "patternProperties": { "^(?!(?:id|type|position|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "position", "data" ] } }, "maxItems": 200 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "minLength": 1, "maxLength": 128 }, "target": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceHandle": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] } }, "required": [ "id", "source", "target" ], "patternProperties": { "^(?!(?:id|source|target|sourceHandle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "source", "target", "sourceHandle" ] } }, "maxItems": 400 } }, "required": [ "schemaVersion", "nodes", "edges" ], "patternProperties": { "^(?!(?:schemaVersion|nodes|edges)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "nodes", "edges" ] } }, "publishedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workflowId|version|graph|publishedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "workflowId": { "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" }, "publishedVersionId": { "$ref": "#/$defs/WorkflowVersionId" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "deleting" ] } }, "required": [ "workflowId", "publishedVersionId", "version", "status" ], "patternProperties": { "^(?!(?:workflowId|publishedVersionId|version|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workflowId", "publishedVersionId", "version", "status" ] } }, { "type": "object", "properties": { "workflowId": { "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" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "deleting" ] }, "alertedDependentWorkflowIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 } }, "required": [ "workflowId", "status", "alertedDependentWorkflowIds" ], "patternProperties": { "^(?!(?:workflowId|status|alertedDependentWorkflowIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workflowId", "status", "alertedDependentWorkflowIds" ] } }, { "type": "object", "properties": { "workflowId": { "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" }, "canceledRunIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 1000 } }, "required": [ "workflowId", "canceledRunIds" ], "patternProperties": { "^(?!(?:workflowId|canceledRunIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workflowId", "canceledRunIds" ] } } ] }, { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "deleting" ] }, "publishedVersionId": { "anyOf": [ { "$ref": "#/$defs/WorkflowVersionId" }, { "type": "null" } ] }, "triggerType": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, { "type": "null" } ] }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "version": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowVersionId" }, "workflowId": { "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" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "graph": { "type": "object", "properties": { "schemaVersion": { "anyOf": [ { "type": "number", "enum": [ 1 ] } ] }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "patternProperties": { "^(?!(?:x|y)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y" ] } }, "data": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "id", "type", "position", "data" ], "patternProperties": { "^(?!(?:id|type|position|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "position", "data" ] } }, "maxItems": 200 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "minLength": 1, "maxLength": 128 }, "target": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceHandle": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] } }, "required": [ "id", "source", "target" ], "patternProperties": { "^(?!(?:id|source|target|sourceHandle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "source", "target", "sourceHandle" ] } }, "maxItems": 400 } }, "required": [ "schemaVersion", "nodes", "edges" ], "patternProperties": { "^(?!(?:schemaVersion|nodes|edges)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "nodes", "edges" ] } }, "publishedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workflowId|version|graph|publishedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ] } }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt", "version" ], "patternProperties": { "^(?!(?:id|name|status|publishedVersionId|triggerType|alertCount|createdAt|updatedAt|version)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt", "version" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowVersionId" }, "workflowId": { "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" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "graph": { "type": "object", "properties": { "schemaVersion": { "anyOf": [ { "type": "number", "enum": [ 1 ] } ] }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "patternProperties": { "^(?!(?:x|y)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y" ] } }, "data": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "id", "type", "position", "data" ], "patternProperties": { "^(?!(?:id|type|position|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "position", "data" ] } }, "maxItems": 200 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "minLength": 1, "maxLength": 128 }, "target": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceHandle": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] } }, "required": [ "id", "source", "target" ], "patternProperties": { "^(?!(?:id|source|target|sourceHandle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "source", "target", "sourceHandle" ] } }, "maxItems": 400 } }, "required": [ "schemaVersion", "nodes", "edges" ], "patternProperties": { "^(?!(?:schemaVersion|nodes|edges)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "nodes", "edges" ] } }, "publishedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workflowId|version|graph|publishedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "workflowId": { "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" }, "publishedVersionId": { "$ref": "#/$defs/WorkflowVersionId" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "deleting" ] } }, "required": [ "workflowId", "publishedVersionId", "version", "status" ], "patternProperties": { "^(?!(?:workflowId|publishedVersionId|version|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workflowId", "publishedVersionId", "version", "status" ] } }, { "type": "object", "properties": { "workflowId": { "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" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "deleting" ] }, "alertedDependentWorkflowIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 } }, "required": [ "workflowId", "status", "alertedDependentWorkflowIds" ], "patternProperties": { "^(?!(?:workflowId|status|alertedDependentWorkflowIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workflowId", "status", "alertedDependentWorkflowIds" ] } }, { "type": "object", "properties": { "workflowId": { "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" }, "canceledRunIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 1000 } }, "required": [ "workflowId", "canceledRunIds" ], "patternProperties": { "^(?!(?:workflowId|canceledRunIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workflowId", "canceledRunIds" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `workflows.create`: `POST /v1/workspaces/:workspaceId/workflows` - `workflows.save`: `PUT /v1/workspaces/:workspaceId/workflows/:workflowId` - `workflows.publish`: `POST /v1/workspaces/:workspaceId/workflows/:workflowId/publish` - `workflows.setStatus`: `PATCH /v1/workspaces/:workspaceId/workflows/:workflowId/status` - `workflows.remove`: `DELETE /v1/workspaces/:workspaceId/workflows/:workflowId` ## manage_workspace_branding Set or clear a workspace's logo, deleting the prior public asset on change. Use to update a workspace's public logo asset. Only accepts a hosted public asset URL; it does not upload raw bytes. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspace:update Risk: write; confirmation: explicit; idempotency: required. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "set" ] } ] }, "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" }, "logo": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "action", "workspaceId", "logo" ], "patternProperties": { "^(?!(?:action|workspaceId|logo)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "logo" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } } ], "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "ManageWorkspaceBrandingInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "set" ] } ] }, "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" }, "logo": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "action", "workspaceId", "logo" ], "patternProperties": { "^(?!(?:action|workspaceId|logo)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "logo" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } } ] } } } ``` ### 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": { "anyOf": [ { "type": "string", "enum": [ "set" ] } ] }, "logo": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "action", "workspaceId", "logo" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|logo)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "logo" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "ManageWorkspaceBrandingInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "set" ] } ] }, "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" }, "logo": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "action", "workspaceId", "logo" ], "patternProperties": { "^(?!(?:action|workspaceId|logo)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "logo" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "slug", "logo", "createdAt" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "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$" } } } ``` ### Underlying API operations - `workspaces.setLogo`: `PUT /v1/workspaces/:workspaceId/logo` - `workspaces.deleteLogo`: `DELETE /v1/workspaces/:workspaceId/logo` ## manage_workspace_lifecycle Create, update, delete, or leave a workspace; delete/leave are human-gated and irreversible. Use to manage a workspace's identity and lifecycle under the caller's permission. Deletion cascades and is owner-only; leave/remove govern membership, not the workspace row. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspace:update, workspace:delete, workspaceMember:remove Risk: destructive; confirmation: explicit; idempotency: required. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "name": { "$ref": "#/$defs/NonEmptyString" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "action", "name" ], "patternProperties": { "^(?!(?:action|name|slug|metadata)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "name", "slug", "metadata" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "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" }, "name": { "$ref": "#/$defs/NonEmptyString" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|name|slug|metadata)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "name", "slug", "metadata" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "leave" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } } ], "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "ManageWorkspaceLifecycleInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "name": { "$ref": "#/$defs/NonEmptyString" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "action", "name" ], "patternProperties": { "^(?!(?:action|name|slug|metadata)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "name", "slug", "metadata" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "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" }, "name": { "$ref": "#/$defs/NonEmptyString" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|name|slug|metadata)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "name", "slug", "metadata" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "leave" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } } ] } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "name": { "$ref": "#/$defs/NonEmptyString" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "action", "name" ], "patternProperties": { "^(?!(?:action|name|slug|metadata)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "name", "slug", "metadata" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "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" }, "name": { "$ref": "#/$defs/NonEmptyString" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|name|slug|metadata)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "name", "slug", "metadata" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "leave" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } } ], "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "ManageWorkspaceLifecycleInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "name": { "$ref": "#/$defs/NonEmptyString" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "action", "name" ], "patternProperties": { "^(?!(?:action|name|slug|metadata)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "name", "slug", "metadata" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "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" }, "name": { "$ref": "#/$defs/NonEmptyString" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|name|slug|metadata)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "name", "slug", "metadata" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "leave" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "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$" }, "ManageWorkspaceLifecycleOutput": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "slug", "logo", "createdAt" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt" ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } }, { "type": "object", "properties": { "left": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "left" ], "patternProperties": { "^(?!(?:left)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "left" ] } ] } } ] } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/ManageWorkspaceLifecycleOutput" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/ManageWorkspaceLifecycleOutput" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `workspaces.create`: `POST /v1/workspaces` - `workspaces.update`: `PATCH /v1/workspaces/:workspaceId` - `workspaces.delete`: `DELETE /v1/workspaces/:workspaceId` - `workspaces.leave`: `POST /v1/workspaces/:workspaceId/leave` ## manage_workspace_settings Update organization settings or AI-label settings for a workspace; the action selects which settings document is patched. Use to change workspace behaviour after read_workspace_settings shows the current values. Patch payloads must carry at least one field; empty patches are rejected rather than no-oped. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspace:update Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "update_workspace_settings" ] } ] }, "patch": { "type": "object", "properties": { "contactSuggestionsAutoConfirm": { "type": "boolean" }, "autoReminderEnabled": { "type": "boolean" }, "autoReminderDays": { "type": "integer", "minimum": 1, "maximum": 365 }, "autoReminderBusinessDaysOnly": { "type": "boolean" }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "textMessageSenderNumber": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:contactSuggestionsAutoConfirm|autoReminderEnabled|autoReminderDays|autoReminderBusinessDaysOnly|dailyCapPerRecipientDomain|textMessageSenderNumber)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactSuggestionsAutoConfirm", "autoReminderEnabled", "autoReminderDays", "autoReminderBusinessDaysOnly", "dailyCapPerRecipientDomain", "textMessageSenderNumber" ] }, "minProperties": 1, "maxProperties": 6 } }, "required": [ "workspaceId", "action", "patch" ], "patternProperties": { "^(?!(?:workspaceId|action|patch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "patch" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "update_ai_label_settings" ] } ] }, "patch": { "type": "object", "properties": { "aiLabelDetection": { "type": "boolean" }, "labelCategorizationPrompt": { "type": "string", "maxLength": 2000 }, "emailNotificationForPositiveReplies": { "type": "boolean" }, "emailNotificationForAiFollowUpApprovals": { "type": "boolean" }, "notificationEmails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 100 } }, "patternProperties": { "^(?!(?:aiLabelDetection|labelCategorizationPrompt|emailNotificationForPositiveReplies|emailNotificationForAiFollowUpApprovals|notificationEmails)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "aiLabelDetection", "labelCategorizationPrompt", "emailNotificationForPositiveReplies", "emailNotificationForAiFollowUpApprovals", "notificationEmails" ] }, "minProperties": 1, "maxProperties": 5 } }, "required": [ "workspaceId", "action", "patch" ], "patternProperties": { "^(?!(?:workspaceId|action|patch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "patch" ] } } ], "$defs": { "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } } } ``` ### 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": { "anyOf": [ { "type": "string", "enum": [ "update_workspace_settings" ] } ] }, "patch": { "type": "object", "properties": { "contactSuggestionsAutoConfirm": { "type": "boolean" }, "autoReminderEnabled": { "type": "boolean" }, "autoReminderDays": { "type": "integer", "minimum": 1, "maximum": 365 }, "autoReminderBusinessDaysOnly": { "type": "boolean" }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "textMessageSenderNumber": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:contactSuggestionsAutoConfirm|autoReminderEnabled|autoReminderDays|autoReminderBusinessDaysOnly|dailyCapPerRecipientDomain|textMessageSenderNumber)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactSuggestionsAutoConfirm", "autoReminderEnabled", "autoReminderDays", "autoReminderBusinessDaysOnly", "dailyCapPerRecipientDomain", "textMessageSenderNumber" ] }, "minProperties": 1, "maxProperties": 6 } }, "required": [ "workspaceId", "action", "patch" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|patch)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "patch" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "update_ai_label_settings" ] } ] }, "patch": { "type": "object", "properties": { "aiLabelDetection": { "type": "boolean" }, "labelCategorizationPrompt": { "type": "string", "maxLength": 2000 }, "emailNotificationForPositiveReplies": { "type": "boolean" }, "emailNotificationForAiFollowUpApprovals": { "type": "boolean" }, "notificationEmails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 100 } }, "patternProperties": { "^(?!(?:aiLabelDetection|labelCategorizationPrompt|emailNotificationForPositiveReplies|emailNotificationForAiFollowUpApprovals|notificationEmails)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "aiLabelDetection", "labelCategorizationPrompt", "emailNotificationForPositiveReplies", "emailNotificationForAiFollowUpApprovals", "notificationEmails" ] }, "minProperties": 1, "maxProperties": 5 } }, "required": [ "workspaceId", "action", "patch" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|patch)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "patch" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "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$" }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } }, "type": "object", "anyOf": [ { "allOf": [ { "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" }, "contactSuggestionsAutoConfirm": { "type": "boolean" }, "contactSuggestionsAutoConfirmSince": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "replyDetectionAiPrompt": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "googleEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "microsoftEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "otherEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "timezone": { "$ref": "#/$defs/IanaTimeZone" }, "dailySendingLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "textMessageSenderNumber": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "autoReminderEnabled": { "type": "boolean" }, "autoReminderDays": { "type": "integer", "minimum": 1, "maximum": 365 }, "autoReminderBusinessDaysOnly": { "type": "boolean" }, "verificationSharingMode": { "type": "string", "enum": [ "contribute_and_consume", "consume_only", "private" ] }, "createdAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "workspaceId", "contactSuggestionsAutoConfirm", "contactSuggestionsAutoConfirmSince", "replyDetectionAiPrompt", "googleEspMatch", "microsoftEspMatch", "otherEspMatch", "timezone", "dailySendingLimit", "textMessageSenderNumber", "dailyCapPerRecipientDomain", "autoReminderEnabled", "autoReminderDays", "autoReminderBusinessDaysOnly", "verificationSharingMode", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:workspaceId|contactSuggestionsAutoConfirm|contactSuggestionsAutoConfirmSince|replyDetectionAiPrompt|googleEspMatch|microsoftEspMatch|otherEspMatch|timezone|dailySendingLimit|textMessageSenderNumber|dailyCapPerRecipientDomain|autoReminderEnabled|autoReminderDays|autoReminderBusinessDaysOnly|verificationSharingMode|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "contactSuggestionsAutoConfirm", "contactSuggestionsAutoConfirmSince", "replyDetectionAiPrompt", "googleEspMatch", "microsoftEspMatch", "otherEspMatch", "timezone", "dailySendingLimit", "textMessageSenderNumber", "dailyCapPerRecipientDomain", "autoReminderEnabled", "autoReminderDays", "autoReminderBusinessDaysOnly", "verificationSharingMode", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "aiLabelDetection": { "type": "boolean" }, "labelCategorizationPrompt": { "type": "string", "maxLength": 2000 }, "emailNotificationForPositiveReplies": { "type": "boolean" }, "emailNotificationForAiFollowUpApprovals": { "type": "boolean" }, "notificationEmails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 100 } }, "required": [ "aiLabelDetection", "labelCategorizationPrompt", "emailNotificationForPositiveReplies", "emailNotificationForAiFollowUpApprovals", "notificationEmails" ], "patternProperties": { "^(?!(?:aiLabelDetection|labelCategorizationPrompt|emailNotificationForPositiveReplies|emailNotificationForAiFollowUpApprovals|notificationEmails)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "aiLabelDetection", "labelCategorizationPrompt", "emailNotificationForPositiveReplies", "emailNotificationForAiFollowUpApprovals", "notificationEmails" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "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" }, "contactSuggestionsAutoConfirm": { "type": "boolean" }, "contactSuggestionsAutoConfirmSince": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "replyDetectionAiPrompt": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "googleEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "microsoftEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "otherEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "timezone": { "$ref": "#/$defs/IanaTimeZone" }, "dailySendingLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "textMessageSenderNumber": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "autoReminderEnabled": { "type": "boolean" }, "autoReminderDays": { "type": "integer", "minimum": 1, "maximum": 365 }, "autoReminderBusinessDaysOnly": { "type": "boolean" }, "verificationSharingMode": { "type": "string", "enum": [ "contribute_and_consume", "consume_only", "private" ] }, "createdAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "workspaceId", "contactSuggestionsAutoConfirm", "contactSuggestionsAutoConfirmSince", "replyDetectionAiPrompt", "googleEspMatch", "microsoftEspMatch", "otherEspMatch", "timezone", "dailySendingLimit", "textMessageSenderNumber", "dailyCapPerRecipientDomain", "autoReminderEnabled", "autoReminderDays", "autoReminderBusinessDaysOnly", "verificationSharingMode", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:workspaceId|contactSuggestionsAutoConfirm|contactSuggestionsAutoConfirmSince|replyDetectionAiPrompt|googleEspMatch|microsoftEspMatch|otherEspMatch|timezone|dailySendingLimit|textMessageSenderNumber|dailyCapPerRecipientDomain|autoReminderEnabled|autoReminderDays|autoReminderBusinessDaysOnly|verificationSharingMode|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "contactSuggestionsAutoConfirm", "contactSuggestionsAutoConfirmSince", "replyDetectionAiPrompt", "googleEspMatch", "microsoftEspMatch", "otherEspMatch", "timezone", "dailySendingLimit", "textMessageSenderNumber", "dailyCapPerRecipientDomain", "autoReminderEnabled", "autoReminderDays", "autoReminderBusinessDaysOnly", "verificationSharingMode", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "aiLabelDetection": { "type": "boolean" }, "labelCategorizationPrompt": { "type": "string", "maxLength": 2000 }, "emailNotificationForPositiveReplies": { "type": "boolean" }, "emailNotificationForAiFollowUpApprovals": { "type": "boolean" }, "notificationEmails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 100 } }, "required": [ "aiLabelDetection", "labelCategorizationPrompt", "emailNotificationForPositiveReplies", "emailNotificationForAiFollowUpApprovals", "notificationEmails" ], "patternProperties": { "^(?!(?:aiLabelDetection|labelCategorizationPrompt|emailNotificationForPositiveReplies|emailNotificationForAiFollowUpApprovals|notificationEmails)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "aiLabelDetection", "labelCategorizationPrompt", "emailNotificationForPositiveReplies", "emailNotificationForAiFollowUpApprovals", "notificationEmails" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `workspaceSettings.update`: `PATCH /v1/workspaces/:workspaceId/settings` - `aiLabels.update`: `PATCH /v1/workspaces/:workspaceId/settings/ai-labels` ## manage_workspace_variables List, create, update, or delete organization variables used as substitution values in campaign content. Use to manage the workspace-level key/value pairs that campaigns can reference as variables. Variable keys must be unique per workspace and follow the allowed key grammar; values are never shown in telemetry. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspace:read, workspace:update Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] } }, "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": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "input": { "type": "object", "properties": { "key": { "$ref": "#/$defs/OrganizationVariableKey" }, "value": { "$ref": "#/$defs/OrganizationVariableValue" }, "label": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value|label|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value", "label", "description" ] } } }, "required": [ "workspaceId", "action", "input" ], "patternProperties": { "^(?!(?:workspaceId|action|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "input" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "variableId": { "type": "string", "minLength": 1, "maxLength": 64 }, "input": { "type": "object", "properties": { "value": { "$ref": "#/$defs/OrganizationVariableValue" }, "label": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:value|label|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "value", "label", "description" ] }, "minProperties": 1, "maxProperties": 3 } }, "required": [ "workspaceId", "action", "variableId", "input" ], "patternProperties": { "^(?!(?:workspaceId|action|variableId|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "variableId", "input" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "variableId": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "workspaceId", "action", "variableId" ], "patternProperties": { "^(?!(?:workspaceId|action|variableId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "variableId" ] } } ], "$defs": { "OrganizationVariableKey": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "OrganizationVariableValue": { "type": "string", "minLength": 1, "maxLength": 10000 } } } ``` ### 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": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] } }, "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": { "anyOf": [ { "type": "string", "enum": [ "create" ] } ] }, "input": { "type": "object", "properties": { "key": { "$ref": "#/$defs/OrganizationVariableKey" }, "value": { "$ref": "#/$defs/OrganizationVariableValue" }, "label": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value|label|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value", "label", "description" ] } } }, "required": [ "workspaceId", "action", "input" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|input)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "input" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "update" ] } ] }, "variableId": { "type": "string", "minLength": 1, "maxLength": 64 }, "input": { "type": "object", "properties": { "value": { "$ref": "#/$defs/OrganizationVariableValue" }, "label": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:value|label|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "value", "label", "description" ] }, "minProperties": 1, "maxProperties": 3 } }, "required": [ "workspaceId", "action", "variableId", "input" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|variableId|input)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "variableId", "input" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "delete" ] } ] }, "variableId": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "workspaceId", "action", "variableId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|variableId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "variableId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "OrganizationVariableKey": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "OrganizationVariableValue": { "type": "string", "minLength": 1, "maxLength": 10000 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "OrganizationVariableKey": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "OrganizationVariableValue": { "type": "string", "minLength": 1, "maxLength": 10000 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "key": { "$ref": "#/$defs/OrganizationVariableKey" }, "value": { "$ref": "#/$defs/OrganizationVariableValue" }, "label": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "key", "value", "label", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|key|value|label|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "key", "value", "label", "description", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "key": { "$ref": "#/$defs/OrganizationVariableKey" }, "value": { "$ref": "#/$defs/OrganizationVariableValue" }, "label": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "key", "value", "label", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|key|value|label|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "key", "value", "label", "description", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "key": { "$ref": "#/$defs/OrganizationVariableKey" }, "value": { "$ref": "#/$defs/OrganizationVariableValue" }, "label": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "key", "value", "label", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|key|value|label|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "key", "value", "label", "description", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "key": { "$ref": "#/$defs/OrganizationVariableKey" }, "value": { "$ref": "#/$defs/OrganizationVariableValue" }, "label": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "key", "value", "label", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|key|value|label|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "key", "value", "label", "description", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "deleted": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "deleted" ], "patternProperties": { "^(?!(?:deleted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "deleted" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `organizationVariables.list`: `GET /v1/workspaces/:workspaceId/settings/variables` - `organizationVariables.create`: `POST /v1/workspaces/:workspaceId/settings/variables` - `organizationVariables.update`: `PATCH /v1/workspaces/:workspaceId/settings/variables/:variableId` - `organizationVariables.delete`: `DELETE /v1/workspaces/:workspaceId/settings/variables/:variableId` ## message_heyreach Reply in an existing LinkedIn conversation as one of the workspace's senders, or mark a conversation seen or unseen. Use to send a reply a person has approved into a thread returned by read_heyreach, naming the sender account that owns the conversation. A sent LinkedIn message reaches a real person and cannot be recalled; it is refused on a frozen subscription. The server deduplicates retries of the same send. Marking seen sends nothing and is always available. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:update, unibox:reply Risk: costly; confirmation: explicit; 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" }, "conversationId": { "$ref": "#/$defs/HeyReachConversationId" }, "action": { "type": "string", "enum": [ "send" ] }, "send": { "$ref": "#/$defs/SendHeyReachMessageInput" } }, "required": [ "workspaceId", "conversationId", "action", "send" ], "patternProperties": { "^(?!(?:workspaceId|conversationId|action|send)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "conversationId", "action", "send" ] } }, { "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" }, "conversationId": { "$ref": "#/$defs/HeyReachConversationId" }, "action": { "type": "string", "enum": [ "mark_seen" ] }, "seen": { "$ref": "#/$defs/SetHeyReachSeenInput" } }, "required": [ "workspaceId", "conversationId", "action", "seen" ], "patternProperties": { "^(?!(?:workspaceId|conversationId|action|seen)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "conversationId", "action", "seen" ] } } ], "$defs": { "HeyReachConversationId": { "type": "string", "minLength": 1, "maxLength": 2000 }, "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "SendHeyReachMessageInput": { "type": "object", "properties": { "linkedInAccountId": { "$ref": "#/$defs/HeyReachId" }, "message": { "type": "string", "minLength": 1, "maxLength": 8000 }, "subject": { "type": "string", "minLength": 0, "maxLength": 200 } }, "required": [ "linkedInAccountId", "message" ], "patternProperties": { "^(?!(?:linkedInAccountId|message|subject)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "linkedInAccountId", "message", "subject" ] } }, "SetHeyReachSeenInput": { "type": "object", "properties": { "linkedInAccountId": { "$ref": "#/$defs/HeyReachId" }, "seen": { "type": "boolean" } }, "required": [ "linkedInAccountId", "seen" ], "patternProperties": { "^(?!(?:linkedInAccountId|seen)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "linkedInAccountId", "seen" ] } } } } ``` ### 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" }, "conversationId": { "$ref": "#/$defs/HeyReachConversationId" }, "action": { "type": "string", "enum": [ "send" ] }, "send": { "$ref": "#/$defs/SendHeyReachMessageInput" } }, "required": [ "workspaceId", "conversationId", "action", "send" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|conversationId|action|send)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "conversationId", "action", "send" ] }, { "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" }, "conversationId": { "$ref": "#/$defs/HeyReachConversationId" }, "action": { "type": "string", "enum": [ "mark_seen" ] }, "seen": { "$ref": "#/$defs/SetHeyReachSeenInput" } }, "required": [ "workspaceId", "conversationId", "action", "seen" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|conversationId|action|seen)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "conversationId", "action", "seen" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "HeyReachConversationId": { "type": "string", "minLength": 1, "maxLength": 2000 }, "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "SendHeyReachMessageInput": { "type": "object", "properties": { "linkedInAccountId": { "$ref": "#/$defs/HeyReachId" }, "message": { "type": "string", "minLength": 1, "maxLength": 8000 }, "subject": { "type": "string", "minLength": 0, "maxLength": 200 } }, "required": [ "linkedInAccountId", "message" ], "patternProperties": { "^(?!(?:linkedInAccountId|message|subject)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "linkedInAccountId", "message", "subject" ] } }, "SetHeyReachSeenInput": { "type": "object", "properties": { "linkedInAccountId": { "$ref": "#/$defs/HeyReachId" }, "seen": { "type": "boolean" } }, "required": [ "linkedInAccountId", "seen" ], "patternProperties": { "^(?!(?:linkedInAccountId|seen)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "linkedInAccountId", "seen" ] } } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ``` ### Underlying API operations - `heyreachConversations.send`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/conversations/:conversationId/messages` - `heyreachConversations.seen`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/conversations/:conversationId/seen` ## monitor_job_progress Read one bounded batch of up to 250 events for a workflow run, number provisioning, domain registration, mailbox order, verification run, or mailbox migration. Repeat with the returned cursor until the operation is terminal. Use after starting long work to report what it is actually doing rather than guessing from a status field. Each batch carries a cursor; repeat with that cursor to continue without losing later events. The stream is scoped to one operation the caller already owns; it cannot enumerate a workspace's work. Each kind is authorized against the permission that owns the underlying resource, so a credential that may follow a verification run may not follow a domain registration. Scopes: workspace:read, dialer:read, domain:read, emailVerification:read, phoneVerification:read, workflow:read, inbox:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "kind": { "$ref": "#/$defs/JobProgressKind" }, "resourceId": { "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" }, "cursor": { "type": "integer", "minimum": 0 } }, "required": [ "workspaceId", "kind", "resourceId" ], "patternProperties": { "^(?!(?:workspaceId|kind|resourceId|cursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "kind", "resourceId", "cursor" ] }, "$defs": { "JobProgressKind": { "type": "string", "enum": [ "dialer-provision", "domain-registration", "email-verification", "phone-verification", "inbox-migration", "workflow" ] } } } ``` ### 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" }, "kind": { "$ref": "#/$defs/JobProgressKind" }, "resourceId": { "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" }, "cursor": { "type": "integer", "minimum": 0 } }, "required": [ "workspaceId", "kind", "resourceId" ], "patternProperties": { "^(?!(?:workspaceId|kind|resourceId|cursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "kind", "resourceId", "cursor" ] }, "$defs": { "JobProgressKind": { "type": "string", "enum": [ "dialer-provision", "domain-registration", "email-verification", "phone-verification", "inbox-migration", "workflow" ] } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "kind": { "$ref": "#/$defs/JobProgressKind" }, "resourceId": { "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" }, "cursor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "events": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SpanStart" ] }, "traceId": { "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" }, "spanId": { "type": "string", "pattern": "^[0-9a-f]{16}$" }, "parentSpanId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{16}$" }, { "type": "null" } ] }, "name": { "$ref": "#/$defs/ShortText" }, "timestamp": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "_tag", "traceId", "spanId", "parentSpanId", "name", "timestamp", "attempt" ], "patternProperties": { "^(?!(?:_tag|traceId|spanId|parentSpanId|name|timestamp|attempt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "_tag", "traceId", "spanId", "parentSpanId", "name", "timestamp", "attempt" ] } }, { "type": "object", "properties": { "_tag": { "type": "string", "enum": [ "SpanEnd" ] }, "traceId": { "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" }, "spanId": { "type": "string", "pattern": "^[0-9a-f]{16}$" }, "timestamp": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "durationMs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "ok", "error" ] } }, "required": [ "_tag", "traceId", "spanId", "timestamp", "durationMs", "status" ], "patternProperties": { "^(?!(?:_tag|traceId|spanId|timestamp|durationMs|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "_tag", "traceId", "spanId", "timestamp", "durationMs", "status" ] } } ] }, "maxItems": 250 }, "status": { "$ref": "#/$defs/ShortText" }, "terminal": { "type": "boolean" }, "migrationConnection": { "$ref": "#/$defs/MigrationConnectionProgress" } }, "required": [ "kind", "resourceId", "cursor", "events", "status", "terminal" ], "patternProperties": { "^(?!(?:kind|resourceId|cursor|events|status|terminal|migrationConnection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "resourceId", "cursor", "events", "status", "terminal", "migrationConnection" ] }, "$defs": { "JobProgressKind": { "type": "string", "enum": [ "dialer-provision", "domain-registration", "email-verification", "phone-verification", "inbox-migration", "workflow" ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "MigrationConnectionProgress": { "type": "object", "properties": { "itemId": { "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": { "type": "string", "enum": [ "checking_existing", "finding_admin", "approving_app", "signing_in", "submitting_login", "waiting_for_provider", "granting_consent", "confirming_connection", "connected", "needs_attention" ] }, "completed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedAt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "itemId", "stage", "completed", "failed", "total", "updatedAt" ], "patternProperties": { "^(?!(?:itemId|stage|completed|failed|total|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "itemId", "stage", "completed", "failed", "total", "updatedAt" ] } } } } ``` ### Underlying API operations - `jobProgress.stream`: `GET /v1/workspaces/:workspaceId/job-progress/:kind/:resourceId` ## organize_campaign_folders Browse and reorganize the campaign folder hierarchy, and file campaigns into it. Use to tidy a workspace's campaign list; folder counts roll up through subfolders, so a parent's count already includes everything nested beneath it. Deleting a folder never deletes campaigns — they move one level up. There is deliberately no way to delete a folder together with its contents. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: campaign:read, campaign:update Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "tree", "breadcrumb", "create", "rename", "move", "delete", "move_campaigns", "unfiled_count" ] }, "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" }, "folderId": { "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" }, "create": { "anyOf": [ { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "parentId": { "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" } ] } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|parentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "parentId" ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "name" ] } ] } }, { "type": "object", "properties": { "parentId": { "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" } ] } }, "required": [ "parentId" ], "patternProperties": { "^(?!(?:parentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "parentId" ] } ] } }, { "type": "object", "properties": { "campaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "folderId": { "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" } ] } }, "required": [ "campaignIds", "folderId" ], "patternProperties": { "^(?!(?:campaignIds|folderId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignIds", "folderId" ] } } ] }, "parentId": { "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" }, "campaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|folderId|create|parentId|campaignIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "folderId", "create", "parentId", "campaignIds" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "tree", "breadcrumb", "create", "rename", "move", "delete", "move_campaigns", "unfiled_count" ] }, "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" }, "folderId": { "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" }, "create": { "anyOf": [ { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "parentId": { "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" } ] } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|parentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "parentId" ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "name" ] } ] } }, { "type": "object", "properties": { "parentId": { "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" } ] } }, "required": [ "parentId" ], "patternProperties": { "^(?!(?:parentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "parentId" ] } ] } }, { "type": "object", "properties": { "campaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "folderId": { "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" } ] } }, "required": [ "campaignIds", "folderId" ], "patternProperties": { "^(?!(?:campaignIds|folderId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignIds", "folderId" ] } } ] }, "parentId": { "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" }, "campaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|folderId|create|parentId|campaignIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "folderId", "create", "parentId", "campaignIds" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "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" }, "name": { "$ref": "#/$defs/ShortText" }, "parentId": { "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" } ] }, "campaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subfolderCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|parentId|campaignCount|subfolderCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "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" }, "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" }, "name": { "$ref": "#/$defs/ShortText" }, "parentId": { "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" } ] }, "campaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subfolderCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|parentId|campaignCount|subfolderCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "nodes": { "type": "array", "items": { "type": "object", "properties": { "folder": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "parentId": { "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" } ] }, "campaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subfolderCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|parentId|campaignCount|subfolderCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ] } }, "depth": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "path": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } } } }, "required": [ "folder", "depth", "path" ], "patternProperties": { "^(?!(?:folder|depth|path)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "folder", "depth", "path" ] } } } }, "required": [ "nodes" ], "patternProperties": { "^(?!(?:nodes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "nodes" ] } ] } }, { "type": "object", "properties": { "path": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } } } }, "required": [ "path" ], "patternProperties": { "^(?!(?:path)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "path" ] } ] } }, { "type": "object", "properties": { "folderId": { "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" }, "movedTo": { "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" } ] } }, "required": [ "folderId", "movedTo" ], "patternProperties": { "^(?!(?:folderId|movedTo)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "folderId", "movedTo" ] } }, { "type": "object", "properties": { "movedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "folderId": { "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" } ] } }, "required": [ "movedCount", "folderId" ], "patternProperties": { "^(?!(?:movedCount|folderId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "movedCount", "folderId" ] } }, { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } } ] }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "parentId": { "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" } ] }, "campaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subfolderCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|parentId|campaignCount|subfolderCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "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" }, "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" }, "name": { "$ref": "#/$defs/ShortText" }, "parentId": { "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" } ] }, "campaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subfolderCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|parentId|campaignCount|subfolderCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "nodes": { "type": "array", "items": { "type": "object", "properties": { "folder": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "parentId": { "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" } ] }, "campaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subfolderCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|parentId|campaignCount|subfolderCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "parentId", "campaignCount", "subfolderCount", "createdAt", "updatedAt" ] } }, "depth": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "path": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } } } }, "required": [ "folder", "depth", "path" ], "patternProperties": { "^(?!(?:folder|depth|path)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "folder", "depth", "path" ] } } } }, "required": [ "nodes" ], "patternProperties": { "^(?!(?:nodes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "nodes" ] } ] } }, { "type": "object", "properties": { "path": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } } } }, "required": [ "path" ], "patternProperties": { "^(?!(?:path)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "path" ] } ] } }, { "type": "object", "properties": { "folderId": { "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" }, "movedTo": { "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" } ] } }, "required": [ "folderId", "movedTo" ], "patternProperties": { "^(?!(?:folderId|movedTo)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "folderId", "movedTo" ] } }, { "type": "object", "properties": { "movedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "folderId": { "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" } ] } }, "required": [ "movedCount", "folderId" ], "patternProperties": { "^(?!(?:movedCount|folderId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "movedCount", "folderId" ] } }, { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaignFolders.list`: `GET /v1/workspaces/:workspaceId/campaign-folders` - `campaignFolders.tree`: `GET /v1/workspaces/:workspaceId/campaign-folders/tree` - `campaignFolders.breadcrumb`: `GET /v1/workspaces/:workspaceId/campaign-folders/:folderId/breadcrumb` - `campaignFolders.create`: `POST /v1/workspaces/:workspaceId/campaign-folders` - `campaignFolders.rename`: `PATCH /v1/workspaces/:workspaceId/campaign-folders/:folderId` - `campaignFolders.move`: `POST /v1/workspaces/:workspaceId/campaign-folders/:folderId/move` - `campaignFolders.delete`: `DELETE /v1/workspaces/:workspaceId/campaign-folders/:folderId` - `campaignFolders.moveCampaigns`: `POST /v1/workspaces/:workspaceId/campaign-folders/move-campaigns` - `campaignFolders.unfiledCount`: `GET /v1/workspaces/:workspaceId/campaign-folders/unfiled-count` ## prepare_confirmation Build a bounded preview of a mutation and return a confirmation token bound to the exact input. Use before any capability whose confirmation policy is preview_token; the returned token is required to commit. A preview executes nothing; do not treat it as a substitute for the commit call. Use the native preview first and pass its confirmation token unchanged to commit. A token does not bypass current permissions or Workspace checks. Scopes: agent:capabilities Risk: write; confirmation: preview_token; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "capabilityId": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "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" }, "input": { "$ref": "#/$defs/Union_" } }, "required": [ "capabilityId", "workspaceId", "input" ], "patternProperties": { "^(?!(?:capabilityId|workspaceId|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "capabilityId", "workspaceId", "input" ] }, "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "capabilityId": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" }, "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" }, "input": { "$ref": "#/$defs/Union_" } }, "required": [ "capabilityId", "workspaceId", "input" ], "patternProperties": { "^(?!(?:capabilityId|workspaceId|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "capabilityId", "workspaceId", "input" ] }, "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "preview", "confirmationToken" ] }, "$defs": { "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Money": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XCG", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWG" ] } }, "required": [ "amountMinor", "currency" ], "patternProperties": { "^(?!(?:amountMinor|currency)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "amountMinor", "currency" ] } }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `agent.prepareConfirmation`: `POST /agent/confirmations` ## preview_integration_share_detach Preview what detaching a shared connection would pause or stop in this workspace. Call before detach_integration_share and show the affected workflows and steps to the user. The preview changes nothing; blocking items must be resolved before a detach succeeds. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "shareId": { "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", "shareId" ], "patternProperties": { "^(?!(?:workspaceId|shareId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "shareId" ] } } ``` ### 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" }, "shareId": { "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", "shareId" ], "patternProperties": { "^(?!(?:workspaceId|shareId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "shareId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "shareId": { "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" }, "connectionId": { "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" } ] }, "canDetach": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "workflow", "campaign_step", "in_flight_run", "webhook", "scheduling", "verification", "other" ] }, "label": { "$ref": "#/$defs/ShortText" }, "effect": { "$ref": "#/$defs/ShortText" }, "blocking": { "type": "boolean" } }, "required": [ "kind", "label", "effect", "blocking" ], "patternProperties": { "^(?!(?:kind|label|effect|blocking)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "label", "effect", "blocking" ] } }, "maxItems": 200 } }, "required": [ "shareId", "workspaceId", "connectionId", "canDetach", "items" ], "patternProperties": { "^(?!(?:shareId|workspaceId|connectionId|canDetach|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "shareId", "workspaceId", "connectionId", "canDetach", "items" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `integrationShares.detachPreview`: `GET /v1/workspaces/:workspaceId/integration-shares/:shareId/detach-preview` ## preview_unibox_reply Resolve reply personalization variables or preview a full draft. A full preview shows the final recipient set after auto-CC/BCC and suppression, and the rendered body. Inbox custom values require inbox:read; built-in sender values remain available without it. Use before composing and again before sending. It sends nothing, and it keeps working while a subscription is frozen — so it is also how you find out that sending is what is blocked. Choose personalization with a recipient, or preview with a complete draft. A preview is not authorization to send: only its confirmation token is, and only through send_unibox_reply. Scopes: unibox:reply, lead:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "personalization" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "recipient": { "$ref": "#/$defs/EmailAddress" }, "fromInboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId", "recipient" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId|recipient|fromInboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId", "recipient", "fromInboxId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "preview" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "draft": { "type": "object", "properties": { "fromInboxId": { "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" }, "to": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "minItems": 1, "maxItems": 50 }, "cc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "minItems": 0, "maxItems": 50 }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "minItems": 0, "maxItems": 50 }, "body": { "$ref": "#/$defs/ReplyBody" }, "bodyContentType": { "type": "string", "enum": [ "html", "plain" ] }, "personalizationTemplate": { "type": "string", "minLength": 1, "maxLength": 100000 }, "track": { "type": "boolean" } }, "required": [ "to", "body", "bodyContentType" ], "patternProperties": { "^(?!(?:fromInboxId|to|cc|bcc|body|bodyContentType|personalizationTemplate|track)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fromInboxId", "to", "cc", "bcc", "body", "bodyContentType", "personalizationTemplate", "track" ] } } }, "required": [ "workspaceId", "action", "messageId", "draft" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId|draft)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId", "draft" ] } } ], "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ReplyBody": { "type": "string", "minLength": 1, "maxLength": 1000000 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "personalization" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "recipient": { "$ref": "#/$defs/EmailAddress" }, "fromInboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId", "recipient" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId|recipient|fromInboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId", "recipient", "fromInboxId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "preview" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "draft": { "type": "object", "properties": { "fromInboxId": { "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" }, "to": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "minItems": 1, "maxItems": 50 }, "cc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "minItems": 0, "maxItems": 50 }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "minItems": 0, "maxItems": 50 }, "body": { "$ref": "#/$defs/ReplyBody" }, "bodyContentType": { "type": "string", "enum": [ "html", "plain" ] }, "personalizationTemplate": { "type": "string", "minLength": 1, "maxLength": 100000 }, "track": { "type": "boolean" } }, "required": [ "to", "body", "bodyContentType" ], "patternProperties": { "^(?!(?:fromInboxId|to|cc|bcc|body|bodyContentType|personalizationTemplate|track)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fromInboxId", "to", "cc", "bcc", "body", "bodyContentType", "personalizationTemplate", "track" ] } } }, "required": [ "workspaceId", "action", "messageId", "draft" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId|draft)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId", "draft" ] } } ], "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ReplyBody": { "type": "string", "minLength": 1, "maxLength": 1000000 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "AttachmentId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Money": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XCG", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWG" ] } }, "required": [ "amountMinor", "currency" ], "patternProperties": { "^(?!(?:amountMinor|currency)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "amountMinor", "currency" ] } }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "recipient": { "$ref": "#/$defs/EmailAddress" }, "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" } ] }, "leadId": { "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" } ] }, "matched": { "type": "boolean" }, "leadData": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "platformData": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "customFieldNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 256 } }, "required": [ "messageId", "recipient", "inboxId", "leadId", "matched", "leadData", "platformData", "customFieldNames" ], "patternProperties": { "^(?!(?:messageId|recipient|inboxId|leadId|matched|leadData|platformData|customFieldNames)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "recipient", "inboxId", "leadId", "matched", "leadData", "platformData", "customFieldNames" ] } }, { "type": "object", "properties": { "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "threadId": { "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" }, "resolved": { "type": "object", "properties": { "fromInboxId": { "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" }, "fromAddress": { "$ref": "#/$defs/EmailAddress" }, "to": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" } }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" } }, "renderedSubject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "renderedBodyHtml": { "anyOf": [ { "type": "string", "maxLength": 2000000 }, { "type": "null" } ] }, "renderedBodyText": { "anyOf": [ { "type": "string", "maxLength": 2000000 }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttachmentId" }, "filename": { "$ref": "#/$defs/ShortText" }, "contentType": { "$ref": "#/$defs/ShortText" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inline": { "type": "boolean" } }, "required": [ "id", "filename", "contentType", "size", "inline" ], "patternProperties": { "^(?!(?:id|filename|contentType|size|inline)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "filename", "contentType", "size", "inline" ] } }, "maxItems": 25 }, "missingAttachments": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 25 }, "suppressedRecipients": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 150 }, "missingVariables": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 128 } }, "required": [ "fromInboxId", "fromAddress", "to", "cc", "bcc", "renderedSubject", "renderedBodyHtml", "renderedBodyText", "attachments", "missingAttachments", "suppressedRecipients", "missingVariables" ], "patternProperties": { "^(?!(?:fromInboxId|fromAddress|to|cc|bcc|renderedSubject|renderedBodyHtml|renderedBodyText|attachments|missingAttachments|suppressedRecipients|missingVariables)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fromInboxId", "fromAddress", "to", "cc", "bcc", "renderedSubject", "renderedBodyHtml", "renderedBodyText", "attachments", "missingAttachments", "suppressedRecipients", "missingVariables" ] } }, "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "messageId", "threadId", "resolved", "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:messageId|threadId|resolved|preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "threadId", "resolved", "preview", "confirmationToken" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "recipient": { "$ref": "#/$defs/EmailAddress" }, "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" } ] }, "leadId": { "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" } ] }, "matched": { "type": "boolean" }, "leadData": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "platformData": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "customFieldNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 256 } }, "required": [ "messageId", "recipient", "inboxId", "leadId", "matched", "leadData", "platformData", "customFieldNames" ], "patternProperties": { "^(?!(?:messageId|recipient|inboxId|leadId|matched|leadData|platformData|customFieldNames)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "recipient", "inboxId", "leadId", "matched", "leadData", "platformData", "customFieldNames" ] } }, { "type": "object", "properties": { "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "threadId": { "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" }, "resolved": { "type": "object", "properties": { "fromInboxId": { "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" }, "fromAddress": { "$ref": "#/$defs/EmailAddress" }, "to": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" } }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" } }, "renderedSubject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "renderedBodyHtml": { "anyOf": [ { "type": "string", "maxLength": 2000000 }, { "type": "null" } ] }, "renderedBodyText": { "anyOf": [ { "type": "string", "maxLength": 2000000 }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttachmentId" }, "filename": { "$ref": "#/$defs/ShortText" }, "contentType": { "$ref": "#/$defs/ShortText" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inline": { "type": "boolean" } }, "required": [ "id", "filename", "contentType", "size", "inline" ], "patternProperties": { "^(?!(?:id|filename|contentType|size|inline)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "filename", "contentType", "size", "inline" ] } }, "maxItems": 25 }, "missingAttachments": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 25 }, "suppressedRecipients": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 150 }, "missingVariables": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 128 } }, "required": [ "fromInboxId", "fromAddress", "to", "cc", "bcc", "renderedSubject", "renderedBodyHtml", "renderedBodyText", "attachments", "missingAttachments", "suppressedRecipients", "missingVariables" ], "patternProperties": { "^(?!(?:fromInboxId|fromAddress|to|cc|bcc|renderedSubject|renderedBodyHtml|renderedBodyText|attachments|missingAttachments|suppressedRecipients|missingVariables)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fromInboxId", "fromAddress", "to", "cc", "bcc", "renderedSubject", "renderedBodyHtml", "renderedBodyText", "attachments", "missingAttachments", "suppressedRecipients", "missingVariables" ] } }, "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "messageId", "threadId", "resolved", "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:messageId|threadId|resolved|preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "threadId", "resolved", "preview", "confirmationToken" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `uniboxMessages.getReplyPersonalization`: `GET /v1/workspaces/:workspaceId/unibox/messages/:messageId/reply-personalization` - `uniboxMessages.previewReply`: `POST /v1/workspaces/:workspaceId/unibox/messages/:messageId/reply-preview` ## provision_dialer_numbers Buy dialing numbers for the workspace or read the latest purchase's per-number progress. Use action provision (or omit action for existing callers) to start a purchase. Use action status to read the workspace's latest per-number provisioning progress; get_operation only reports the generic operation state. This spends the workspace's money with the carrier and cannot be undone by cancelling the operation — a number that has already been bought must be released instead. Numbers are bought per country under a configured regulatory bundle; check the provisioning options first. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: dialer:manage_numbers_self, dialer:manage_numbers, dialer:read Risk: costly; confirmation: explicit; 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" }, "action": { "type": "string", "enum": [ "provision", "status" ] }, "provision": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 1, "maximum": 10 }, "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "areaCode": { "$ref": "#/$defs/AreaCode" }, "assignedUserId": { "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" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/$defs/E164PhoneNumber" }, "minItems": 1, "maxItems": 10 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count|countryCode|areaCode|assignedUserId|phoneNumbers)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "countryCode", "areaCode", "assignedUserId", "phoneNumbers" ] } } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|action|provision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "provision" ] }, "$defs": { "AreaCode": { "type": "string", "pattern": "^\\d{3}$" }, "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" } } } ``` ### 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" }, "action": { "type": "string", "enum": [ "provision", "status" ] }, "provision": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 1, "maximum": 10 }, "countryCode": { "type": "string", "enum": [ "US", "CA", "GB", "AU", "NZ" ] }, "areaCode": { "$ref": "#/$defs/AreaCode" }, "assignedUserId": { "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" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/$defs/E164PhoneNumber" }, "minItems": 1, "maxItems": 10 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count|countryCode|areaCode|assignedUserId|phoneNumbers)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "countryCode", "areaCode", "assignedUserId", "phoneNumbers" ] } } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|action|provision)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "provision" ] }, "$defs": { "AreaCode": { "type": "string", "pattern": "^\\d{3}$" }, "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "statusUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] }, "acceptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "message": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "completed" ], "patternProperties": { "^(?!(?:completed|total|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "completed", "total", "message" ] } }, "canCancel": { "type": "boolean" } }, "required": [ "id", "statusUrl", "state", "acceptedAt", "canCancel" ], "patternProperties": { "^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "statusUrl", "state", "acceptedAt", "progress", "canCancel" ] } }, { "type": "object", "properties": { "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] }, "runId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "step": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "requestedNumbers": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "candidateNumbers": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "orderedNumbers": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "provisionedNumbers": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "numberStates": { "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "pending", "provisioning", "provisioned", "failed" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "phoneNumber", "status", "progress", "error" ], "patternProperties": { "^(?!(?:phoneNumber|status|progress|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phoneNumber", "status", "progress", "error" ] } } }, "currentNumber": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "runId", "step", "progress", "requestedNumbers", "candidateNumbers", "orderedNumbers", "provisionedNumbers", "numberStates", "currentNumber", "reason", "error" ], "patternProperties": { "^(?!(?:state|runId|step|progress|requestedNumbers|candidateNumbers|orderedNumbers|provisionedNumbers|numberStates|currentNumber|reason|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "runId", "step", "progress", "requestedNumbers", "candidateNumbers", "orderedNumbers", "provisionedNumbers", "numberStates", "currentNumber", "reason", "error" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "statusUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] }, "acceptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "message": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "completed" ], "patternProperties": { "^(?!(?:completed|total|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "completed", "total", "message" ] } }, "canCancel": { "type": "boolean" } }, "required": [ "id", "statusUrl", "state", "acceptedAt", "canCancel" ], "patternProperties": { "^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "statusUrl", "state", "acceptedAt", "progress", "canCancel" ] } }, { "type": "object", "properties": { "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] }, "runId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "step": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "requestedNumbers": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "candidateNumbers": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "orderedNumbers": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "provisionedNumbers": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "numberStates": { "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "pending", "provisioning", "provisioned", "failed" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "phoneNumber", "status", "progress", "error" ], "patternProperties": { "^(?!(?:phoneNumber|status|progress|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phoneNumber", "status", "progress", "error" ] } } }, "currentNumber": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "runId", "step", "progress", "requestedNumbers", "candidateNumbers", "orderedNumbers", "provisionedNumbers", "numberStates", "currentNumber", "reason", "error" ], "patternProperties": { "^(?!(?:state|runId|step|progress|requestedNumbers|candidateNumbers|orderedNumbers|provisionedNumbers|numberStates|currentNumber|reason|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "runId", "step", "progress", "requestedNumbers", "candidateNumbers", "orderedNumbers", "provisionedNumbers", "numberStates", "currentNumber", "reason", "error" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `dialerNumbers.provision`: `POST /v1/workspaces/:workspaceId/dialer/numbers/provision` - `dialerNumbers.provisionStatus`: `GET /v1/workspaces/:workspaceId/dialer/numbers/provision-status` ## push_lead_to_attio Push one lead to its Attio person record now, as a durable job — creating the person on first push and refreshing it afterwards. Use when the customer asks for a specific lead to appear or refresh in Attio, including while automatic lead sync is off. Poll the handle, then read the lead link for the record URL or the last push error. Requires a usable Attio connection with record write grants. It never runs inline and never pushes more than the one lead; bulk imports never auto-push. Scopes: integration:update, lead: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" }, "leadId": { "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", "leadId" ], "patternProperties": { "^(?!(?:workspaceId|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "leadId" ] } } ``` ### 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" }, "leadId": { "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", "leadId" ], "patternProperties": { "^(?!(?:workspaceId|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "leadId" ] } } ``` ### Output schema (structuredContent) ```json { "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" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Underlying API operations - `attioOutbound.pushLead`: `POST /v1/workspaces/:workspaceId/integrations/attio/leads/:leadId/push` ## read_account_security Read your own email, sign-in connections, password availability, MFA policy and sessions; no secrets are returned. Before a change, or to check actual provider state after completing a security handoff. Requires the account owner's human OAuth session. Cannot inspect other users or use organization API keys. Delegated agents must hand off to their human. Scopes: workspace:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "emailVerified": { "type": "boolean" }, "passwordSet": { "type": "boolean" }, "mfaEnabled": { "type": "boolean" }, "passwordAuthEnabled": { "type": "boolean" }, "mfaAvailable": { "type": "boolean" }, "mfaRequired": { "type": "boolean" }, "passwordMinimumLength": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "connections": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "provider": { "$ref": "#/$defs/NonEmptyString" }, "email": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] } }, "required": [ "id", "provider", "email" ], "patternProperties": { "^(?!(?:id|provider|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "provider", "email" ] } } }, "sessions": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "current": { "type": "boolean" }, "ipAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userAgent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] } }, "required": [ "id", "current", "ipAddress", "userAgent", "createdAt", "expiresAt" ], "patternProperties": { "^(?!(?:id|current|ipAddress|userAgent|createdAt|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "current", "ipAddress", "userAgent", "createdAt", "expiresAt" ] } } }, "connectionManagementSupported": { "type": "boolean" }, "passwordRemovalSupported": { "type": "boolean" }, "emailChangeUnlinksConnections": { "type": "boolean" } }, "required": [ "email", "emailVerified", "passwordSet", "mfaEnabled", "passwordAuthEnabled", "mfaAvailable", "mfaRequired", "passwordMinimumLength", "connections", "sessions", "connectionManagementSupported", "passwordRemovalSupported", "emailChangeUnlinksConnections" ], "patternProperties": { "^(?!(?:email|emailVerified|passwordSet|mfaEnabled|passwordAuthEnabled|mfaAvailable|mfaRequired|passwordMinimumLength|connections|sessions|connectionManagementSupported|passwordRemovalSupported|emailChangeUnlinksConnections)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "emailVerified", "passwordSet", "mfaEnabled", "passwordAuthEnabled", "mfaAvailable", "mfaRequired", "passwordMinimumLength", "connections", "sessions", "connectionManagementSupported", "passwordRemovalSupported", "emailChangeUnlinksConnections" ] }, "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Underlying API operations - `accountSecurity.read`: `GET /v1/me/security` ## read_api_key_issuance List every Organization and Workspace the caller can see, with the permissions it may put on a restricted personal API key in each (ADR-075). Use before proposing a restricted key or before manage_api_key_grants narrows a key's access. Never creates a key or returns a secret. A full-account key needs no issuance check. Scopes: apiKey:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "organizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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": { "$ref": "#/$defs/LeadStoredText" }, "isOwner": { "type": "boolean" }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "permissions" ], "patternProperties": { "^(?!(?:permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "name": { "$ref": "#/$defs/LeadStoredText" }, "slug": { "$ref": "#/$defs/LeadStoredText" }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "name", "slug", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|name|slug|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "name", "slug", "permissions" ] } } } }, "required": [ "organizationId", "name", "isOwner", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|name|isOwner|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "name", "isOwner", "organizationPermissions", "allWorkspaces", "workspaces" ] } } }, "expiryOptions": { "type": "array", "items": { "type": "string", "enum": [ "30_days", "90_days", "365_days", "never" ] } }, "defaultExpiry": { "type": "string", "enum": [ "30_days", "90_days", "365_days", "never" ] } }, "required": [ "organizations", "expiryOptions", "defaultExpiry" ], "patternProperties": { "^(?!(?:organizations|expiryOptions|defaultExpiry)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizations", "expiryOptions", "defaultExpiry" ] }, "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 } } } ``` ### Underlying API operations - `personalApiKeys.issuance`: `GET /v1/me/api-key-issuance` ## read_api_keys Read the caller's own personal API keys (ADR-075): each key's name, access (full account or per-Organization grants), Organizations that blocked it, last use, and expiry. Use `list` or `get` to review what the person's keys can reach, before narrowing or revoking one. Never returns a secret and never shows other people's keys; for members' keys that can act in an Organization use read_organization_api_key_access. To create a key, hand the person `/account/api-keys` in the Scheduler Zero web app. Scopes: apiKey:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "get" ] }, "apiKeyId": { "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" ], "patternProperties": { "^(?!(?:action|apiKeyId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "apiKeyId" ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "list", "get" ] }, "apiKeyId": { "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" ], "patternProperties": { "^(?!(?:action|apiKeyId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "apiKeyId" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "apiKeys": { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "access": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "full" ] } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "type" ] } ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "restricted" ] } ] }, "organizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } } } }, "required": [ "type", "organizations" ], "patternProperties": { "^(?!(?:type|organizations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "organizations" ] } } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedOrganizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "organizationId", "organizationName", "blockedAt" ], "patternProperties": { "^(?!(?:organizationId|organizationName|blockedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "blockedAt" ] } } }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|description|access|prefix|blockedOrganizations|expiresAt|lastUsedAt|lastRotatedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ] } } } }, "required": [ "apiKeys" ], "patternProperties": { "^(?!(?:apiKeys)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "apiKeys" ] } ] } }, { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "access": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "full" ] } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "type" ] } ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "restricted" ] } ] }, "organizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } } } }, "required": [ "type", "organizations" ], "patternProperties": { "^(?!(?:type|organizations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "organizations" ] } } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedOrganizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "organizationId", "organizationName", "blockedAt" ], "patternProperties": { "^(?!(?:organizationId|organizationName|blockedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "blockedAt" ] } } }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|description|access|prefix|blockedOrganizations|expiresAt|lastUsedAt|lastRotatedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "apiKeys": { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "access": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "full" ] } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "type" ] } ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "restricted" ] } ] }, "organizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } } } }, "required": [ "type", "organizations" ], "patternProperties": { "^(?!(?:type|organizations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "organizations" ] } } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedOrganizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "organizationId", "organizationName", "blockedAt" ], "patternProperties": { "^(?!(?:organizationId|organizationName|blockedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "blockedAt" ] } } }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|description|access|prefix|blockedOrganizations|expiresAt|lastUsedAt|lastRotatedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ] } } } }, "required": [ "apiKeys" ], "patternProperties": { "^(?!(?:apiKeys)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "apiKeys" ] } ] } }, { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "description": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "access": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "full" ] } ] } }, "required": [ "type" ], "patternProperties": { "^(?!(?:type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "type" ] } ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "restricted" ] } ] }, "organizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } } } }, "required": [ "type", "organizations" ], "patternProperties": { "^(?!(?:type|organizations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "organizations" ] } } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedOrganizations": { "type": "array", "items": { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blockedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "organizationId", "organizationName", "blockedAt" ], "patternProperties": { "^(?!(?:organizationId|organizationName|blockedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "blockedAt" ] } } }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastRotatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|description|access|prefix|blockedOrganizations|expiresAt|lastUsedAt|lastRotatedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "access", "prefix", "blockedOrganizations", "expiresAt", "lastUsedAt", "lastRotatedAt", "createdAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `personalApiKeys.list`: `GET /v1/me/api-keys` - `personalApiKeys.get`: `GET /v1/me/api-keys/:apiKeyId` ## read_attio_records Read the workspace's Attio CRM and its local Attio state: probe the connection, browse lists, list entries, people, companies, attributes, and workspace members, preview what an import would write, and read saved field mappings, import records, outbound toggles, and a lead's CRM link. Use before proposing an import (to find the list or person and preview the email that would be chosen), to explain why a lead is or is not in Attio, and to ground any claim about which outbound writes are switched on. The cached_lists scope uses offset pagination: request up to 100 items (default 50) and continue at pagination.offset + pagination.limit while pagination.hasMore is true. Provider reads answer TemporarilyUnavailable while Attio is unconnected or awaiting reauthorization — that is a state to report, not an error to retry. The cached list catalog does not call Attio; sync it through manage_attio_mappings when it looks stale. A lead link of null means not linked yet, including while a creation is in flight. This never writes anything, locally or in Attio. Scopes: integration:read, lead:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "scope": { "type": "string", "enum": [ "connection_test", "mappings", "default_mapping", "cached_lists", "list_attributes", "list_entries", "list_entry", "people_attributes", "company_attributes", "people_search", "person", "person_import_preview", "workspace_members", "import_history", "import_details", "outbound_settings", "lead_link" ] }, "listId": { "$ref": "#/$defs/ProviderId" }, "entryId": { "$ref": "#/$defs/ProviderId" }, "recordId": { "$ref": "#/$defs/ProviderId" }, "importId": { "$ref": "#/$defs/AttioImportId" }, "leadId": { "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" }, "campaignId": { "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" }, "parentObject": { "type": "string", "enum": [ "people", "companies" ] }, "search": { "type": "string", "minLength": 1, "maxLength": 256 }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope|listId|entryId|recordId|importId|leadId|campaignId|parentObject|search|emailStrategy|offset|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "listId", "entryId", "recordId", "importId", "leadId", "campaignId", "parentObject", "search", "emailStrategy", "offset", "limit" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "AttioImportId": { "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" } } } ``` ### 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" }, "scope": { "type": "string", "enum": [ "connection_test", "mappings", "default_mapping", "cached_lists", "list_attributes", "list_entries", "list_entry", "people_attributes", "company_attributes", "people_search", "person", "person_import_preview", "workspace_members", "import_history", "import_details", "outbound_settings", "lead_link" ] }, "listId": { "$ref": "#/$defs/ProviderId" }, "entryId": { "$ref": "#/$defs/ProviderId" }, "recordId": { "$ref": "#/$defs/ProviderId" }, "importId": { "$ref": "#/$defs/AttioImportId" }, "leadId": { "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" }, "campaignId": { "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" }, "parentObject": { "type": "string", "enum": [ "people", "companies" ] }, "search": { "type": "string", "minLength": 1, "maxLength": 256 }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope|listId|entryId|recordId|importId|leadId|campaignId|parentObject|search|emailStrategy|offset|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "listId", "entryId", "recordId", "importId", "leadId", "campaignId", "parentObject", "search", "emailStrategy", "offset", "limit" ] }, "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "AttioImportId": { "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" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ProviderId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "AttioConnectionTestResult": { "anyOf": [ { "type": "object", "properties": { "status": { "anyOf": [ { "type": "string", "enum": [ "connected" ] } ] }, "providerWorkspaceId": { "$ref": "#/$defs/ProviderId" }, "providerWorkspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "grantedScopes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 } }, "required": [ "status", "providerWorkspaceId", "providerWorkspaceName", "grantedScopes" ], "patternProperties": { "^(?!(?:status|providerWorkspaceId|providerWorkspaceName|grantedScopes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "providerWorkspaceId", "providerWorkspaceName", "grantedScopes" ] } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "not_connected", "reauthorization_required", "provider_unreachable" ] } }, "required": [ "status" ], "patternProperties": { "^(?!(?:status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "status" ] } ] } } ] }, "AttioFieldMappingId": { "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" }, "AttioFieldMappingRules": { "type": "object", "additionalProperties": true, "minProperties": 0, "maxProperties": 200 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "AttioFieldMapping": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttioFieldMappingId" }, "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" }, "name": { "$ref": "#/$defs/ShortText" }, "rules": { "$ref": "#/$defs/AttioFieldMappingRules" }, "emailStrategy": { "type": "string", "enum": [ "first", "work", "personal", "ask" ] }, "duplicateBehavior": { "type": "string", "enum": [ "skip", "update" ] }, "isDefault": { "type": "boolean" }, "providerWorkspaceId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "rules", "emailStrategy", "duplicateBehavior", "isDefault", "providerWorkspaceId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|rules|emailStrategy|duplicateBehavior|isDefault|providerWorkspaceId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "rules", "emailStrategy", "duplicateBehavior", "isDefault", "providerWorkspaceId", "createdAt", "updatedAt" ] } }, "AttioDefaultFieldMapping": { "anyOf": [ { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "saved" ] } ] }, "mapping": { "$ref": "#/$defs/AttioFieldMapping" } }, "required": [ "kind", "mapping" ], "patternProperties": { "^(?!(?:kind|mapping)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "mapping" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "suggested" ] } ] }, "rules": { "$ref": "#/$defs/AttioFieldMappingRules" } }, "required": [ "kind", "rules" ], "patternProperties": { "^(?!(?:kind|rules)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "rules" ] } } ] }, "AttioCachedList": { "type": "object", "properties": { "listId": { "$ref": "#/$defs/ProviderId" }, "name": { "$ref": "#/$defs/ShortText" }, "parentObject": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "entryCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "lastSyncedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "listId", "name", "parentObject", "entryCount", "lastSyncedAt" ], "patternProperties": { "^(?!(?:listId|name|parentObject|entryCount|lastSyncedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "listId", "name", "parentObject", "entryCount", "lastSyncedAt" ] } }, "AttioAttribute": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ProviderId" }, "title": { "$ref": "#/$defs/ShortText" }, "apiSlug": { "$ref": "#/$defs/ShortText" }, "type": { "$ref": "#/$defs/ShortText" }, "isRequired": { "type": "boolean" }, "isMultiselect": { "type": "boolean" }, "isWritable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "id", "title", "apiSlug", "type", "isRequired", "isMultiselect", "isWritable" ], "patternProperties": { "^(?!(?:id|title|apiSlug|type|isRequired|isMultiselect|isWritable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "title", "apiSlug", "type", "isRequired", "isMultiselect", "isWritable" ] } }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "AttioRecordValues": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" }, "minProperties": 0, "maxProperties": 1000 }, "AttioListEntry": { "type": "object", "properties": { "entryId": { "$ref": "#/$defs/ProviderId" }, "recordId": { "$ref": "#/$defs/ProviderId" }, "createdAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "values": { "$ref": "#/$defs/AttioRecordValues" } }, "required": [ "entryId", "recordId", "createdAt", "values" ], "patternProperties": { "^(?!(?:entryId|recordId|createdAt|values)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "entryId", "recordId", "createdAt", "values" ] } }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "AttioPersonSummary": { "type": "object", "properties": { "recordId": { "$ref": "#/$defs/ProviderId" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "emails": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyRecordId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] } }, "required": [ "recordId", "name", "firstName", "lastName", "emails", "jobTitle", "companyRecordId" ], "patternProperties": { "^(?!(?:recordId|name|firstName|lastName|emails|jobTitle|companyRecordId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recordId", "name", "firstName", "lastName", "emails", "jobTitle", "companyRecordId" ] } }, "AttioCompany": { "type": "object", "properties": { "recordId": { "$ref": "#/$defs/ProviderId" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "domain": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "values": { "$ref": "#/$defs/AttioRecordValues" } }, "required": [ "recordId", "name", "domain", "websiteUrl", "values" ], "patternProperties": { "^(?!(?:recordId|name|domain|websiteUrl|values)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recordId", "name", "domain", "websiteUrl", "values" ] } }, "AttioPerson": { "type": "object", "properties": { "recordId": { "$ref": "#/$defs/ProviderId" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "emails": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 }, "values": { "$ref": "#/$defs/AttioRecordValues" }, "company": { "anyOf": [ { "$ref": "#/$defs/AttioCompany" }, { "type": "null" } ] } }, "required": [ "recordId", "name", "firstName", "lastName", "emails", "values", "company" ], "patternProperties": { "^(?!(?:recordId|name|firstName|lastName|emails|values|company)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recordId", "name", "firstName", "lastName", "emails", "values", "company" ] } }, "AttioPersonImportPreview": { "type": "object", "properties": { "recordId": { "$ref": "#/$defs/ProviderId" }, "emails": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 }, "selectedEmail": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "hasMultipleEmails": { "type": "boolean" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "city": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "object", "properties": { "recordId": { "$ref": "#/$defs/ProviderId" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "domain": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "websiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "recordId", "name", "domain", "websiteUrl" ], "patternProperties": { "^(?!(?:recordId|name|domain|websiteUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recordId", "name", "domain", "websiteUrl" ] } }, { "type": "null" } ] }, "values": { "$ref": "#/$defs/AttioRecordValues" } }, "required": [ "recordId", "emails", "selectedEmail", "hasMultipleEmails", "firstName", "lastName", "jobTitle", "city", "region", "country", "company", "values" ], "patternProperties": { "^(?!(?:recordId|emails|selectedEmail|hasMultipleEmails|firstName|lastName|jobTitle|city|region|country|company|values)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recordId", "emails", "selectedEmail", "hasMultipleEmails", "firstName", "lastName", "jobTitle", "city", "region", "country", "company", "values" ] } }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "AttioWorkspaceMember": { "type": "object", "properties": { "memberId": { "$ref": "#/$defs/ProviderId" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "avatarUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "accessLevel": { "$ref": "#/$defs/ShortText" }, "active": { "type": "boolean" } }, "required": [ "memberId", "name", "firstName", "lastName", "email", "avatarUrl", "accessLevel", "active" ], "patternProperties": { "^(?!(?:memberId|name|firstName|lastName|email|avatarUrl|accessLevel|active)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "memberId", "name", "firstName", "lastName", "email", "avatarUrl", "accessLevel", "active" ] } }, "AttioWorkspaceMembersResult": { "anyOf": [ { "type": "object", "properties": { "status": { "anyOf": [ { "type": "string", "enum": [ "loaded" ] } ] }, "items": { "type": "array", "items": { "$ref": "#/$defs/AttioWorkspaceMember" }, "maxItems": 1000 } }, "required": [ "status", "items" ], "patternProperties": { "^(?!(?:status|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "items" ] } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "not_connected", "reauthorization_required", "provider_unreachable" ] } }, "required": [ "status" ], "patternProperties": { "^(?!(?:status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "status" ] } ] } } ] }, "AttioImportId": { "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" }, "AttioImportRecord": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttioImportId" }, "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" }, "status": { "type": "string", "enum": [ "pending", "in_progress", "completed", "partial", "failed" ] }, "sourceType": { "type": "string", "enum": [ "people", "list" ] }, "sourceId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "sourceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "campaignId": { "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" } ] }, "fieldMappingId": { "anyOf": [ { "$ref": "#/$defs/AttioFieldMappingId" }, { "type": "null" } ] }, "operationId": { "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" } ] }, "totalRecords": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "successCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "skippedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "startedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "status", "sourceType", "sourceId", "sourceName", "campaignId", "fieldMappingId", "operationId", "totalRecords", "successCount", "failedCount", "skippedCount", "startedAt", "completedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|workspaceId|status|sourceType|sourceId|sourceName|campaignId|fieldMappingId|operationId|totalRecords|successCount|failedCount|skippedCount|startedAt|completedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "status", "sourceType", "sourceId", "sourceName", "campaignId", "fieldMappingId", "operationId", "totalRecords", "successCount", "failedCount", "skippedCount", "startedAt", "completedAt", "createdAt" ] } }, "AttioImportDetail": { "type": "object", "properties": { "import": { "$ref": "#/$defs/AttioImportRecord" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "recordId": { "anyOf": [ { "$ref": "#/$defs/ProviderId" }, { "type": "null" } ] }, "email": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "error": { "$ref": "#/$defs/ShortText" } }, "required": [ "recordId", "email", "error" ], "patternProperties": { "^(?!(?:recordId|email|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recordId", "email", "error" ] } }, "maxItems": 100 } }, "required": [ "import", "errors" ], "patternProperties": { "^(?!(?:import|errors)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "import", "errors" ] } }, "AttioOutboundSettings": { "type": "object", "properties": { "pushLeads": { "type": "boolean" }, "pushCallNotes": { "type": "boolean" }, "pushReplyNotes": { "type": "boolean" }, "pushSendNotes": { "type": "boolean" } }, "required": [ "pushLeads", "pushCallNotes", "pushReplyNotes", "pushSendNotes" ], "patternProperties": { "^(?!(?:pushLeads|pushCallNotes|pushReplyNotes|pushSendNotes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "pushLeads", "pushCallNotes", "pushReplyNotes", "pushSendNotes" ] } }, "AttioOutboundSettingsResult": { "type": "object", "properties": { "connected": { "type": "boolean" }, "settings": { "$ref": "#/$defs/AttioOutboundSettings" } }, "required": [ "connected", "settings" ], "patternProperties": { "^(?!(?:connected|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "settings" ] } }, "AttioLeadLink": { "type": "object", "properties": { "provider": { "anyOf": [ { "type": "string", "enum": [ "attio" ] } ] }, "object": { "$ref": "#/$defs/ShortText" }, "recordId": { "$ref": "#/$defs/ProviderId" }, "externalUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "lastPushedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastPushError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "provider", "object", "recordId", "externalUrl", "lastPushedAt", "lastPushError" ], "patternProperties": { "^(?!(?:provider|object|recordId|externalUrl|lastPushedAt|lastPushError)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "object", "recordId", "externalUrl", "lastPushedAt", "lastPushError" ] } }, "AttioLeadLinkResult": { "type": "object", "properties": { "connected": { "type": "boolean" }, "providerWorkspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "settings": { "$ref": "#/$defs/AttioOutboundSettings" }, "link": { "anyOf": [ { "$ref": "#/$defs/AttioLeadLink" }, { "type": "null" } ] } }, "required": [ "connected", "providerWorkspaceName", "settings", "link" ], "patternProperties": { "^(?!(?:connected|providerWorkspaceName|settings|link)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "providerWorkspaceName", "settings", "link" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/AttioConnectionTestResult" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioFieldMapping" }, "maxItems": 200 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "$ref": "#/$defs/AttioDefaultFieldMapping" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioCachedList" }, "maxItems": 100 }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" } }, "required": [ "offset", "limit", "hasMore" ], "patternProperties": { "^(?!(?:offset|limit|hasMore)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "hasMore" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioAttribute" }, "maxItems": 1000 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioListEntry" }, "maxItems": 100 }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" } }, "required": [ "offset", "limit", "hasMore" ], "patternProperties": { "^(?!(?:offset|limit|hasMore)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "hasMore" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "$ref": "#/$defs/AttioListEntry" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioPersonSummary" }, "maxItems": 50 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "$ref": "#/$defs/AttioPerson" }, { "$ref": "#/$defs/AttioPersonImportPreview" }, { "$ref": "#/$defs/AttioWorkspaceMembersResult" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioImportRecord" }, "maxItems": 100 }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" } }, "required": [ "offset", "limit", "hasMore" ], "patternProperties": { "^(?!(?:offset|limit|hasMore)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "hasMore" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "$ref": "#/$defs/AttioImportDetail" }, { "$ref": "#/$defs/AttioOutboundSettingsResult" }, { "$ref": "#/$defs/AttioLeadLinkResult" } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/AttioConnectionTestResult" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioFieldMapping" }, "maxItems": 200 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "$ref": "#/$defs/AttioDefaultFieldMapping" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioCachedList" }, "maxItems": 100 }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" } }, "required": [ "offset", "limit", "hasMore" ], "patternProperties": { "^(?!(?:offset|limit|hasMore)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "hasMore" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioAttribute" }, "maxItems": 1000 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioListEntry" }, "maxItems": 100 }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" } }, "required": [ "offset", "limit", "hasMore" ], "patternProperties": { "^(?!(?:offset|limit|hasMore)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "hasMore" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "$ref": "#/$defs/AttioListEntry" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioPersonSummary" }, "maxItems": 50 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "$ref": "#/$defs/AttioPerson" }, { "$ref": "#/$defs/AttioPersonImportPreview" }, { "$ref": "#/$defs/AttioWorkspaceMembersResult" }, { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/AttioImportRecord" }, "maxItems": 100 }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" } }, "required": [ "offset", "limit", "hasMore" ], "patternProperties": { "^(?!(?:offset|limit|hasMore)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "hasMore" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "$ref": "#/$defs/AttioImportDetail" }, { "$ref": "#/$defs/AttioOutboundSettingsResult" }, { "$ref": "#/$defs/AttioLeadLinkResult" } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `attio.testConnection`: `GET /v1/workspaces/:workspaceId/integrations/attio/test` - `attioMappings.list`: `GET /v1/workspaces/:workspaceId/integrations/attio/mappings` - `attioMappings.getDefault`: `GET /v1/workspaces/:workspaceId/integrations/attio/mappings/default` - `attioBrowse.lists`: `GET /v1/workspaces/:workspaceId/integrations/attio/lists` - `attioBrowse.listAttributes`: `GET /v1/workspaces/:workspaceId/integrations/attio/lists/:listId/attributes` - `attioBrowse.listEntries`: `GET /v1/workspaces/:workspaceId/integrations/attio/lists/:listId/entries` - `attioBrowse.listEntry`: `GET /v1/workspaces/:workspaceId/integrations/attio/lists/:listId/entries/:entryId` - `attioBrowse.peopleAttributes`: `GET /v1/workspaces/:workspaceId/integrations/attio/people/attributes` - `attioBrowse.companyAttributes`: `GET /v1/workspaces/:workspaceId/integrations/attio/companies/attributes` - `attioBrowse.searchPeople`: `GET /v1/workspaces/:workspaceId/integrations/attio/people/search` - `attioBrowse.person`: `GET /v1/workspaces/:workspaceId/integrations/attio/people/:recordId` - `attioBrowse.personImportPreview`: `GET /v1/workspaces/:workspaceId/integrations/attio/people/:recordId/import-preview` - `attioBrowse.workspaceMembers`: `GET /v1/workspaces/:workspaceId/integrations/attio/workspace-members` - `attioImports.history`: `GET /v1/workspaces/:workspaceId/integrations/attio/imports` - `attioImports.details`: `GET /v1/workspaces/:workspaceId/integrations/attio/imports/:importId` - `attioOutbound.settings`: `GET /v1/workspaces/:workspaceId/integrations/attio/outbound-settings` - `attioOutbound.leadLink`: `GET /v1/workspaces/:workspaceId/integrations/attio/leads/:leadId/link` ## read_call_recordings Get a short-lived signed URL for a call's recording so it can be listened to or analysed inside the workspace. Use when a claim about a call needs the audio itself rather than its disposition or transcript summary. The URL is a real recording of a real customer conversation: do not forward it, do not embed it anywhere durable, and do not treat it as a share — publishing a recording is a separate, confirmed capability. A recording that is still being prepared reports as temporarily unavailable rather than serving the wrong audio. Scopes: dialer:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "callId": { "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", "callId" ], "patternProperties": { "^(?!(?:workspaceId|callId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "callId" ] } } ``` ### 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" }, "callId": { "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", "callId" ], "patternProperties": { "^(?!(?:workspaceId|callId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "callId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "url": { "$ref": "#/$defs/HttpUrl" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "url", "expiresAt" ], "patternProperties": { "^(?!(?:url|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "url", "expiresAt" ] }, "$defs": { "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$" } } } ``` ### Underlying API operations - `dialerRecordings.playbackUrl`: `GET /v1/workspaces/:workspaceId/dialer/calls/:callId/recording-url` ## read_campaign_analytics Read aggregate campaign performance: workspace totals, the workspace or per-campaign report with its daily send and reply series, one campaign's browser row, and the cohort values analytics can be filtered by. Use to ground any claim about how a campaign is performing. Workspace roll-ups exclude subsequences so a lead that branched is counted once; per-campaign reads include them, so a subsequence can still be measured on its own. It never returns lead-level, per-recipient, or message data — aggregates only. Reply counts are DISTINCT contacts classified by thread label, so they cannot be read back as a list of who replied. Scopes: analytics:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "scope": { "type": "string", "enum": [ "totals" ] }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "folderId": { "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", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope|campaignFilter|folderId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "campaignFilter", "folderId" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "report" ] }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "folderId": { "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" }, "startDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "recipientProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "senderTagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 100 }, "senderDomains": { "type": "array", "items": { "$ref": "#/$defs/DomainNameEncoded" }, "maxItems": 100 } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope|campaignFilter|folderId|startDate|endDate|senderProviders|recipientProviders|senderTagIds|senderDomains)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "campaignFilter", "folderId", "startDate", "endDate", "senderProviders", "recipientProviders", "senderTagIds", "senderDomains" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "report" ] }, "campaignId": { "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" }, "startDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "recipientProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "senderTagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 100 }, "senderDomains": { "type": "array", "items": { "$ref": "#/$defs/DomainNameEncoded" }, "maxItems": 100 } }, "required": [ "workspaceId", "scope", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|scope|campaignId|startDate|endDate|senderProviders|recipientProviders|senderTagIds|senderDomains)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "campaignId", "startDate", "endDate", "senderProviders", "recipientProviders", "senderTagIds", "senderDomains" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "row_stats" ] }, "campaignId": { "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", "scope", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|scope|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "campaignId" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "filters" ] } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope" ] } } ], "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "DomainNameEncoded": { "type": "string" } } } ``` ### 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" }, "scope": { "type": "string", "enum": [ "totals" ] }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "folderId": { "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", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|campaignFilter|folderId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "campaignFilter", "folderId" ] }, { "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" }, "scope": { "type": "string", "enum": [ "report" ] }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "folderId": { "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" }, "startDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "recipientProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "senderTagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 100 }, "senderDomains": { "type": "array", "items": { "$ref": "#/$defs/DomainNameEncoded" }, "maxItems": 100 } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|campaignFilter|folderId|startDate|endDate|senderProviders|recipientProviders|senderTagIds|senderDomains)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "campaignFilter", "folderId", "startDate", "endDate", "senderProviders", "recipientProviders", "senderTagIds", "senderDomains" ] }, { "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" }, "scope": { "type": "string", "enum": [ "report" ] }, "campaignId": { "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" }, "startDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endDate": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "recipientProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] }, "maxItems": 3 }, "senderTagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 100 }, "senderDomains": { "type": "array", "items": { "$ref": "#/$defs/DomainNameEncoded" }, "maxItems": 100 } }, "required": [ "workspaceId", "scope", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|campaignId|startDate|endDate|senderProviders|recipientProviders|senderTagIds|senderDomains)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "campaignId", "startDate", "endDate", "senderProviders", "recipientProviders", "senderTagIds", "senderDomains" ] }, { "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" }, "scope": { "type": "string", "enum": [ "row_stats" ] }, "campaignId": { "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", "scope", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "campaignId" ] }, { "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" }, "scope": { "type": "string", "enum": [ "filters" ] } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "DomainNameEncoded": { "type": "string" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "totalLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalMeetings": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "positiveReplyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "bounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "finishedRate": { "type": "number", "minimum": 0, "maximum": 100 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalLeads", "totalContacted", "totalMeetings", "replyRate", "positiveReplyRate", "bounceRate", "finishedRate" ], "patternProperties": { "^(?!(?:totalLeads|totalContacted|totalMeetings|replyRate|positiveReplyRate|bounceRate|finishedRate|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalLeads", "totalContacted", "totalMeetings", "replyRate", "positiveReplyRate", "bounceRate", "finishedRate", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "totalLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "leadsContactedPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "newLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCompletedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "finishedPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "replyRateWithOOO": { "type": "number", "minimum": 0, "maximum": 100 }, "replyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "positiveReplyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "bounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "unsubscribeRate": { "type": "number", "minimum": 0, "maximum": 100 }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unsubscribeCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "senderBounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "unclassifiedBounceRate": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "totalLeads", "totalEmailsSent", "totalLeadsContacted", "leadsContactedPercentage", "newLeadsContacted", "totalCompletedLeads", "finishedPercentage", "replyRateWithOOO", "replyRate", "positiveReplyRate", "bounceRate", "unsubscribeRate", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount", "unsubscribeCount" ], "patternProperties": { "^(?!(?:totalLeads|totalEmailsSent|totalLeadsContacted|leadsContactedPercentage|newLeadsContacted|totalCompletedLeads|finishedPercentage|replyRateWithOOO|replyRate|positiveReplyRate|bounceRate|unsubscribeRate|replyCountWithOOO|replyCount|positiveReplyCount|bounceCount|unsubscribeCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|recipientBounceRate|senderBounceRate|unclassifiedBounceRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalLeads", "totalEmailsSent", "totalLeadsContacted", "leadsContactedPercentage", "newLeadsContacted", "totalCompletedLeads", "finishedPercentage", "replyRateWithOOO", "replyRate", "positiveReplyRate", "bounceRate", "unsubscribeRate", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount", "unsubscribeCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "recipientBounceRate", "senderBounceRate", "unclassifiedBounceRate" ] } }, "dailyEmailSent": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "newLead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "newLead", "followUp" ], "patternProperties": { "^(?!(?:date|newLead|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "newLead", "followUp" ] } } }, "dailyMetrics": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount" ], "patternProperties": { "^(?!(?:date|replyCountWithOOO|replyCount|positiveReplyCount|bounceCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } } }, "required": [ "summary", "dailyEmailSent", "dailyMetrics" ], "patternProperties": { "^(?!(?:summary|dailyEmailSent|dailyMetrics)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyEmailSent", "dailyMetrics" ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "totalEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "newLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCompletedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRateWithOOO": { "type": "number", "minimum": 0, "maximum": 100 }, "replyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "outOfOfficeReplyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "automaticReplyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "positiveReplyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "bounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "openRate": { "type": "number", "minimum": 0, "maximum": 100 }, "clickRate": { "type": "number", "minimum": 0, "maximum": 100 }, "unsubscribeRate": { "type": "number", "minimum": 0, "maximum": 100 }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outOfOfficeReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "automaticReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "meetingsBooked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clickCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unsubscribeCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "senderBounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "unclassifiedBounceRate": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "totalEmailsSent", "totalLeadsContacted", "newLeadsContacted", "totalCompletedLeads", "replyRateWithOOO", "replyRate", "outOfOfficeReplyRate", "automaticReplyRate", "positiveReplyRate", "bounceRate", "openRate", "clickRate", "unsubscribeRate", "replyCountWithOOO", "replyCount", "outOfOfficeReplyCount", "automaticReplyCount", "positiveReplyCount", "meetingsBooked", "bounceCount", "openCount", "clickCount", "unsubscribeCount" ], "patternProperties": { "^(?!(?:totalEmailsSent|totalLeadsContacted|newLeadsContacted|totalCompletedLeads|replyRateWithOOO|replyRate|outOfOfficeReplyRate|automaticReplyRate|positiveReplyRate|bounceRate|openRate|clickRate|unsubscribeRate|replyCountWithOOO|replyCount|outOfOfficeReplyCount|automaticReplyCount|positiveReplyCount|meetingsBooked|bounceCount|openCount|clickCount|unsubscribeCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|recipientBounceRate|senderBounceRate|unclassifiedBounceRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalEmailsSent", "totalLeadsContacted", "newLeadsContacted", "totalCompletedLeads", "replyRateWithOOO", "replyRate", "outOfOfficeReplyRate", "automaticReplyRate", "positiveReplyRate", "bounceRate", "openRate", "clickRate", "unsubscribeRate", "replyCountWithOOO", "replyCount", "outOfOfficeReplyCount", "automaticReplyCount", "positiveReplyCount", "meetingsBooked", "bounceCount", "openCount", "clickCount", "unsubscribeCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "recipientBounceRate", "senderBounceRate", "unclassifiedBounceRate" ] } }, "dailyEmailSent": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "newLead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "newLead", "followUp" ], "patternProperties": { "^(?!(?:date|newLead|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "newLead", "followUp" ] } } }, "dailyMetrics": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clickCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount", "openCount", "clickCount" ], "patternProperties": { "^(?!(?:date|replyCountWithOOO|replyCount|positiveReplyCount|bounceCount|openCount|clickCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount", "openCount", "clickCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } } }, "required": [ "summary", "dailyEmailSent", "dailyMetrics" ], "patternProperties": { "^(?!(?:summary|dailyEmailSent|dailyMetrics)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyEmailSent", "dailyMetrics" ] } }, { "type": "object", "properties": { "inboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactedPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "finishedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "meetingsBooked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "completionPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "activeSubsequenceLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastSentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "inboxCount", "contactCount", "contactedCount", "contactedPercentage", "finishedLeads", "replyCount", "replyPercentage", "positiveReplyCount", "positiveReplyPercentage", "meetingsBooked", "completionPercentage", "activeSubsequenceLeads", "lastSentAt" ], "patternProperties": { "^(?!(?:inboxCount|contactCount|contactedCount|contactedPercentage|finishedLeads|replyCount|replyPercentage|positiveReplyCount|positiveReplyPercentage|meetingsBooked|completionPercentage|activeSubsequenceLeads|lastSentAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxCount", "contactCount", "contactedCount", "contactedPercentage", "finishedLeads", "replyCount", "replyPercentage", "positiveReplyCount", "positiveReplyPercentage", "meetingsBooked", "completionPercentage", "activeSubsequenceLeads", "lastSentAt" ] } }, { "type": "object", "properties": { "senderProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] } }, "recipientProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] } }, "senderTags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "senderDomains": { "type": "array", "items": { "$ref": "#/$defs/DomainName" } } }, "required": [ "senderProviders", "recipientProviders", "senderTags", "senderDomains" ], "patternProperties": { "^(?!(?:senderProviders|recipientProviders|senderTags|senderDomains)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderProviders", "recipientProviders", "senderTags", "senderDomains" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "totalLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalMeetings": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "positiveReplyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "bounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "finishedRate": { "type": "number", "minimum": 0, "maximum": 100 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalLeads", "totalContacted", "totalMeetings", "replyRate", "positiveReplyRate", "bounceRate", "finishedRate" ], "patternProperties": { "^(?!(?:totalLeads|totalContacted|totalMeetings|replyRate|positiveReplyRate|bounceRate|finishedRate|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalLeads", "totalContacted", "totalMeetings", "replyRate", "positiveReplyRate", "bounceRate", "finishedRate", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "totalLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "leadsContactedPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "newLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCompletedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "finishedPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "replyRateWithOOO": { "type": "number", "minimum": 0, "maximum": 100 }, "replyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "positiveReplyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "bounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "unsubscribeRate": { "type": "number", "minimum": 0, "maximum": 100 }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unsubscribeCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "senderBounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "unclassifiedBounceRate": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "totalLeads", "totalEmailsSent", "totalLeadsContacted", "leadsContactedPercentage", "newLeadsContacted", "totalCompletedLeads", "finishedPercentage", "replyRateWithOOO", "replyRate", "positiveReplyRate", "bounceRate", "unsubscribeRate", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount", "unsubscribeCount" ], "patternProperties": { "^(?!(?:totalLeads|totalEmailsSent|totalLeadsContacted|leadsContactedPercentage|newLeadsContacted|totalCompletedLeads|finishedPercentage|replyRateWithOOO|replyRate|positiveReplyRate|bounceRate|unsubscribeRate|replyCountWithOOO|replyCount|positiveReplyCount|bounceCount|unsubscribeCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|recipientBounceRate|senderBounceRate|unclassifiedBounceRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalLeads", "totalEmailsSent", "totalLeadsContacted", "leadsContactedPercentage", "newLeadsContacted", "totalCompletedLeads", "finishedPercentage", "replyRateWithOOO", "replyRate", "positiveReplyRate", "bounceRate", "unsubscribeRate", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount", "unsubscribeCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "recipientBounceRate", "senderBounceRate", "unclassifiedBounceRate" ] } }, "dailyEmailSent": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "newLead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "newLead", "followUp" ], "patternProperties": { "^(?!(?:date|newLead|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "newLead", "followUp" ] } } }, "dailyMetrics": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount" ], "patternProperties": { "^(?!(?:date|replyCountWithOOO|replyCount|positiveReplyCount|bounceCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } } }, "required": [ "summary", "dailyEmailSent", "dailyMetrics" ], "patternProperties": { "^(?!(?:summary|dailyEmailSent|dailyMetrics)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyEmailSent", "dailyMetrics" ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "totalEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "newLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCompletedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRateWithOOO": { "type": "number", "minimum": 0, "maximum": 100 }, "replyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "outOfOfficeReplyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "automaticReplyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "positiveReplyRate": { "type": "number", "minimum": 0, "maximum": 100 }, "bounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "openRate": { "type": "number", "minimum": 0, "maximum": 100 }, "clickRate": { "type": "number", "minimum": 0, "maximum": 100 }, "unsubscribeRate": { "type": "number", "minimum": 0, "maximum": 100 }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "outOfOfficeReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "automaticReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "meetingsBooked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clickCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unsubscribeCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "senderBounceRate": { "type": "number", "minimum": 0, "maximum": 100 }, "unclassifiedBounceRate": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "totalEmailsSent", "totalLeadsContacted", "newLeadsContacted", "totalCompletedLeads", "replyRateWithOOO", "replyRate", "outOfOfficeReplyRate", "automaticReplyRate", "positiveReplyRate", "bounceRate", "openRate", "clickRate", "unsubscribeRate", "replyCountWithOOO", "replyCount", "outOfOfficeReplyCount", "automaticReplyCount", "positiveReplyCount", "meetingsBooked", "bounceCount", "openCount", "clickCount", "unsubscribeCount" ], "patternProperties": { "^(?!(?:totalEmailsSent|totalLeadsContacted|newLeadsContacted|totalCompletedLeads|replyRateWithOOO|replyRate|outOfOfficeReplyRate|automaticReplyRate|positiveReplyRate|bounceRate|openRate|clickRate|unsubscribeRate|replyCountWithOOO|replyCount|outOfOfficeReplyCount|automaticReplyCount|positiveReplyCount|meetingsBooked|bounceCount|openCount|clickCount|unsubscribeCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|recipientBounceRate|senderBounceRate|unclassifiedBounceRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalEmailsSent", "totalLeadsContacted", "newLeadsContacted", "totalCompletedLeads", "replyRateWithOOO", "replyRate", "outOfOfficeReplyRate", "automaticReplyRate", "positiveReplyRate", "bounceRate", "openRate", "clickRate", "unsubscribeRate", "replyCountWithOOO", "replyCount", "outOfOfficeReplyCount", "automaticReplyCount", "positiveReplyCount", "meetingsBooked", "bounceCount", "openCount", "clickCount", "unsubscribeCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "recipientBounceRate", "senderBounceRate", "unclassifiedBounceRate" ] } }, "dailyEmailSent": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "newLead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "newLead", "followUp" ], "patternProperties": { "^(?!(?:date|newLead|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "newLead", "followUp" ] } } }, "dailyMetrics": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clickCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount", "openCount", "clickCount" ], "patternProperties": { "^(?!(?:date|replyCountWithOOO|replyCount|positiveReplyCount|bounceCount|openCount|clickCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount", "openCount", "clickCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } } }, "required": [ "summary", "dailyEmailSent", "dailyMetrics" ], "patternProperties": { "^(?!(?:summary|dailyEmailSent|dailyMetrics)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyEmailSent", "dailyMetrics" ] } }, { "type": "object", "properties": { "inboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactedPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "finishedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "meetingsBooked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "completionPercentage": { "type": "number", "minimum": 0, "maximum": 100 }, "activeSubsequenceLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastSentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "inboxCount", "contactCount", "contactedCount", "contactedPercentage", "finishedLeads", "replyCount", "replyPercentage", "positiveReplyCount", "positiveReplyPercentage", "meetingsBooked", "completionPercentage", "activeSubsequenceLeads", "lastSentAt" ], "patternProperties": { "^(?!(?:inboxCount|contactCount|contactedCount|contactedPercentage|finishedLeads|replyCount|replyPercentage|positiveReplyCount|positiveReplyPercentage|meetingsBooked|completionPercentage|activeSubsequenceLeads|lastSentAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxCount", "contactCount", "contactedCount", "contactedPercentage", "finishedLeads", "replyCount", "replyPercentage", "positiveReplyCount", "positiveReplyPercentage", "meetingsBooked", "completionPercentage", "activeSubsequenceLeads", "lastSentAt" ] } }, { "type": "object", "properties": { "senderProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] } }, "recipientProviders": { "type": "array", "items": { "type": "string", "enum": [ "google", "microsoft", "other" ] } }, "senderTags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "senderDomains": { "type": "array", "items": { "$ref": "#/$defs/DomainName" } } }, "required": [ "senderProviders", "recipientProviders", "senderTags", "senderDomains" ], "patternProperties": { "^(?!(?:senderProviders|recipientProviders|senderTags|senderDomains)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderProviders", "recipientProviders", "senderTags", "senderDomains" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaignAnalytics.totals`: `GET /v1/workspaces/:workspaceId/campaigns/analytics/totals` - `campaignAnalytics.workspaceReport`: `GET /v1/workspaces/:workspaceId/campaigns/analytics` - `campaignAnalytics.filterOptions`: `GET /v1/workspaces/:workspaceId/campaigns/analytics/filter-options` - `campaignAnalytics.rowStats`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/row-stats` - `campaignAnalytics.campaign`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/analytics` ## read_campaign_audience Read a campaign's audience and sequence state: contact pages and counts, timezone audits, the grouped step list, per-step stats, the full sequence document, reusable sequences and their enrollments, and subsequence branches. Choose an action and its required identifiers. Use reusable_sequences for Workspace discovery; other actions require a campaignId or sequenceId. Read current enrollment, layout, and revisions before proposing changes. It never returns step bodies' rendered output, contact credentials, or sends anything; use the write capabilities for changes. Scopes: campaign:read, lead:read, sequence:read, analytics:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "contacts" ] }, "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" }, "campaignId": { "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" }, "limit": { "type": "string" }, "offset": { "type": "string" } }, "required": [ "action", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|limit|offset)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "limit", "offset" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "contact_count" ] }, "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" }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "timezone_audit" ] }, "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" }, "campaignId": { "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" }, "sourceField": { "type": "string" } }, "required": [ "action", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|sourceField)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "sourceField" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "steps" ] }, "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" }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "step_count" ] }, "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" }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "step_stats" ] }, "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" }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "sequence_document" ] }, "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" }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "reusable_sequences" ] }, "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" }, "activeOnly": { "type": "string", "enum": [ "true", "false" ] } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|activeOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "activeOnly" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "sequence_enrollments" ] }, "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" }, "sequenceId": { "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", "workspaceId", "sequenceId" ], "patternProperties": { "^(?!(?:action|workspaceId|sequenceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "sequenceId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "subsequences" ] }, "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" }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] } } ] } ``` ### 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": [ "contacts" ] }, "campaignId": { "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" }, "limit": { "type": "string" }, "offset": { "type": "string" } }, "required": [ "action", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|limit|offset)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "limit", "offset" ] }, { "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": [ "contact_count" ] }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] }, { "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": [ "timezone_audit" ] }, "campaignId": { "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" }, "sourceField": { "type": "string" } }, "required": [ "action", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|sourceField)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "sourceField" ] }, { "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": [ "steps" ] }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] }, { "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": [ "step_count" ] }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] }, { "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": [ "step_stats" ] }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] }, { "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": [ "sequence_document" ] }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] }, { "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": [ "reusable_sequences" ] }, "activeOnly": { "type": "string", "enum": [ "true", "false" ] } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|activeOnly)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "activeOnly" ] }, { "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": [ "sequence_enrollments" ] }, "sequenceId": { "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", "workspaceId", "sequenceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|sequenceId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "sequenceId" ] }, { "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": [ "subsequences" ] }, "campaignId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId" ] }, { "enum": [ "workspaceId" ] } ] } } ] } ``` ### Output schema (structuredContent) ```json { "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "campaignLeads": { "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" }, "leadId": { "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" } ] }, "status": { "type": "string", "enum": [ "not_contacted", "contacted", "completed", "task_pending", "task_failed", "paused", "out_of_office", "bounced", "unsubscribed", "ladder_queued", "moved_to_subsequence" ] }, "currentPass": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pendingStepId": { "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" } ] }, "pendingStepPass": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "company": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyDomain": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "city": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": true } }, "required": [ "id", "leadId", "status", "currentPass", "pendingStepId", "pendingStepPass", "email", "firstName", "lastName", "company", "jobTitle", "companyDomain", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues" ], "patternProperties": { "^(?!(?:id|leadId|status|currentPass|pendingStepId|pendingStepPass|email|firstName|lastName|company|jobTitle|companyDomain|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "leadId", "status", "currentPass", "pendingStepId", "pendingStepPass", "email", "firstName", "lastName", "company", "jobTitle", "companyDomain", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues" ] } } }, "customFieldKeys": { "type": "array", "items": { "$ref": "#/$defs/LeadStoredText" } } }, "required": [ "campaignLeads", "customFieldKeys" ], "patternProperties": { "^(?!(?:campaignLeads|customFieldKeys)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignLeads", "customFieldKeys" ] } }, { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } }, { "type": "object", "properties": { "sourceField": { "type": "string" }, "summary": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "valid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "invalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "missing": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "total", "valid", "invalid", "missing" ], "patternProperties": { "^(?!(?:total|valid|invalid|missing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "valid", "invalid", "missing" ] } }, "contacts": { "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" }, "email": { "type": "string" }, "current": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "valid", "invalid", "missing" ] }, "resolved": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "email", "current", "source", "status", "resolved" ], "patternProperties": { "^(?!(?:id|email|current|source|status|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "email", "current", "source", "status", "resolved" ] } } } }, "required": [ "sourceField", "summary", "contacts" ], "patternProperties": { "^(?!(?:sourceField|summary|contacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sourceField", "summary", "contacts" ] } }, { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "email_content" ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "variants": { "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" }, "variantOrder": { "type": "integer", "minimum": 1 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "enabled": { "type": "boolean" }, "subject": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "saved" ] } }, "required": [ "id", "variantOrder", "revision", "enabled", "subject", "body", "status" ], "patternProperties": { "^(?!(?:id|variantOrder|revision|enabled|subject|body|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "variantOrder", "revision", "enabled", "subject", "body", "status" ] } } } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "type", "bodyFormat", "previousThreadSelection", "variants" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|type|bodyFormat|previousThreadSelection|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "type", "bodyFormat", "previousThreadSelection", "variants" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "manual_review" ] }, "notificationMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "notificationMessage" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "notificationMessage" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "connectionNote": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "connectionNote" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|connectionNote)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "connectionNote" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "subject", "body" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "subject", "body" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "phone_call" ] }, "script": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "script" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "script" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "text_message" ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "message", "mediaUrl" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "http_post_request" ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "url", "headers", "bodyTemplate" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaignId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "campaignName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "attio_task" ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } } ] } }, { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } }, { "type": "array", "items": { "type": "object", "properties": { "stepOrder": { "type": "integer", "minimum": 1 }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "variants": { "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" }, "stepOrder": { "type": "integer", "minimum": 1 }, "variantOrder": { "type": "integer", "minimum": 1 }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "repliedPercentage": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "positiveReplies": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveRepliesPercentage": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "opened": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openedPercentage": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "clicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clickedPercentage": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "stepOrder", "variantOrder", "name", "enabled", "sent", "replied", "repliedPercentage", "positiveReplies", "positiveRepliesPercentage", "opened", "openedPercentage", "clicked", "clickedPercentage" ], "patternProperties": { "^(?!(?:id|stepOrder|variantOrder|name|enabled|sent|replied|repliedPercentage|positiveReplies|positiveRepliesPercentage|opened|openedPercentage|clicked|clickedPercentage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepOrder", "variantOrder", "name", "enabled", "sent", "replied", "repliedPercentage", "positiveReplies", "positiveRepliesPercentage", "opened", "openedPercentage", "clicked", "clickedPercentage" ] } } }, "totalSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalReplied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPositiveReplies": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalOpened": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalClicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "stepOrder", "name", "enabled", "variants", "totalSent", "totalReplied", "totalPositiveReplies", "totalOpened", "totalClicked" ], "patternProperties": { "^(?!(?:stepOrder|name|enabled|variants|totalSent|totalReplied|totalPositiveReplies|totalOpened|totalClicked)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "stepOrder", "name", "enabled", "variants", "totalSent", "totalReplied", "totalPositiveReplies", "totalOpened", "totalClicked" ] } } }, { "type": "object", "properties": { "campaignId": { "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" }, "sequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "steps": { "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" }, "position": { "type": "integer", "minimum": 1 }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "waitFor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "variants": { "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" }, "variantOrder": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "content": { "$ref": "#/$defs/Union_" }, "plainText": { "type": "object", "properties": { "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body" ] } }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "variantOrder", "enabled", "revision", "content", "plainText", "updatedAt" ], "patternProperties": { "^(?!(?:id|variantOrder|enabled|revision|content|plainText|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "variantOrder", "enabled", "revision", "content", "plainText", "updatedAt" ] } } } }, "required": [ "id", "position", "type", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "revision", "updatedAt", "variants" ], "patternProperties": { "^(?!(?:id|position|type|waitFor|runMode|rearmAfterDays|bodyFormat|previousThreadSelection|enabled|revision|updatedAt|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "position", "type", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "revision", "updatedAt", "variants" ] } } } }, "required": [ "campaignId", "sequenceRevision", "initialDelayMinutes", "steps" ], "patternProperties": { "^(?!(?:campaignId|sequenceRevision|initialDelayMinutes|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "sequenceRevision", "initialDelayMinutes", "steps" ] } }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "sequence" ] }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stopOtherCampaignsOnEnroll": { "type": "boolean" }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "status", "kind", "initialDelayMinutes", "stopOtherCampaignsOnEnroll", "inboxIds", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|status|pauseContext|kind|initialDelayMinutes|stopOtherCampaignsOnEnroll|inboxIds|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "pauseContext", "kind", "initialDelayMinutes", "stopOtherCampaignsOnEnroll", "inboxIds", "createdAt", "updatedAt" ] } } }, { "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" }, "subsequenceCampaignId": { "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" }, "sourceContactId": { "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" } ] }, "childContactId": { "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" } ] }, "triggerType": { "type": "string", "enum": [ "manual", "reply", "workflow" ] }, "triggeredByUserId": { "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" } ] }, "matchedTriggerId": { "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" } ] }, "replyLabelId": { "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" } ] }, "sourceThreadId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pausedContactIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, { "type": "null" } ] }, "reengagedAfterUnsubscribeAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "enrolledAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "subsequenceCampaignId", "sourceContactId", "childContactId", "triggerType", "triggeredByUserId", "matchedTriggerId", "replyLabelId", "sourceThreadId", "pausedContactIds", "reengagedAfterUnsubscribeAt", "enrolledAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|subsequenceCampaignId|sourceContactId|childContactId|triggerType|triggeredByUserId|matchedTriggerId|replyLabelId|sourceThreadId|pausedContactIds|reengagedAfterUnsubscribeAt|enrolledAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "subsequenceCampaignId", "sourceContactId", "childContactId", "triggerType", "triggeredByUserId", "matchedTriggerId", "replyLabelId", "sourceThreadId", "pausedContactIds", "reengagedAfterUnsubscribeAt", "enrolledAt", "createdAt", "updatedAt" ] } } }, { "type": "object", "properties": { "subsequences": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "enrolledCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "triggers": { "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" }, "conditionType": { "type": "string", "enum": [ "reply_any", "reply_genuine", "reply_label", "reply_text" ] }, "replyLabelIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "textContains": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textNotContains": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "type": "boolean" } }, "required": [ "id", "conditionType", "replyLabelIds", "textContains", "textNotContains", "enabled" ], "patternProperties": { "^(?!(?:id|conditionType|replyLabelIds|textContains|textNotContains|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "conditionType", "replyLabelIds", "textContains", "textNotContains", "enabled" ] } } } }, "required": [ "id", "name", "status", "createdAt", "enrolledCount", "contactCount", "triggers" ], "patternProperties": { "^(?!(?:id|name|status|pauseContext|createdAt|enrolledCount|contactCount|triggers)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "pauseContext", "createdAt", "enrolledCount", "contactCount", "triggers" ] } } } }, "required": [ "subsequences" ], "patternProperties": { "^(?!(?:subsequences)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "subsequences" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "campaignLeads": { "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" }, "leadId": { "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" } ] }, "status": { "type": "string", "enum": [ "not_contacted", "contacted", "completed", "task_pending", "task_failed", "paused", "out_of_office", "bounced", "unsubscribed", "ladder_queued", "moved_to_subsequence" ] }, "currentPass": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pendingStepId": { "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" } ] }, "pendingStepPass": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "company": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyDomain": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "city": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": true } }, "required": [ "id", "leadId", "status", "currentPass", "pendingStepId", "pendingStepPass", "email", "firstName", "lastName", "company", "jobTitle", "companyDomain", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues" ], "patternProperties": { "^(?!(?:id|leadId|status|currentPass|pendingStepId|pendingStepPass|email|firstName|lastName|company|jobTitle|companyDomain|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "leadId", "status", "currentPass", "pendingStepId", "pendingStepPass", "email", "firstName", "lastName", "company", "jobTitle", "companyDomain", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues" ] } } }, "customFieldKeys": { "type": "array", "items": { "$ref": "#/$defs/LeadStoredText" } } }, "required": [ "campaignLeads", "customFieldKeys" ], "patternProperties": { "^(?!(?:campaignLeads|customFieldKeys)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignLeads", "customFieldKeys" ] } }, { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } }, { "type": "object", "properties": { "sourceField": { "type": "string" }, "summary": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "valid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "invalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "missing": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "total", "valid", "invalid", "missing" ], "patternProperties": { "^(?!(?:total|valid|invalid|missing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "valid", "invalid", "missing" ] } }, "contacts": { "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" }, "email": { "type": "string" }, "current": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "valid", "invalid", "missing" ] }, "resolved": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "email", "current", "source", "status", "resolved" ], "patternProperties": { "^(?!(?:id|email|current|source|status|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "email", "current", "source", "status", "resolved" ] } } } }, "required": [ "sourceField", "summary", "contacts" ], "patternProperties": { "^(?!(?:sourceField|summary|contacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sourceField", "summary", "contacts" ] } }, { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "email_content" ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "variants": { "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" }, "variantOrder": { "type": "integer", "minimum": 1 }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "enabled": { "type": "boolean" }, "subject": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "saved" ] } }, "required": [ "id", "variantOrder", "revision", "enabled", "subject", "body", "status" ], "patternProperties": { "^(?!(?:id|variantOrder|revision|enabled|subject|body|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "variantOrder", "revision", "enabled", "subject", "body", "status" ] } } } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "type", "bodyFormat", "previousThreadSelection", "variants" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|type|bodyFormat|previousThreadSelection|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "type", "bodyFormat", "previousThreadSelection", "variants" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "manual_review" ] }, "notificationMessage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "notificationMessage" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "notificationMessage" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "linked_in_connection_request" ] }, "connectionNote": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "connectionNote" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|connectionNote)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "connectionNote" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "linked_in_in_mail" ] }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "subject", "body" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "subject", "body" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "phone_call" ] }, "script": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "script" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "script" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "text_message" ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "message", "mediaUrl" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "http_post_request" ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "url", "headers", "bodyTemplate" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "heyreach_campaign" ] }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaignId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "campaignName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/NonEmptyString" }, "stepId": { "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" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "delayMinutes": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "enabled": { "type": "boolean" }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "dbId": { "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" }, "status": { "type": "string", "enum": [ "saved" ] }, "type": { "type": "string", "enum": [ "attio_task" ] }, "content": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ], "patternProperties": { "^(?!(?:id|stepId|revision|delayMinutes|enabled|runMode|rearmAfterDays|dbId|status|type|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "revision", "delayMinutes", "enabled", "runMode", "rearmAfterDays", "dbId", "status", "type", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } } ] } }, { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } }, { "type": "array", "items": { "type": "object", "properties": { "stepOrder": { "type": "integer", "minimum": 1 }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "variants": { "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" }, "stepOrder": { "type": "integer", "minimum": 1 }, "variantOrder": { "type": "integer", "minimum": 1 }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "repliedPercentage": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "positiveReplies": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveRepliesPercentage": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "opened": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openedPercentage": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "clicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clickedPercentage": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "id", "stepOrder", "variantOrder", "name", "enabled", "sent", "replied", "repliedPercentage", "positiveReplies", "positiveRepliesPercentage", "opened", "openedPercentage", "clicked", "clickedPercentage" ], "patternProperties": { "^(?!(?:id|stepOrder|variantOrder|name|enabled|sent|replied|repliedPercentage|positiveReplies|positiveRepliesPercentage|opened|openedPercentage|clicked|clickedPercentage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepOrder", "variantOrder", "name", "enabled", "sent", "replied", "repliedPercentage", "positiveReplies", "positiveRepliesPercentage", "opened", "openedPercentage", "clicked", "clickedPercentage" ] } } }, "totalSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalReplied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPositiveReplies": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalOpened": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalClicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "stepOrder", "name", "enabled", "variants", "totalSent", "totalReplied", "totalPositiveReplies", "totalOpened", "totalClicked" ], "patternProperties": { "^(?!(?:stepOrder|name|enabled|variants|totalSent|totalReplied|totalPositiveReplies|totalOpened|totalClicked)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "stepOrder", "name", "enabled", "variants", "totalSent", "totalReplied", "totalPositiveReplies", "totalOpened", "totalClicked" ] } } }, { "type": "object", "properties": { "campaignId": { "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" }, "sequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "steps": { "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" }, "position": { "type": "integer", "minimum": 1 }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "waitFor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "runMode": { "type": "string", "enum": [ "once", "after_days", "every_pass" ] }, "rearmAfterDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "previousThreadSelection": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all", "latest", "custom" ] }, "stepIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|stepIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "stepIds" ] } }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "variants": { "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" }, "variantOrder": { "type": "integer", "minimum": 1 }, "enabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "content": { "$ref": "#/$defs/Union_" }, "plainText": { "type": "object", "properties": { "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body" ] } }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "variantOrder", "enabled", "revision", "content", "plainText", "updatedAt" ], "patternProperties": { "^(?!(?:id|variantOrder|enabled|revision|content|plainText|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "variantOrder", "enabled", "revision", "content", "plainText", "updatedAt" ] } } } }, "required": [ "id", "position", "type", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "revision", "updatedAt", "variants" ], "patternProperties": { "^(?!(?:id|position|type|waitFor|runMode|rearmAfterDays|bodyFormat|previousThreadSelection|enabled|revision|updatedAt|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "position", "type", "waitFor", "runMode", "rearmAfterDays", "bodyFormat", "previousThreadSelection", "enabled", "revision", "updatedAt", "variants" ] } } } }, "required": [ "campaignId", "sequenceRevision", "initialDelayMinutes", "steps" ], "patternProperties": { "^(?!(?:campaignId|sequenceRevision|initialDelayMinutes|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "sequenceRevision", "initialDelayMinutes", "steps" ] } }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "sequence" ] }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "stopOtherCampaignsOnEnroll": { "type": "boolean" }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "status", "kind", "initialDelayMinutes", "stopOtherCampaignsOnEnroll", "inboxIds", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|status|pauseContext|kind|initialDelayMinutes|stopOtherCampaignsOnEnroll|inboxIds|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "pauseContext", "kind", "initialDelayMinutes", "stopOtherCampaignsOnEnroll", "inboxIds", "createdAt", "updatedAt" ] } } }, { "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" }, "subsequenceCampaignId": { "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" }, "sourceContactId": { "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" } ] }, "childContactId": { "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" } ] }, "triggerType": { "type": "string", "enum": [ "manual", "reply", "workflow" ] }, "triggeredByUserId": { "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" } ] }, "matchedTriggerId": { "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" } ] }, "replyLabelId": { "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" } ] }, "sourceThreadId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pausedContactIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, { "type": "null" } ] }, "reengagedAfterUnsubscribeAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "enrolledAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "subsequenceCampaignId", "sourceContactId", "childContactId", "triggerType", "triggeredByUserId", "matchedTriggerId", "replyLabelId", "sourceThreadId", "pausedContactIds", "reengagedAfterUnsubscribeAt", "enrolledAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|subsequenceCampaignId|sourceContactId|childContactId|triggerType|triggeredByUserId|matchedTriggerId|replyLabelId|sourceThreadId|pausedContactIds|reengagedAfterUnsubscribeAt|enrolledAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "subsequenceCampaignId", "sourceContactId", "childContactId", "triggerType", "triggeredByUserId", "matchedTriggerId", "replyLabelId", "sourceThreadId", "pausedContactIds", "reengagedAfterUnsubscribeAt", "enrolledAt", "createdAt", "updatedAt" ] } } }, { "type": "object", "properties": { "subsequences": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "enrolledCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "triggers": { "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" }, "conditionType": { "type": "string", "enum": [ "reply_any", "reply_genuine", "reply_label", "reply_text" ] }, "replyLabelIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "textContains": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "textNotContains": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enabled": { "type": "boolean" } }, "required": [ "id", "conditionType", "replyLabelIds", "textContains", "textNotContains", "enabled" ], "patternProperties": { "^(?!(?:id|conditionType|replyLabelIds|textContains|textNotContains|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "conditionType", "replyLabelIds", "textContains", "textNotContains", "enabled" ] } } } }, "required": [ "id", "name", "status", "createdAt", "enrolledCount", "contactCount", "triggers" ], "patternProperties": { "^(?!(?:id|name|status|pauseContext|createdAt|enrolledCount|contactCount|triggers)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "pauseContext", "createdAt", "enrolledCount", "contactCount", "triggers" ] } } } }, "required": [ "subsequences" ], "patternProperties": { "^(?!(?:subsequences)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "subsequences" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaignContacts.list`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/contacts` - `campaignContacts.count`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/contacts/count` - `campaignContacts.validateTimezones`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/contacts/validate-timezones` - `campaignSteps.list`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/steps` - `campaignSteps.count`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/steps/count` - `campaignSteps.stats`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/step-stats` - `campaignSteps.getSequence`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/sequence` - `campaignSequences.list`: `GET /v1/workspaces/:workspaceId/campaigns/sequences` - `campaignSequences.enrollments`: `GET /v1/workspaces/:workspaceId/campaigns/sequences/:sequenceId/enrollments` - `campaignSubsequences.list`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/subsequences` ## read_campaign_setup Read a workspace's campaigns and everything that describes how one is set up: its list row and current pause reason/context, inbox pool, custom fields, variable coverage, copy guidance, version history, and the public-holiday calendars a schedule can skip. Use before proposing any campaign change, so the plan is grounded in the campaign's real steps, senders, and personalization coverage. Version detail includes authored copy in its stored JSON snapshot. It does not return contact records or sender credentials; use the audience tools for lead data. Scopes: campaign:read, inbox:read, lead:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "scope": { "type": "string", "enum": [ "list" ] }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "offset": { "type": "string" }, "limit": { "type": "string" }, "search": { "$ref": "#/$defs/ShortText" }, "status": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "all" ] } ] }, { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] } ] }, "folderId": { "anyOf": [ { "type": "string", "enum": [ "all", "root" ] }, { "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" } ] }, "tagId": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "all" ] } ] }, { "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" } ] }, "sortBy": { "type": "string", "enum": [ "name", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|scope|campaignFilter|offset|limit|search|status|folderId|tagId|sortBy|sortOrder)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "campaignFilter", "offset", "limit", "search", "status", "folderId", "tagId", "sortBy", "sortOrder" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "campaign" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "inboxes" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "custom_field_keys" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "variable_coverage" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "copy_context" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "explicit_inboxes" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "inbox_count" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "validate_copy" ] }, "payload": { "type": "object", "properties": { "subject": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "isFirstEmailStep": { "type": "boolean" } }, "required": [ "subject", "body", "isFirstEmailStep" ], "patternProperties": { "^(?!(?:subject|body|isFirstEmailStep)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body", "isFirstEmailStep" ] } } }, "required": [ "workspaceId", "campaignId", "scope", "payload" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "resolved_inboxes" ] }, "draft": { "type": "string", "enum": [ "true", "false" ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 }, "tagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 50 } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope|draft|inboxIds|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "draft", "inboxIds", "tagIds" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "versions" ] }, "cursor": { "type": "string" }, "limit": { "type": "string" } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "cursor", "limit" ] } }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "version" ] }, "version": { "type": "string" } }, "required": [ "workspaceId", "campaignId", "scope", "version" ], "patternProperties": { "^(?!(?:workspaceId|campaignId|scope|version)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "version" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "holiday_calendar" ] }, "calendar": { "$ref": "#/$defs/HolidayCalendarCode" } }, "required": [ "workspaceId", "scope", "calendar" ], "patternProperties": { "^(?!(?:workspaceId|scope|calendar)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "calendar" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "holiday_range" ] }, "holidayScope": { "type": "string", "enum": [ "selected", "all" ] }, "calendar": { "$ref": "#/$defs/HolidayCalendarCode" }, "from": { "$ref": "#/$defs/LocalDate" }, "to": { "$ref": "#/$defs/LocalDate" } }, "required": [ "workspaceId", "scope", "holidayScope", "from", "to" ], "patternProperties": { "^(?!(?:workspaceId|scope|holidayScope|calendar|from|to)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "holidayScope", "calendar", "from", "to" ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "HolidayCalendarCode": { "type": "string", "pattern": "^[A-Z]{2}$" }, "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } ``` ### 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" }, "scope": { "type": "string", "enum": [ "list" ] }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "offset": { "type": "string" }, "limit": { "type": "string" }, "search": { "$ref": "#/$defs/ShortText" }, "status": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "all" ] } ] }, { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] } ] }, "folderId": { "anyOf": [ { "type": "string", "enum": [ "all", "root" ] }, { "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" } ] }, "tagId": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "all" ] } ] }, { "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" } ] }, "sortBy": { "type": "string", "enum": [ "name", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|campaignFilter|offset|limit|search|status|folderId|tagId|sortBy|sortOrder)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "campaignFilter", "offset", "limit", "search", "status", "folderId", "tagId", "sortBy", "sortOrder" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "campaign" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "inboxes" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "custom_field_keys" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "variable_coverage" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "copy_context" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "explicit_inboxes" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "inbox_count" ] } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "validate_copy" ] }, "payload": { "type": "object", "properties": { "subject": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "isFirstEmailStep": { "type": "boolean" } }, "required": [ "subject", "body", "isFirstEmailStep" ], "patternProperties": { "^(?!(?:subject|body|isFirstEmailStep)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body", "isFirstEmailStep" ] } } }, "required": [ "workspaceId", "campaignId", "scope", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "resolved_inboxes" ] }, "draft": { "type": "string", "enum": [ "true", "false" ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 }, "tagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 50 } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|draft|inboxIds|tagIds)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "draft", "inboxIds", "tagIds" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "versions" ] }, "cursor": { "type": "string" }, "limit": { "type": "string" } }, "required": [ "workspaceId", "campaignId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|cursor|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "cursor", "limit" ] }, { "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" }, "campaignId": { "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" }, "scope": { "type": "string", "enum": [ "version" ] }, "version": { "type": "string" } }, "required": [ "workspaceId", "campaignId", "scope", "version" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|version)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "campaignId", "scope", "version" ] }, { "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" }, "scope": { "type": "string", "enum": [ "holiday_calendar" ] }, "calendar": { "$ref": "#/$defs/HolidayCalendarCode" } }, "required": [ "workspaceId", "scope", "calendar" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|calendar)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "calendar" ] }, { "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" }, "scope": { "type": "string", "enum": [ "holiday_range" ] }, "holidayScope": { "type": "string", "enum": [ "selected", "all" ] }, "calendar": { "$ref": "#/$defs/HolidayCalendarCode" }, "from": { "$ref": "#/$defs/LocalDate" }, "to": { "$ref": "#/$defs/LocalDate" } }, "required": [ "workspaceId", "scope", "holidayScope", "from", "to" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|holidayScope|calendar|from|to)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "holidayScope", "calendar", "from", "to" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "HolidayCalendarCode": { "type": "string", "pattern": "^[A-Z]{2}$" }, "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "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@]+$" }, "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "HolidayCalendarCode": { "type": "string", "pattern": "^[A-Z]{2}$" }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "AuthoredCampaignSnapshot": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "folderId": { "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" } ] }, "tags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "status", "folderId", "tags", "sentCount", "replyCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|status|pauseContext|folderId|tags|sentCount|replyCount|bounceCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "pauseContext", "folderId", "tags", "sentCount", "replyCount", "bounceCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "createdAt", "updatedAt" ] } } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "offset", "limit", "total" ], "patternProperties": { "^(?!(?:offset|limit|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "total" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "campaign": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "kind": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "currentVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "status", "kind", "currentVersion", "inboxCount", "contactCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|status|pauseContext|kind|currentVersion|inboxCount|contactCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "status", "pauseContext", "kind", "currentVersion", "inboxCount", "contactCount", "createdAt", "updatedAt" ] } }, "steps": { "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" }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "enabled": { "type": "boolean" } }, "required": [ "id", "type", "enabled" ], "patternProperties": { "^(?!(?:id|type|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "enabled" ] } } }, "parentCampaignId": { "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" } ] }, "folderId": { "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" } ] }, "scheduleProfileId": { "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" } ] }, "tags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "settings": { "type": "object", "properties": { "newLeadPriority": { "type": "integer", "minimum": 0, "maximum": 100 }, "espMatchMode": { "type": "string", "enum": [ "off", "match_then_spill", "match_only" ] }, "opportunityValue": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stopSendingOnReply": { "type": "boolean" }, "continueSendingOnAutomaticReply": { "type": "boolean" }, "defaultDelayDaysForAutomaticReply": { "type": "integer", "exclusiveMinimum": 0 }, "stopSendingOnSameDomainReply": { "type": "boolean" }, "openRateTracking": { "type": "boolean" }, "unsubscribeLink": { "type": "boolean" }, "addUnsubscribedLeadsToBlockList": { "type": "boolean" }, "sendAsPlainText": { "type": "boolean" }, "sendRiskyEmails": { "type": "boolean" }, "skipSegEmails": { "type": "boolean" }, "autoPauseOnHighBounceRate": { "type": "boolean" }, "continueOnSoftBounce": { "type": "boolean" }, "softBounceMonitoringDays": { "type": "integer", "minimum": 1, "maximum": 30 }, "highBounceRateThreshold": { "type": "integer", "minimum": 0, "maximum": 100 }, "fallbackSendingForRemovedInboxes": { "type": "boolean" }, "fallbackSendingForErroredInboxes": { "type": "boolean" }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "waterfallEnabled": { "type": "boolean" }, "waterfallPassGapDays": { "type": "integer", "minimum": 1, "maximum": 90 }, "waterfallResponseFreeze": { "type": "string", "enum": [ "freeze_ladder", "contact_only" ] }, "quotedChainAttribution": { "type": "string", "enum": [ "current_sender", "original" ] }, "ignoreInboxSendLimits": { "type": "boolean" }, "ccEmails": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, { "type": "null" } ] }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] } }, "required": [ "newLeadPriority", "espMatchMode", "opportunityValue", "stopSendingOnReply", "continueSendingOnAutomaticReply", "defaultDelayDaysForAutomaticReply", "stopSendingOnSameDomainReply", "openRateTracking", "unsubscribeLink", "addUnsubscribedLeadsToBlockList", "sendAsPlainText", "sendRiskyEmails", "skipSegEmails", "autoPauseOnHighBounceRate", "continueOnSoftBounce", "softBounceMonitoringDays", "highBounceRateThreshold", "fallbackSendingForRemovedInboxes", "fallbackSendingForErroredInboxes", "dailyCapPerRecipientDomain", "waterfallEnabled", "waterfallPassGapDays", "waterfallResponseFreeze", "quotedChainAttribution", "ignoreInboxSendLimits", "ccEmails", "initialDelayMinutes" ], "patternProperties": { "^(?!(?:newLeadPriority|espMatchMode|opportunityValue|stopSendingOnReply|continueSendingOnAutomaticReply|defaultDelayDaysForAutomaticReply|stopSendingOnSameDomainReply|openRateTracking|unsubscribeLink|addUnsubscribedLeadsToBlockList|sendAsPlainText|sendRiskyEmails|skipSegEmails|autoPauseOnHighBounceRate|continueOnSoftBounce|softBounceMonitoringDays|highBounceRateThreshold|fallbackSendingForRemovedInboxes|fallbackSendingForErroredInboxes|dailyCapPerRecipientDomain|waterfallEnabled|waterfallPassGapDays|waterfallResponseFreeze|quotedChainAttribution|ignoreInboxSendLimits|ccEmails|initialDelayMinutes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "newLeadPriority", "espMatchMode", "opportunityValue", "stopSendingOnReply", "continueSendingOnAutomaticReply", "defaultDelayDaysForAutomaticReply", "stopSendingOnSameDomainReply", "openRateTracking", "unsubscribeLink", "addUnsubscribedLeadsToBlockList", "sendAsPlainText", "sendRiskyEmails", "skipSegEmails", "autoPauseOnHighBounceRate", "continueOnSoftBounce", "softBounceMonitoringDays", "highBounceRateThreshold", "fallbackSendingForRemovedInboxes", "fallbackSendingForErroredInboxes", "dailyCapPerRecipientDomain", "waterfallEnabled", "waterfallPassGapDays", "waterfallResponseFreeze", "quotedChainAttribution", "ignoreInboxSendLimits", "ccEmails", "initialDelayMinutes" ] } }, "schedule": { "type": "object", "properties": { "campaignId": { "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" }, "scheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scheduleProfileId": { "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" } ] }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpDailyIncrement": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpCompletedSendingDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "effectiveMaxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ], "patternProperties": { "^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ] } }, "customFieldKeys": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "sequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "campaign", "steps" ], "patternProperties": { "^(?!(?:campaign|steps|parentCampaignId|folderId|scheduleProfileId|tags|settings|schedule|customFieldKeys|sequenceRevision|initialDelayMinutes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaign", "steps", "parentCampaignId", "folderId", "scheduleProfileId", "tags", "settings", "schedule", "customFieldKeys", "sequenceRevision", "initialDelayMinutes" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "campaignId": { "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "campaignId", "inboxId" ], "patternProperties": { "^(?!(?:campaignId|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "inboxId" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "campaignId": { "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" }, "keys": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "campaignId", "keys" ], "patternProperties": { "^(?!(?:campaignId|keys)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "keys" ] } }, { "type": "object", "properties": { "campaignId": { "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" }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coverage": { "type": "array", "items": { "type": "object", "properties": { "variable": { "$ref": "#/$defs/ShortText" }, "nonEmpty": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "state": { "type": "string", "enum": [ "all", "some", "none" ] } }, "required": [ "variable", "nonEmpty", "state" ], "patternProperties": { "^(?!(?:variable|nonEmpty|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "variable", "nonEmpty", "state" ] } } }, "sender": { "anyOf": [ { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coverage": { "type": "array", "items": { "type": "object", "properties": { "variable": { "$ref": "#/$defs/ShortText" }, "nonEmpty": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "state": { "type": "string", "enum": [ "all", "some", "none" ] } }, "required": [ "variable", "nonEmpty", "state" ], "patternProperties": { "^(?!(?:variable|nonEmpty|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "variable", "nonEmpty", "state" ] } } } }, "required": [ "total", "coverage" ], "patternProperties": { "^(?!(?:total|coverage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "coverage" ] } }, { "type": "null" } ] } }, "required": [ "campaignId", "total", "coverage", "sender" ], "patternProperties": { "^(?!(?:campaignId|total|coverage|sender)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "total", "coverage", "sender" ] } }, { "type": "object", "properties": { "campaignId": { "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" }, "syntax": { "type": "object", "properties": { "liquidTags": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "liquidFilters": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "editorNodeTypes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "unsupportedEditorNodeTypes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "spintaxCommands": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "spintaxMaximumOptions": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "examples": { "type": "array", "items": { "type": "object", "properties": { "label": { "$ref": "#/$defs/ShortText" }, "template": { "$ref": "#/$defs/Description" } }, "required": [ "label", "template" ], "patternProperties": { "^(?!(?:label|template)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "label", "template" ] } } }, "rules": { "type": "array", "items": { "$ref": "#/$defs/Description" } } }, "required": [ "liquidTags", "liquidFilters", "editorNodeTypes", "unsupportedEditorNodeTypes", "spintaxCommands", "spintaxMaximumOptions", "examples", "rules" ], "patternProperties": { "^(?!(?:liquidTags|liquidFilters|editorNodeTypes|unsupportedEditorNodeTypes|spintaxCommands|spintaxMaximumOptions|examples|rules)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "liquidTags", "liquidFilters", "editorNodeTypes", "unsupportedEditorNodeTypes", "spintaxCommands", "spintaxMaximumOptions", "examples", "rules" ] } }, "variables": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "type": { "type": "string", "enum": [ "lead", "custom", "platform", "organization", "thread", "sender", "unknown" ] }, "syntax": { "$ref": "#/$defs/ShortText" }, "description": { "$ref": "#/$defs/Description" }, "bodyOnly": { "type": "boolean" } }, "required": [ "name", "type", "syntax", "description", "bodyOnly" ], "patternProperties": { "^(?!(?:name|type|syntax|description|bodyOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "syntax", "description", "bodyOnly" ] } } }, "customFieldKeys": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "organizationVariableKeys": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "totalContacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coverageStatus": { "type": "string", "enum": [ "checked", "no_contacts" ] }, "senderCoverage": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "checked", "no_inboxes", "unavailable" ] }, "total": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "status", "total" ], "patternProperties": { "^(?!(?:status|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "total" ] } }, "isSubsequence": { "type": "boolean" }, "instruction": { "$ref": "#/$defs/Description" } }, "required": [ "campaignId", "syntax", "variables", "customFieldKeys", "organizationVariableKeys", "totalContacts", "coverageStatus", "senderCoverage", "isSubsequence", "instruction" ], "patternProperties": { "^(?!(?:campaignId|syntax|variables|customFieldKeys|organizationVariableKeys|totalContacts|coverageStatus|senderCoverage|isSubsequence|instruction)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "syntax", "variables", "customFieldKeys", "organizationVariableKeys", "totalContacts", "coverageStatus", "senderCoverage", "isSubsequence", "instruction" ] } }, { "type": "object", "properties": { "campaignId": { "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" }, "status": { "type": "string", "enum": [ "valid", "needs_review", "invalid" ] }, "syntaxValid": { "type": "boolean" }, "totalContacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coverageStatus": { "type": "string", "enum": [ "checked", "no_contacts" ] }, "senderCoverage": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "checked", "no_inboxes", "unavailable" ] }, "total": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "status", "total" ], "patternProperties": { "^(?!(?:status|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "total" ] } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "subject", "body" ] }, "syntaxValid": { "type": "boolean" }, "syntaxMessage": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "renderCase": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "variables": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "type": { "type": "string", "enum": [ "lead", "custom", "platform", "organization", "thread", "sender", "unknown" ] }, "isDefined": { "type": "boolean" }, "hasFallback": { "type": "boolean" }, "state": { "type": "string", "enum": [ "all", "some", "none", "undefined", "always", "nullable", "unknown", "no_inboxes", "no_prior_email", "body_only" ] }, "severity": { "type": "string", "enum": [ "ok", "warn", "error" ] }, "coverage": { "anyOf": [ { "type": "object", "properties": { "nonEmpty": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "nonEmpty", "total" ], "patternProperties": { "^(?!(?:nonEmpty|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "nonEmpty", "total" ] } }, { "type": "null" } ] } }, "required": [ "name", "type", "isDefined", "hasFallback", "state", "severity", "coverage" ], "patternProperties": { "^(?!(?:name|type|isDefined|hasFallback|state|severity|coverage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "isDefined", "hasFallback", "state", "severity", "coverage" ] } } } }, "required": [ "field", "syntaxValid", "syntaxMessage", "renderCase", "variables" ], "patternProperties": { "^(?!(?:field|syntaxValid|syntaxMessage|renderCase|variables)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "syntaxValid", "syntaxMessage", "renderCase", "variables" ] } } } }, "required": [ "campaignId", "status", "syntaxValid", "totalContacts", "coverageStatus", "senderCoverage", "fields" ], "patternProperties": { "^(?!(?:campaignId|status|syntaxValid|totalContacts|coverageStatus|senderCoverage|fields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "status", "syntaxValid", "totalContacts", "coverageStatus", "senderCoverage", "fields" ] } }, { "type": "object", "properties": { "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/ShortText" }, "status": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "emailAddress", "provider", "status" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "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/ShortText" }, "status": { "$ref": "#/$defs/ShortText" }, "explicit": { "type": "boolean" }, "viaTags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } } }, "required": [ "id", "emailAddress", "provider", "status", "explicit", "viaTags" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|explicit|viaTags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "explicit", "viaTags" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "campaignId": { "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" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": [ "baseline", "created", "duplicated", "details", "status", "launched", "settings", "schedule", "schedule_profile_propagated", "sequence", "step_toggle", "subsequence_triggers", "restored", "system" ] }, "campaignStatus": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "name": { "$ref": "#/$defs/ShortText" }, "stepCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "actor": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "api_key", "system" ] }, "userId": { "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" } ] }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "email": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] } }, "required": [ "type", "userId", "name", "email" ], "patternProperties": { "^(?!(?:type|userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "userId", "name", "email" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "campaignId", "version", "source", "campaignStatus", "name", "stepCount", "actor", "createdAt" ], "patternProperties": { "^(?!(?:campaignId|version|source|campaignStatus|name|stepCount|actor|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "version", "source", "campaignStatus", "name", "stepCount", "actor", "createdAt" ] } } }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextCursor": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "items", "totalCount", "nextCursor" ], "patternProperties": { "^(?!(?:items|totalCount|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount", "nextCursor" ] } }, { "type": "object", "properties": { "record": { "type": "object", "properties": { "campaignId": { "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" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": [ "baseline", "created", "duplicated", "details", "status", "launched", "settings", "schedule", "schedule_profile_propagated", "sequence", "step_toggle", "subsequence_triggers", "restored", "system" ] }, "campaignStatus": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "name": { "$ref": "#/$defs/ShortText" }, "stepCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "actor": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "api_key", "system" ] }, "userId": { "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" } ] }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "email": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] } }, "required": [ "type", "userId", "name", "email" ], "patternProperties": { "^(?!(?:type|userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "userId", "name", "email" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "campaignId", "version", "source", "campaignStatus", "name", "stepCount", "actor", "createdAt" ], "patternProperties": { "^(?!(?:campaignId|version|source|campaignStatus|name|stepCount|actor|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "version", "source", "campaignStatus", "name", "stepCount", "actor", "createdAt" ] } }, "snapshotSchemaVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contentHash": { "$ref": "#/$defs/ShortText" }, "snapshot": { "type": "object", "properties": { "schemaVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "campaignName": { "$ref": "#/$defs/ShortText" }, "campaignStatus": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "scheduleProfileName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "inboxes": { "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" } }, "required": [ "id", "emailAddress" ], "patternProperties": { "^(?!(?:id|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress" ] } } }, "tags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "steps": { "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" }, "stepId": { "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" }, "stepOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "variantOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "type": { "$ref": "#/$defs/ShortText" }, "enabled": { "type": "boolean" } }, "required": [ "id", "stepId", "stepOrder", "variantOrder", "type", "enabled" ], "patternProperties": { "^(?!(?:id|stepId|stepOrder|variantOrder|type|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "stepOrder", "variantOrder", "type", "enabled" ] } } }, "subsequenceTriggerCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "schemaVersion", "campaignName", "campaignStatus", "scheduleProfileName", "inboxes", "tags", "steps", "subsequenceTriggerCount" ], "patternProperties": { "^(?!(?:schemaVersion|campaignName|campaignStatus|scheduleProfileName|inboxes|tags|steps|subsequenceTriggerCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "campaignName", "campaignStatus", "scheduleProfileName", "inboxes", "tags", "steps", "subsequenceTriggerCount" ] } }, "authoredSnapshot": { "$ref": "#/$defs/AuthoredCampaignSnapshot" } }, "required": [ "record", "snapshotSchemaVersion", "contentHash", "snapshot" ], "patternProperties": { "^(?!(?:record|snapshotSchemaVersion|contentHash|snapshot|authoredSnapshot)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "record", "snapshotSchemaVersion", "contentHash", "snapshot", "authoredSnapshot" ] } }, { "type": "object", "properties": { "calendar": { "$ref": "#/$defs/HolidayCalendarCode" }, "year": { "type": "integer", "minimum": 1970, "maximum": 2999 }, "holidays": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "date", "name" ], "patternProperties": { "^(?!(?:date|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "name" ] } } } }, "required": [ "calendar", "year", "holidays" ], "patternProperties": { "^(?!(?:calendar|year|holidays)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "calendar", "year", "holidays" ] } }, { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "selected", "all" ] }, "days": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "observances": { "type": "array", "items": { "type": "object", "properties": { "calendarCode": { "$ref": "#/$defs/HolidayCalendarCode" }, "calendarName": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "calendarCode", "calendarName", "name" ], "patternProperties": { "^(?!(?:calendarCode|calendarName|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "calendarCode", "calendarName", "name" ] } } } }, "required": [ "date", "observances" ], "patternProperties": { "^(?!(?:date|observances)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "observances" ] } } } }, "required": [ "scope", "days" ], "patternProperties": { "^(?!(?:scope|days)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "scope", "days" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "folderId": { "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" } ] }, "tags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "status", "folderId", "tags", "sentCount", "replyCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|status|pauseContext|folderId|tags|sentCount|replyCount|bounceCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "pauseContext", "folderId", "tags", "sentCount", "replyCount", "bounceCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "createdAt", "updatedAt" ] } } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "offset", "limit", "total" ], "patternProperties": { "^(?!(?:offset|limit|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "total" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "campaign": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "pauseContext": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "manual" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "user" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "bounce_threshold" ] } ] }, "pausedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "source": { "anyOf": [ { "type": "string", "enum": [ "system" ] } ] }, "evidence": { "type": "object", "properties": { "thresholdPercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "bounceRatePercent": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scope": { "anyOf": [ { "type": "string", "enum": [ "campaign_lifetime" ] } ] } }, "required": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ], "patternProperties": { "^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "thresholdPercent", "bounceRatePercent", "sentCount", "bouncedCount", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount", "scope" ] } } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } }, { "type": "object", "properties": { "reason": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "pausedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "enum": [ "unknown" ] } ] }, "evidence": { "type": "null" } }, "required": [ "reason", "pausedAt", "source", "evidence" ], "patternProperties": { "^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reason", "pausedAt", "source", "evidence" ] } } ], "description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution." }, { "type": "null" } ] }, "kind": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "currentVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "status", "kind", "currentVersion", "inboxCount", "contactCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|status|pauseContext|kind|currentVersion|inboxCount|contactCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "status", "pauseContext", "kind", "currentVersion", "inboxCount", "contactCount", "createdAt", "updatedAt" ] } }, "steps": { "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" }, "type": { "type": "string", "enum": [ "email_content", "manual_review", "linked_in_connection_request", "linked_in_in_mail", "phone_call", "text_message", "http_post_request", "attio_task", "heyreach_campaign" ] }, "enabled": { "type": "boolean" } }, "required": [ "id", "type", "enabled" ], "patternProperties": { "^(?!(?:id|type|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "enabled" ] } } }, "parentCampaignId": { "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" } ] }, "folderId": { "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" } ] }, "scheduleProfileId": { "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" } ] }, "tags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "settings": { "type": "object", "properties": { "newLeadPriority": { "type": "integer", "minimum": 0, "maximum": 100 }, "espMatchMode": { "type": "string", "enum": [ "off", "match_then_spill", "match_only" ] }, "opportunityValue": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "stopSendingOnReply": { "type": "boolean" }, "continueSendingOnAutomaticReply": { "type": "boolean" }, "defaultDelayDaysForAutomaticReply": { "type": "integer", "exclusiveMinimum": 0 }, "stopSendingOnSameDomainReply": { "type": "boolean" }, "openRateTracking": { "type": "boolean" }, "unsubscribeLink": { "type": "boolean" }, "addUnsubscribedLeadsToBlockList": { "type": "boolean" }, "sendAsPlainText": { "type": "boolean" }, "sendRiskyEmails": { "type": "boolean" }, "skipSegEmails": { "type": "boolean" }, "autoPauseOnHighBounceRate": { "type": "boolean" }, "continueOnSoftBounce": { "type": "boolean" }, "softBounceMonitoringDays": { "type": "integer", "minimum": 1, "maximum": 30 }, "highBounceRateThreshold": { "type": "integer", "minimum": 0, "maximum": 100 }, "fallbackSendingForRemovedInboxes": { "type": "boolean" }, "fallbackSendingForErroredInboxes": { "type": "boolean" }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "waterfallEnabled": { "type": "boolean" }, "waterfallPassGapDays": { "type": "integer", "minimum": 1, "maximum": 90 }, "waterfallResponseFreeze": { "type": "string", "enum": [ "freeze_ladder", "contact_only" ] }, "quotedChainAttribution": { "type": "string", "enum": [ "current_sender", "original" ] }, "ignoreInboxSendLimits": { "type": "boolean" }, "ccEmails": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, { "type": "null" } ] }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 43200 }, { "type": "null" } ] } }, "required": [ "newLeadPriority", "espMatchMode", "opportunityValue", "stopSendingOnReply", "continueSendingOnAutomaticReply", "defaultDelayDaysForAutomaticReply", "stopSendingOnSameDomainReply", "openRateTracking", "unsubscribeLink", "addUnsubscribedLeadsToBlockList", "sendAsPlainText", "sendRiskyEmails", "skipSegEmails", "autoPauseOnHighBounceRate", "continueOnSoftBounce", "softBounceMonitoringDays", "highBounceRateThreshold", "fallbackSendingForRemovedInboxes", "fallbackSendingForErroredInboxes", "dailyCapPerRecipientDomain", "waterfallEnabled", "waterfallPassGapDays", "waterfallResponseFreeze", "quotedChainAttribution", "ignoreInboxSendLimits", "ccEmails", "initialDelayMinutes" ], "patternProperties": { "^(?!(?:newLeadPriority|espMatchMode|opportunityValue|stopSendingOnReply|continueSendingOnAutomaticReply|defaultDelayDaysForAutomaticReply|stopSendingOnSameDomainReply|openRateTracking|unsubscribeLink|addUnsubscribedLeadsToBlockList|sendAsPlainText|sendRiskyEmails|skipSegEmails|autoPauseOnHighBounceRate|continueOnSoftBounce|softBounceMonitoringDays|highBounceRateThreshold|fallbackSendingForRemovedInboxes|fallbackSendingForErroredInboxes|dailyCapPerRecipientDomain|waterfallEnabled|waterfallPassGapDays|waterfallResponseFreeze|quotedChainAttribution|ignoreInboxSendLimits|ccEmails|initialDelayMinutes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "newLeadPriority", "espMatchMode", "opportunityValue", "stopSendingOnReply", "continueSendingOnAutomaticReply", "defaultDelayDaysForAutomaticReply", "stopSendingOnSameDomainReply", "openRateTracking", "unsubscribeLink", "addUnsubscribedLeadsToBlockList", "sendAsPlainText", "sendRiskyEmails", "skipSegEmails", "autoPauseOnHighBounceRate", "continueOnSoftBounce", "softBounceMonitoringDays", "highBounceRateThreshold", "fallbackSendingForRemovedInboxes", "fallbackSendingForErroredInboxes", "dailyCapPerRecipientDomain", "waterfallEnabled", "waterfallPassGapDays", "waterfallResponseFreeze", "quotedChainAttribution", "ignoreInboxSendLimits", "ccEmails", "initialDelayMinutes" ] } }, "schedule": { "type": "object", "properties": { "campaignId": { "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" }, "scheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scheduleProfileId": { "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" } ] }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpDailyIncrement": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpCompletedSendingDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "effectiveMaxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ], "patternProperties": { "^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ] } }, "customFieldKeys": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "sequenceRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "initialDelayMinutes": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "campaign", "steps" ], "patternProperties": { "^(?!(?:campaign|steps|parentCampaignId|folderId|scheduleProfileId|tags|settings|schedule|customFieldKeys|sequenceRevision|initialDelayMinutes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaign", "steps", "parentCampaignId", "folderId", "scheduleProfileId", "tags", "settings", "schedule", "customFieldKeys", "sequenceRevision", "initialDelayMinutes" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "campaignId": { "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "campaignId", "inboxId" ], "patternProperties": { "^(?!(?:campaignId|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "inboxId" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "campaignId": { "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" }, "keys": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "campaignId", "keys" ], "patternProperties": { "^(?!(?:campaignId|keys)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "keys" ] } }, { "type": "object", "properties": { "campaignId": { "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" }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coverage": { "type": "array", "items": { "type": "object", "properties": { "variable": { "$ref": "#/$defs/ShortText" }, "nonEmpty": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "state": { "type": "string", "enum": [ "all", "some", "none" ] } }, "required": [ "variable", "nonEmpty", "state" ], "patternProperties": { "^(?!(?:variable|nonEmpty|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "variable", "nonEmpty", "state" ] } } }, "sender": { "anyOf": [ { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coverage": { "type": "array", "items": { "type": "object", "properties": { "variable": { "$ref": "#/$defs/ShortText" }, "nonEmpty": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "state": { "type": "string", "enum": [ "all", "some", "none" ] } }, "required": [ "variable", "nonEmpty", "state" ], "patternProperties": { "^(?!(?:variable|nonEmpty|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "variable", "nonEmpty", "state" ] } } } }, "required": [ "total", "coverage" ], "patternProperties": { "^(?!(?:total|coverage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "coverage" ] } }, { "type": "null" } ] } }, "required": [ "campaignId", "total", "coverage", "sender" ], "patternProperties": { "^(?!(?:campaignId|total|coverage|sender)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "total", "coverage", "sender" ] } }, { "type": "object", "properties": { "campaignId": { "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" }, "syntax": { "type": "object", "properties": { "liquidTags": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "liquidFilters": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "editorNodeTypes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "unsupportedEditorNodeTypes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "spintaxCommands": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "spintaxMaximumOptions": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "examples": { "type": "array", "items": { "type": "object", "properties": { "label": { "$ref": "#/$defs/ShortText" }, "template": { "$ref": "#/$defs/Description" } }, "required": [ "label", "template" ], "patternProperties": { "^(?!(?:label|template)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "label", "template" ] } } }, "rules": { "type": "array", "items": { "$ref": "#/$defs/Description" } } }, "required": [ "liquidTags", "liquidFilters", "editorNodeTypes", "unsupportedEditorNodeTypes", "spintaxCommands", "spintaxMaximumOptions", "examples", "rules" ], "patternProperties": { "^(?!(?:liquidTags|liquidFilters|editorNodeTypes|unsupportedEditorNodeTypes|spintaxCommands|spintaxMaximumOptions|examples|rules)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "liquidTags", "liquidFilters", "editorNodeTypes", "unsupportedEditorNodeTypes", "spintaxCommands", "spintaxMaximumOptions", "examples", "rules" ] } }, "variables": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "type": { "type": "string", "enum": [ "lead", "custom", "platform", "organization", "thread", "sender", "unknown" ] }, "syntax": { "$ref": "#/$defs/ShortText" }, "description": { "$ref": "#/$defs/Description" }, "bodyOnly": { "type": "boolean" } }, "required": [ "name", "type", "syntax", "description", "bodyOnly" ], "patternProperties": { "^(?!(?:name|type|syntax|description|bodyOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "syntax", "description", "bodyOnly" ] } } }, "customFieldKeys": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "organizationVariableKeys": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "totalContacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coverageStatus": { "type": "string", "enum": [ "checked", "no_contacts" ] }, "senderCoverage": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "checked", "no_inboxes", "unavailable" ] }, "total": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "status", "total" ], "patternProperties": { "^(?!(?:status|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "total" ] } }, "isSubsequence": { "type": "boolean" }, "instruction": { "$ref": "#/$defs/Description" } }, "required": [ "campaignId", "syntax", "variables", "customFieldKeys", "organizationVariableKeys", "totalContacts", "coverageStatus", "senderCoverage", "isSubsequence", "instruction" ], "patternProperties": { "^(?!(?:campaignId|syntax|variables|customFieldKeys|organizationVariableKeys|totalContacts|coverageStatus|senderCoverage|isSubsequence|instruction)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "syntax", "variables", "customFieldKeys", "organizationVariableKeys", "totalContacts", "coverageStatus", "senderCoverage", "isSubsequence", "instruction" ] } }, { "type": "object", "properties": { "campaignId": { "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" }, "status": { "type": "string", "enum": [ "valid", "needs_review", "invalid" ] }, "syntaxValid": { "type": "boolean" }, "totalContacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "coverageStatus": { "type": "string", "enum": [ "checked", "no_contacts" ] }, "senderCoverage": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "checked", "no_inboxes", "unavailable" ] }, "total": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "status", "total" ], "patternProperties": { "^(?!(?:status|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "total" ] } }, "fields": { "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "enum": [ "subject", "body" ] }, "syntaxValid": { "type": "boolean" }, "syntaxMessage": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "renderCase": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "variables": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "type": { "type": "string", "enum": [ "lead", "custom", "platform", "organization", "thread", "sender", "unknown" ] }, "isDefined": { "type": "boolean" }, "hasFallback": { "type": "boolean" }, "state": { "type": "string", "enum": [ "all", "some", "none", "undefined", "always", "nullable", "unknown", "no_inboxes", "no_prior_email", "body_only" ] }, "severity": { "type": "string", "enum": [ "ok", "warn", "error" ] }, "coverage": { "anyOf": [ { "type": "object", "properties": { "nonEmpty": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "nonEmpty", "total" ], "patternProperties": { "^(?!(?:nonEmpty|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "nonEmpty", "total" ] } }, { "type": "null" } ] } }, "required": [ "name", "type", "isDefined", "hasFallback", "state", "severity", "coverage" ], "patternProperties": { "^(?!(?:name|type|isDefined|hasFallback|state|severity|coverage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "isDefined", "hasFallback", "state", "severity", "coverage" ] } } } }, "required": [ "field", "syntaxValid", "syntaxMessage", "renderCase", "variables" ], "patternProperties": { "^(?!(?:field|syntaxValid|syntaxMessage|renderCase|variables)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "syntaxValid", "syntaxMessage", "renderCase", "variables" ] } } } }, "required": [ "campaignId", "status", "syntaxValid", "totalContacts", "coverageStatus", "senderCoverage", "fields" ], "patternProperties": { "^(?!(?:campaignId|status|syntaxValid|totalContacts|coverageStatus|senderCoverage|fields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "status", "syntaxValid", "totalContacts", "coverageStatus", "senderCoverage", "fields" ] } }, { "type": "object", "properties": { "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/ShortText" }, "status": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "emailAddress", "provider", "status" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "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/ShortText" }, "status": { "$ref": "#/$defs/ShortText" }, "explicit": { "type": "boolean" }, "viaTags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } } }, "required": [ "id", "emailAddress", "provider", "status", "explicit", "viaTags" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|explicit|viaTags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "explicit", "viaTags" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "campaignId": { "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" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": [ "baseline", "created", "duplicated", "details", "status", "launched", "settings", "schedule", "schedule_profile_propagated", "sequence", "step_toggle", "subsequence_triggers", "restored", "system" ] }, "campaignStatus": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "name": { "$ref": "#/$defs/ShortText" }, "stepCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "actor": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "api_key", "system" ] }, "userId": { "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" } ] }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "email": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] } }, "required": [ "type", "userId", "name", "email" ], "patternProperties": { "^(?!(?:type|userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "userId", "name", "email" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "campaignId", "version", "source", "campaignStatus", "name", "stepCount", "actor", "createdAt" ], "patternProperties": { "^(?!(?:campaignId|version|source|campaignStatus|name|stepCount|actor|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "version", "source", "campaignStatus", "name", "stepCount", "actor", "createdAt" ] } } }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextCursor": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "items", "totalCount", "nextCursor" ], "patternProperties": { "^(?!(?:items|totalCount|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount", "nextCursor" ] } }, { "type": "object", "properties": { "record": { "type": "object", "properties": { "campaignId": { "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" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": [ "baseline", "created", "duplicated", "details", "status", "launched", "settings", "schedule", "schedule_profile_propagated", "sequence", "step_toggle", "subsequence_triggers", "restored", "system" ] }, "campaignStatus": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "name": { "$ref": "#/$defs/ShortText" }, "stepCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "actor": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "user", "api_key", "system" ] }, "userId": { "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" } ] }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "email": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] } }, "required": [ "type", "userId", "name", "email" ], "patternProperties": { "^(?!(?:type|userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "userId", "name", "email" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "campaignId", "version", "source", "campaignStatus", "name", "stepCount", "actor", "createdAt" ], "patternProperties": { "^(?!(?:campaignId|version|source|campaignStatus|name|stepCount|actor|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "version", "source", "campaignStatus", "name", "stepCount", "actor", "createdAt" ] } }, "snapshotSchemaVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contentHash": { "$ref": "#/$defs/ShortText" }, "snapshot": { "type": "object", "properties": { "schemaVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "campaignName": { "$ref": "#/$defs/ShortText" }, "campaignStatus": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "scheduleProfileName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "inboxes": { "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" } }, "required": [ "id", "emailAddress" ], "patternProperties": { "^(?!(?:id|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress" ] } } }, "tags": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "color": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "color" ], "patternProperties": { "^(?!(?:id|name|color)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color" ] } } }, "steps": { "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" }, "stepId": { "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" }, "stepOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "variantOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "type": { "$ref": "#/$defs/ShortText" }, "enabled": { "type": "boolean" } }, "required": [ "id", "stepId", "stepOrder", "variantOrder", "type", "enabled" ], "patternProperties": { "^(?!(?:id|stepId|stepOrder|variantOrder|type|enabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "stepId", "stepOrder", "variantOrder", "type", "enabled" ] } } }, "subsequenceTriggerCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "schemaVersion", "campaignName", "campaignStatus", "scheduleProfileName", "inboxes", "tags", "steps", "subsequenceTriggerCount" ], "patternProperties": { "^(?!(?:schemaVersion|campaignName|campaignStatus|scheduleProfileName|inboxes|tags|steps|subsequenceTriggerCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "campaignName", "campaignStatus", "scheduleProfileName", "inboxes", "tags", "steps", "subsequenceTriggerCount" ] } }, "authoredSnapshot": { "$ref": "#/$defs/AuthoredCampaignSnapshot" } }, "required": [ "record", "snapshotSchemaVersion", "contentHash", "snapshot" ], "patternProperties": { "^(?!(?:record|snapshotSchemaVersion|contentHash|snapshot|authoredSnapshot)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "record", "snapshotSchemaVersion", "contentHash", "snapshot", "authoredSnapshot" ] } }, { "type": "object", "properties": { "calendar": { "$ref": "#/$defs/HolidayCalendarCode" }, "year": { "type": "integer", "minimum": 1970, "maximum": 2999 }, "holidays": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "date", "name" ], "patternProperties": { "^(?!(?:date|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "name" ] } } } }, "required": [ "calendar", "year", "holidays" ], "patternProperties": { "^(?!(?:calendar|year|holidays)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "calendar", "year", "holidays" ] } }, { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "selected", "all" ] }, "days": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "observances": { "type": "array", "items": { "type": "object", "properties": { "calendarCode": { "$ref": "#/$defs/HolidayCalendarCode" }, "calendarName": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "calendarCode", "calendarName", "name" ], "patternProperties": { "^(?!(?:calendarCode|calendarName|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "calendarCode", "calendarName", "name" ] } } } }, "required": [ "date", "observances" ], "patternProperties": { "^(?!(?:date|observances)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "observances" ] } } } }, "required": [ "scope", "days" ], "patternProperties": { "^(?!(?:scope|days)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "scope", "days" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaigns.list`: `GET /v1/workspaces/:workspaceId/campaigns` - `campaigns.get`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId` - `campaigns.inboxes`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/inboxes` - `campaigns.customFieldKeys`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/custom-field-keys` - `campaigns.variableCoverage`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/variable-coverage` - `campaigns.copyContext`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/copy-context` - `campaigns.validateCopy`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/validate-copy` - `campaignInboxes.listExplicit`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/inboxes/explicit` - `campaignInboxes.listResolved`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/inboxes/resolved` - `campaignInboxes.count`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/inboxes/count` - `campaignVersions.list`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/versions` - `campaignVersions.get`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/versions/:version` - `campaignHolidays.list`: `GET /v1/workspaces/:workspaceId/campaigns/holidays/:calendar` - `campaignHolidays.range`: `GET /v1/workspaces/:workspaceId/campaigns/holidays` ## read_cross_workspace_analytics Aggregate metrics, inbox accounts, and unibox filter dimensions across authorized workspaces. Use to report across every workspace the caller can read (ADR-051 at-origin filtering). Every row is re-authorized per workspace; it never exposes an unauthorized workspace. Scopes: workspace:read, analytics:read, unibox:read, inbox:read, campaign:read, replyLabel:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "overview" ] } ] }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "workspaceActivity": { "type": "string", "enum": [ "all", "active", "inactive" ] }, "campaignStatuses": { "type": "array", "items": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "maxItems": 5 }, "dateRange": { "type": "string", "enum": [ "7d", "30d", "90d", "all" ] }, "search": { "type": "string", "maxLength": 200 } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|campaignFilter|workspaceIds|workspaceActivity|campaignStatuses|dateRange|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "campaignFilter", "workspaceIds", "workspaceActivity", "campaignStatuses", "dateRange", "search" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "accounts" ] } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "maximum": 200 }, "search": { "type": "string", "maxLength": 200 }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "maxItems": 4 }, "warmup": { "type": "string", "enum": [ "all", "enabled", "disabled" ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|workspaceIds|offset|limit|search|provider|statuses|warmup)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "workspaceIds", "offset", "limit", "search", "provider", "statuses", "warmup" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "uniboxFilters" ] } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|workspaceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "workspaceIds" ] } } ], "$defs": { "ReadCrossWorkspaceAnalyticsInput": { "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "overview" ] } ] }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "workspaceActivity": { "type": "string", "enum": [ "all", "active", "inactive" ] }, "campaignStatuses": { "type": "array", "items": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "maxItems": 5 }, "dateRange": { "type": "string", "enum": [ "7d", "30d", "90d", "all" ] }, "search": { "type": "string", "maxLength": 200 } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|campaignFilter|workspaceIds|workspaceActivity|campaignStatuses|dateRange|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "campaignFilter", "workspaceIds", "workspaceActivity", "campaignStatuses", "dateRange", "search" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "accounts" ] } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "maximum": 200 }, "search": { "type": "string", "maxLength": 200 }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "maxItems": 4 }, "warmup": { "type": "string", "enum": [ "all", "enabled", "disabled" ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|workspaceIds|offset|limit|search|provider|statuses|warmup)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "workspaceIds", "offset", "limit", "search", "provider", "statuses", "warmup" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "uniboxFilters" ] } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|workspaceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "workspaceIds" ] } } ] } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "overview" ] } ] }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "workspaceActivity": { "type": "string", "enum": [ "all", "active", "inactive" ] }, "campaignStatuses": { "type": "array", "items": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "maxItems": 5 }, "dateRange": { "type": "string", "enum": [ "7d", "30d", "90d", "all" ] }, "search": { "type": "string", "maxLength": 200 } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|campaignFilter|workspaceIds|workspaceActivity|campaignStatuses|dateRange|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "campaignFilter", "workspaceIds", "workspaceActivity", "campaignStatuses", "dateRange", "search" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "accounts" ] } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "maximum": 200 }, "search": { "type": "string", "maxLength": 200 }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "maxItems": 4 }, "warmup": { "type": "string", "enum": [ "all", "enabled", "disabled" ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|workspaceIds|offset|limit|search|provider|statuses|warmup)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "workspaceIds", "offset", "limit", "search", "provider", "statuses", "warmup" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "uniboxFilters" ] } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|workspaceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "workspaceIds" ] } } ], "$defs": { "ReadCrossWorkspaceAnalyticsInput": { "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "overview" ] } ] }, "campaignFilter": { "anyOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode" ], "patternProperties": { "^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "ids" ], "patternProperties": { "^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "ids", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "terms" ], "patternProperties": { "^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "terms", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "rules" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "group" ] }, "match": { "type": "string", "enum": [ "any", "all" ] }, "rules": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "enum": [ "campaigns" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "folders" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tags" ] }, "ids": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "ids" ], "patternProperties": { "^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "ids", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "names" ] }, "terms": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "exclude": { "type": "boolean" } }, "required": [ "field", "terms" ], "patternProperties": { "^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "terms", "match", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "tagged" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } }, { "type": "object", "properties": { "field": { "type": "string", "enum": [ "filed" ] }, "value": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "required": [ "field", "value" ], "patternProperties": { "^(?!(?:field|value|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "value", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "exclude": { "type": "boolean" } }, "required": [ "field", "rules" ], "patternProperties": { "^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "field", "match", "rules", "exclude" ] } } ] }, "maxItems": 20, "minItems": 1 }, "match": { "type": "string", "enum": [ "any", "all" ] }, "excludeCampaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeTagIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeFolderIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "excludeNameContains": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "maxItems": 20 }, "taggedOnly": { "type": "boolean" }, "filedOnly": { "type": "boolean" } }, "required": [ "mode", "rules" ], "patternProperties": { "^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "mode", "rules", "match", "excludeCampaignIds", "excludeTagIds", "excludeFolderIds", "excludeNameContains", "taggedOnly", "filedOnly" ] } } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "workspaceActivity": { "type": "string", "enum": [ "all", "active", "inactive" ] }, "campaignStatuses": { "type": "array", "items": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "maxItems": 5 }, "dateRange": { "type": "string", "enum": [ "7d", "30d", "90d", "all" ] }, "search": { "type": "string", "maxLength": 200 } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|campaignFilter|workspaceIds|workspaceActivity|campaignStatuses|dateRange|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "campaignFilter", "workspaceIds", "workspaceActivity", "campaignStatuses", "dateRange", "search" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "accounts" ] } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "maximum": 200 }, "search": { "type": "string", "maxLength": 200 }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "maxItems": 4 }, "warmup": { "type": "string", "enum": [ "all", "enabled", "disabled" ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|workspaceIds|offset|limit|search|provider|statuses|warmup)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "workspaceIds", "offset", "limit", "search", "provider", "statuses", "warmup" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "uniboxFilters" ] } ] }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view|workspaceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "workspaceIds" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "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$" }, "WorkspaceRoleSlug": { "type": "string", "minLength": 1, "maxLength": 128 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "ReadCrossWorkspaceAnalyticsOutput": { "anyOf": [ { "type": "object", "properties": { "availableWorkspaces": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "role": { "$ref": "#/$defs/WorkspaceRoleSlug" }, "accessible": { "type": "boolean" } }, "required": [ "id", "name", "slug", "logo", "createdAt", "role", "accessible" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt|role|accessible)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt", "role", "accessible" ] } } }, "rows": { "type": "array", "items": { "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" }, "workspaceName": { "$ref": "#/$defs/ShortText" }, "workspaceSlug": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "workspaceLogo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "totalLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "activeCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pausedCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "completedCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "completedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "emailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "repliedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRate": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "workspaceId", "workspaceName", "workspaceSlug", "workspaceLogo", "totalLeads", "totalCampaigns", "activeCampaigns", "pausedCampaigns", "completedCampaigns", "contactedLeads", "completedLeads", "emailsSent", "repliedLeads", "replyRate" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|workspaceSlug|workspaceLogo|totalLeads|totalCampaigns|activeCampaigns|pausedCampaigns|completedCampaigns|contactedLeads|completedLeads|emailsSent|repliedLeads|replyRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "workspaceSlug", "workspaceLogo", "totalLeads", "totalCampaigns", "activeCampaigns", "pausedCampaigns", "completedCampaigns", "contactedLeads", "completedLeads", "emailsSent", "repliedLeads", "replyRate" ] } } }, "summary": { "type": "object", "properties": { "totalWorkspaces": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "activeCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pausedCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "completedCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "completedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "emailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "repliedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRate": { "type": "number", "minimum": 0, "maximum": 100 } }, "required": [ "totalWorkspaces", "totalLeads", "totalCampaigns", "activeCampaigns", "pausedCampaigns", "completedCampaigns", "contactedLeads", "completedLeads", "emailsSent", "repliedLeads", "replyRate" ], "patternProperties": { "^(?!(?:totalWorkspaces|totalLeads|totalCampaigns|activeCampaigns|pausedCampaigns|completedCampaigns|contactedLeads|completedLeads|emailsSent|repliedLeads|replyRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalWorkspaces", "totalLeads", "totalCampaigns", "activeCampaigns", "pausedCampaigns", "completedCampaigns", "contactedLeads", "completedLeads", "emailsSent", "repliedLeads", "replyRate" ] } } }, "required": [ "availableWorkspaces", "rows", "summary" ], "patternProperties": { "^(?!(?:availableWorkspaces|rows|summary)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "availableWorkspaces", "rows", "summary" ] } }, { "type": "object", "properties": { "availableWorkspaces": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "role": { "$ref": "#/$defs/WorkspaceRoleSlug" }, "accessible": { "type": "boolean" } }, "required": [ "id", "name", "slug", "logo", "createdAt", "role", "accessible" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt|role|accessible)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt", "role", "accessible" ] } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "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" }, "workspaceName": { "$ref": "#/$defs/ShortText" }, "workspaceSlug": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "dailySendingLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEnabled": { "type": "boolean" }, "warmupReputationScore": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupCurrentDailyVolume": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "dnsRecords": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "sentCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "workspaceId", "workspaceName", "workspaceSlug", "emailAddress", "provider", "status", "statusDetail", "senderFirstName", "senderLastName", "campaignName", "dailySendingLimit", "warmupEnabled", "warmupReputationScore", "warmupCurrentDailyVolume", "dnsRecords", "sentCount", "errorCount" ], "patternProperties": { "^(?!(?:id|workspaceId|workspaceName|workspaceSlug|emailAddress|provider|status|statusDetail|senderFirstName|senderLastName|campaignName|dailySendingLimit|warmupEnabled|warmupReputationScore|warmupCurrentDailyVolume|dnsRecords|sentCount|errorCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "workspaceName", "workspaceSlug", "emailAddress", "provider", "status", "statusDetail", "senderFirstName", "senderLastName", "campaignName", "dailySendingLimit", "warmupEnabled", "warmupReputationScore", "warmupCurrentDailyVolume", "dnsRecords", "sentCount", "errorCount" ] } } }, "stats": { "type": "object", "properties": { "totalAccounts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDomains": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalAccounts", "totalDomains", "warmupCount", "errorCount", "alertCount" ], "patternProperties": { "^(?!(?:totalAccounts|totalDomains|warmupCount|errorCount|alertCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalAccounts", "totalDomains", "warmupCount", "errorCount", "alertCount" ] } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "offset", "limit", "total" ], "patternProperties": { "^(?!(?:offset|limit|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "total" ] } } }, "required": [ "availableWorkspaces", "items", "stats", "pagination" ], "patternProperties": { "^(?!(?:availableWorkspaces|items|stats|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "availableWorkspaces", "items", "stats", "pagination" ] } }, { "type": "object", "properties": { "availableWorkspaces": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "role": { "$ref": "#/$defs/WorkspaceRoleSlug" }, "accessible": { "type": "boolean" } }, "required": [ "id", "name", "slug", "logo", "createdAt", "role", "accessible" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt|role|accessible)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt", "role", "accessible" ] } } }, "inboxes": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "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" }, "workspaceName": { "$ref": "#/$defs/ShortText" }, "warmupEnabled": { "type": "boolean" }, "warmupScore": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "id", "emailAddress", "provider", "status", "workspaceId", "workspaceName", "warmupEnabled", "warmupScore" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|workspaceId|workspaceName|warmupEnabled|warmupScore)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "workspaceId", "workspaceName", "warmupEnabled", "warmupScore" ] } } }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "archived", "completed" ] }, "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" }, "workspaceName": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name", "status", "workspaceId", "workspaceName" ], "patternProperties": { "^(?!(?:id|name|status|workspaceId|workspaceName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "workspaceId", "workspaceName" ] } } }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] }, "workspaceId": { "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" } ] }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type", "workspaceId", "workspaceName" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type|workspaceId|workspaceName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type", "workspaceId", "workspaceName" ] } } }, "members": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "organizationIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "userId", "name", "email", "image", "organizationIds" ], "patternProperties": { "^(?!(?:userId|name|email|image|organizationIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "organizationIds" ] } } } }, "required": [ "availableWorkspaces", "inboxes", "campaigns", "labels", "members" ], "patternProperties": { "^(?!(?:availableWorkspaces|inboxes|campaigns|labels|members)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "availableWorkspaces", "inboxes", "campaigns", "labels", "members" ] } } ] } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/ReadCrossWorkspaceAnalyticsOutput" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/ReadCrossWorkspaceAnalyticsOutput" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `me.allWorkspacesOverview`: `GET /v1/me/all-workspaces/overview` - `me.allWorkspacesAccounts`: `GET /v1/me/all-workspaces/accounts` - `me.allWorkspacesUniboxFilters`: `GET /v1/me/all-workspaces/unibox-filters` ## read_dialer_history Read what the dialer has done: call history and call detail, dialing sessions and their scoreboards, who holds a seat, and workspace or per-rep calling performance. When a person asks to start a call session, prepare and inspect the exact list with manage_call_lists, resolve the authorized workspace with resolve_workspace, then hand them the workspace-scoped call-list URL. After the person starts dialing, call this tool with scope `sessions`, match the returned callListId to the prepared list, then use that session id with scope `session` or `session_report` to follow status and results. Use to ground any claim about calling activity — how many dials a rep made, what a call was dispositioned as, whether a number is answering, how a session went. It never returns recording audio or transcript text; those need their own authorization. It cannot start a session, claim the next contact, place or control a call, drop a voicemail, or record a disposition — those remain the seated human's job in the browser softphone. It offers no agent start handle or automatic handoff. To hand a person the exact prepared list, resolve its workspace slug with resolve_workspace and open `/{workspace.slug}/dialer/lists/{callListId}` in the Scheduler Zero web app; the page selects that list, and the person must review the list and session settings, explicitly start the session, and grant microphone access. This opens the human workflow and does not start a call. Afterward, read scope `sessions`, match callListId, and use the returned session id for scope `session` or `session_report`. Scopes: dialer:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "scope": { "type": "string", "enum": [ "calls", "call", "call_status", "sessions", "session", "session_report", "seats", "own_seat", "own_forwarding", "stats" ] }, "callId": { "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" }, "sessionId": { "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" }, "calls": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "repUserId": { "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" }, "callListId": { "$ref": "#/$defs/CallListId" }, "disposition": { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "leadId": { "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" }, "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "patternProperties": { "^(?!(?:offset|limit|repUserId|callListId|disposition|direction|leadId|from|to)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "repUserId", "callListId", "disposition", "direction", "leadId", "from", "to" ] } }, "stats": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "workspace", "user", "self" ] }, "userId": { "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" }, "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "scope" ], "patternProperties": { "^(?!(?:scope|userId|from|to)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "scope", "userId", "from", "to" ] } } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope|callId|sessionId|calls|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "callId", "sessionId", "calls", "stats" ] }, "$defs": { "CallListId": { "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" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### 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" }, "scope": { "type": "string", "enum": [ "calls", "call", "call_status", "sessions", "session", "session_report", "seats", "own_seat", "own_forwarding", "stats" ] }, "callId": { "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" }, "sessionId": { "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" }, "calls": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "repUserId": { "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" }, "callListId": { "$ref": "#/$defs/CallListId" }, "disposition": { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "leadId": { "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" }, "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "patternProperties": { "^(?!(?:offset|limit|repUserId|callListId|disposition|direction|leadId|from|to)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "repUserId", "callListId", "disposition", "direction", "leadId", "from", "to" ] } }, "stats": { "type": "object", "properties": { "scope": { "type": "string", "enum": [ "workspace", "user", "self" ] }, "userId": { "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" }, "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "scope" ], "patternProperties": { "^(?!(?:scope|userId|from|to)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "scope", "userId", "from", "to" ] } } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope|callId|sessionId|calls|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "callId", "sessionId", "calls", "stats" ] }, "$defs": { "CallListId": { "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" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "CallListId": { "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" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "CallListContactId": { "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" }, "CallNote": { "type": "string", "maxLength": 5000 }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "CallTranscriptText": { "type": "string", "minLength": 1, "maxLength": 100000 }, "DialerSeatId": { "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": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "status": { "type": "string", "enum": [ "queued", "initiated", "ringing", "answered", "bridged", "completed", "no_answer", "busy", "failed", "canceled" ] }, "fromPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "toPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "counterpartyPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "repUserId": { "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" } ] }, "repName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "leadId": { "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" } ] }, "callListId": { "anyOf": [ { "$ref": "#/$defs/CallListId" }, { "type": "null" } ] }, "inboundRouteResult": { "anyOf": [ { "type": "string", "enum": [ "forwarded", "not_configured", "transfer_failed" ] }, { "type": "null" } ] }, "inboundForwardToE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "durationSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "effectiveDisposition": { "anyOf": [ { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, { "type": "null" } ] }, "dispositionJobStatus": { "anyOf": [ { "type": "string", "enum": [ "queued", "running", "completed", "failed", "canceled" ] }, { "type": "null" } ] }, "hasRecording": { "type": "boolean" }, "recordingPending": { "type": "boolean" }, "recordingFailed": { "type": "boolean" }, "hasTranscript": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "direction", "status", "fromPhoneE164", "toPhoneE164", "counterpartyPhoneE164", "repUserId", "repName", "leadId", "callListId", "inboundRouteResult", "inboundForwardToE164", "durationSeconds", "effectiveDisposition", "dispositionJobStatus", "hasRecording", "recordingPending", "recordingFailed", "hasTranscript", "createdAt" ], "patternProperties": { "^(?!(?:id|direction|status|fromPhoneE164|toPhoneE164|counterpartyPhoneE164|repUserId|repName|leadId|callListId|inboundRouteResult|inboundForwardToE164|durationSeconds|effectiveDisposition|dispositionJobStatus|hasRecording|recordingPending|recordingFailed|hasTranscript|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "direction", "status", "fromPhoneE164", "toPhoneE164", "counterpartyPhoneE164", "repUserId", "repName", "leadId", "callListId", "inboundRouteResult", "inboundForwardToE164", "durationSeconds", "effectiveDisposition", "dispositionJobStatus", "hasRecording", "recordingPending", "recordingFailed", "hasTranscript", "createdAt" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "call": { "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" }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "status": { "type": "string", "enum": [ "queued", "initiated", "ringing", "answered", "bridged", "completed", "no_answer", "busy", "failed", "canceled" ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "fromPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "toPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "counterpartyPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "dialerNumberId": { "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" } ] }, "repUserId": { "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" } ] }, "sessionId": { "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" } ] }, "callListId": { "anyOf": [ { "$ref": "#/$defs/CallListId" }, { "type": "null" } ] }, "callListContactId": { "anyOf": [ { "$ref": "#/$defs/CallListContactId" }, { "type": "null" } ] }, "leadId": { "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" } ] }, "amdResult": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "hangupCause": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "inboundRouteResult": { "anyOf": [ { "type": "string", "enum": [ "forwarded", "not_configured", "transfer_failed" ] }, { "type": "null" } ] }, "inboundForwardToE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "voicemailDropArmed": { "type": "boolean" }, "voicemailDropped": { "type": "boolean" }, "voicemailRecordingId": { "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" } ] }, "voicemailDropMode": { "anyOf": [ { "type": "string", "enum": [ "drop_and_end", "drop_and_talk" ] }, { "type": "null" } ] }, "recordingConsentState": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "recordingSkipReason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "consentDisclosurePlayed": { "type": "boolean" }, "consentJurisdiction": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "recording_stored", "transcribed", "completed", "failed" ] }, "repNote": { "anyOf": [ { "$ref": "#/$defs/CallNote" }, { "type": "null" } ] }, "startedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "answeredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "durationSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "connectedSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "direction", "status", "voiceProvider", "fromPhoneE164", "toPhoneE164", "counterpartyPhoneE164", "dialerNumberId", "repUserId", "sessionId", "callListId", "callListContactId", "leadId", "amdResult", "hangupCause", "inboundRouteResult", "inboundForwardToE164", "voicemailDropArmed", "voicemailDropped", "voicemailRecordingId", "voicemailDropMode", "recordingConsentState", "recordingSkipReason", "consentDisclosurePlayed", "consentJurisdiction", "processingStatus", "repNote", "startedAt", "answeredAt", "endedAt", "durationSeconds", "connectedSeconds", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|direction|status|voiceProvider|fromPhoneE164|toPhoneE164|counterpartyPhoneE164|dialerNumberId|repUserId|sessionId|callListId|callListContactId|leadId|amdResult|hangupCause|inboundRouteResult|inboundForwardToE164|voicemailDropArmed|voicemailDropped|voicemailRecordingId|voicemailDropMode|recordingConsentState|recordingSkipReason|consentDisclosurePlayed|consentJurisdiction|processingStatus|repNote|startedAt|answeredAt|endedAt|durationSeconds|connectedSeconds|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "direction", "status", "voiceProvider", "fromPhoneE164", "toPhoneE164", "counterpartyPhoneE164", "dialerNumberId", "repUserId", "sessionId", "callListId", "callListContactId", "leadId", "amdResult", "hangupCause", "inboundRouteResult", "inboundForwardToE164", "voicemailDropArmed", "voicemailDropped", "voicemailRecordingId", "voicemailDropMode", "recordingConsentState", "recordingSkipReason", "consentDisclosurePlayed", "consentJurisdiction", "processingStatus", "repNote", "startedAt", "answeredAt", "endedAt", "durationSeconds", "connectedSeconds", "createdAt", "updatedAt" ] } }, "repName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "effectiveDisposition": { "anyOf": [ { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, { "type": "null" } ] }, "notes": { "anyOf": [ { "$ref": "#/$defs/CallNote" }, { "type": "null" } ] }, "dispositions": { "type": "array", "items": { "type": "object", "properties": { "disposition": { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, "source": { "type": "string", "enum": [ "ai_suggested", "manual" ] }, "note": { "anyOf": [ { "$ref": "#/$defs/CallNote" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "null" } ] } }, "required": [ "disposition", "source", "note", "confidence" ], "patternProperties": { "^(?!(?:disposition|source|note|confidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "disposition", "source", "note", "confidence" ] } }, "maxItems": 2 }, "dispositionJobStatus": { "anyOf": [ { "type": "string", "enum": [ "queued", "running", "completed", "failed", "canceled" ] }, { "type": "null" } ] }, "hasRecording": { "type": "boolean" }, "recordingPending": { "type": "boolean" }, "recordingFailed": { "type": "boolean" }, "hasTranscript": { "type": "boolean" }, "aiSummary": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "transcriptText": { "anyOf": [ { "$ref": "#/$defs/CallTranscriptText" }, { "type": "null" } ] }, "qualityStats": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "capturedAtMs": { "type": "number", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "sampleCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "mosAvg": { "anyOf": [ { "type": "number", "minimum": 1, "maximum": 5 }, { "type": "null" } ] }, "mosMin": { "anyOf": [ { "type": "number", "minimum": 1, "maximum": 5 }, { "type": "null" } ] }, "rttMsAvg": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "rttMsMax": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "concealedSamplesPct": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "jitterBufferDelayMsAvg": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "audioLevelAvg": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "classification": { "type": "string", "enum": [ "clean", "network_degraded", "insufficient_data" ] }, "inbound": { "type": "object", "properties": { "codec": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "clockRate": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "packets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "packetsLost": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "packetLossPct": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "jitterMsAvg": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "jitterMsMax": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] } }, "required": [ "codec", "clockRate", "packets", "packetsLost", "packetLossPct", "jitterMsAvg", "jitterMsMax" ], "patternProperties": { "^(?!(?:codec|clockRate|packets|packetsLost|packetLossPct|jitterMsAvg|jitterMsMax)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "codec", "clockRate", "packets", "packetsLost", "packetLossPct", "jitterMsAvg", "jitterMsMax" ] } }, "outbound": { "type": "object", "properties": { "codec": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "clockRate": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "packets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "packetsLost": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "packetLossPct": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "jitterMsAvg": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "jitterMsMax": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] } }, "required": [ "codec", "clockRate", "packets", "packetsLost", "packetLossPct", "jitterMsAvg", "jitterMsMax" ], "patternProperties": { "^(?!(?:codec|clockRate|packets|packetsLost|packetLossPct|jitterMsAvg|jitterMsMax)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "codec", "clockRate", "packets", "packetsLost", "packetLossPct", "jitterMsAvg", "jitterMsMax" ] } } }, "required": [ "version", "capturedAtMs", "durationMs", "sampleCount", "rttMsAvg", "rttMsMax", "concealedSamplesPct", "jitterBufferDelayMsAvg", "audioLevelAvg", "classification", "inbound", "outbound" ], "patternProperties": { "^(?!(?:version|capturedAtMs|durationMs|sampleCount|mosAvg|mosMin|rttMsAvg|rttMsMax|concealedSamplesPct|jitterBufferDelayMsAvg|audioLevelAvg|classification|inbound|outbound)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "capturedAtMs", "durationMs", "sampleCount", "mosAvg", "mosMin", "rttMsAvg", "rttMsMax", "concealedSamplesPct", "jitterBufferDelayMsAvg", "audioLevelAvg", "classification", "inbound", "outbound" ] } }, { "type": "null" } ] } }, "required": [ "call", "repName", "effectiveDisposition", "notes", "dispositions", "dispositionJobStatus", "hasRecording", "recordingPending", "recordingFailed", "hasTranscript", "aiSummary" ], "patternProperties": { "^(?!(?:call|repName|effectiveDisposition|notes|dispositions|dispositionJobStatus|hasRecording|recordingPending|recordingFailed|hasTranscript|aiSummary|transcriptText|qualityStats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "call", "repName", "effectiveDisposition", "notes", "dispositions", "dispositionJobStatus", "hasRecording", "recordingPending", "recordingFailed", "hasTranscript", "aiSummary", "transcriptText", "qualityStats" ] } }, { "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" }, "status": { "type": "string", "enum": [ "queued", "initiated", "ringing", "answered", "bridged", "completed", "no_answer", "busy", "failed", "canceled" ] }, "hangupCause": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "amdResult": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "status", "hangupCause", "amdResult" ], "patternProperties": { "^(?!(?:id|status|hangupCause|amdResult)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "status", "hangupCause", "amdResult" ] } }, { "type": "object", "properties": { "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" }, "callListId": { "$ref": "#/$defs/CallListId" }, "callListName": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "active", "paused", "ended" ] }, "mode": { "type": "string", "enum": [ "manual", "power" ] }, "autoAdvanceDelaySeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "totalCalls": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionRate": { "type": "number", "minimum": 0, "maximum": 1 }, "talkTimeSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "meetingsBooked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pendingAi": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failedAi": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "redials": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "callListId", "callListName", "status", "mode", "autoAdvanceDelaySeconds", "startedAt", "endedAt", "totalCalls", "connects", "connectionRate", "talkTimeSeconds", "meetingsBooked", "pendingAi", "failedAi", "redials" ], "patternProperties": { "^(?!(?:id|callListId|callListName|status|mode|autoAdvanceDelaySeconds|startedAt|endedAt|totalCalls|connects|connectionRate|talkTimeSeconds|meetingsBooked|pendingAi|failedAi|redials)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "callListId", "callListName", "status", "mode", "autoAdvanceDelaySeconds", "startedAt", "endedAt", "totalCalls", "connects", "connectionRate", "talkTimeSeconds", "meetingsBooked", "pendingAi", "failedAi", "redials" ] } }, "maxItems": 100 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "session": { "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" }, "callListId": { "$ref": "#/$defs/CallListId" }, "userId": { "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" }, "dialerNumberId": { "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" } ] }, "dialerNumberIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 50 }, "mode": { "type": "string", "enum": [ "manual", "power" ] }, "autoAdvanceDelaySeconds": { "type": "integer", "minimum": 0, "maximum": 300 }, "rotationFrequency": { "type": "integer", "minimum": 1, "maximum": 100 }, "status": { "type": "string", "enum": [ "active", "paused", "ended" ] }, "currentContactId": { "anyOf": [ { "$ref": "#/$defs/CallListContactId" }, { "type": "null" } ] }, "currentLeadId": { "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" } ] }, "callsPlaced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "callsConnected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "callListId", "userId", "dialerNumberId", "dialerNumberIds", "mode", "autoAdvanceDelaySeconds", "rotationFrequency", "status", "currentContactId", "currentLeadId", "callsPlaced", "callsConnected", "startedAt", "endedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|callListId|userId|dialerNumberId|dialerNumberIds|mode|autoAdvanceDelaySeconds|rotationFrequency|status|currentContactId|currentLeadId|callsPlaced|callsConnected|startedAt|endedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "callListId", "userId", "dialerNumberId", "dialerNumberIds", "mode", "autoAdvanceDelaySeconds", "rotationFrequency", "status", "currentContactId", "currentLeadId", "callsPlaced", "callsConnected", "startedAt", "endedAt", "createdAt", "updatedAt" ] } }, "currentCall": { "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" }, "status": { "type": "string", "enum": [ "queued", "initiated", "ringing", "answered", "bridged", "completed", "no_answer", "busy", "failed", "canceled" ] }, "hangupCause": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "status", "hangupCause" ], "patternProperties": { "^(?!(?:id|status|hangupCause)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "status", "hangupCause" ] } }, { "type": "null" } ] } }, "required": [ "session", "currentCall" ], "patternProperties": { "^(?!(?:session|currentCall)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "session", "currentCall" ] } }, { "type": "object", "properties": { "report": { "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" }, "callListId": { "$ref": "#/$defs/CallListId" }, "callListName": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "active", "paused", "ended" ] }, "mode": { "type": "string", "enum": [ "manual", "power" ] }, "autoAdvanceDelaySeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "totalCalls": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionRate": { "type": "number", "minimum": 0, "maximum": 1 }, "talkTimeSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "meetingsBooked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pendingAi": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failedAi": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "redials": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "callListId", "callListName", "status", "mode", "autoAdvanceDelaySeconds", "startedAt", "endedAt", "totalCalls", "connects", "connectionRate", "talkTimeSeconds", "meetingsBooked", "pendingAi", "failedAi", "redials" ], "patternProperties": { "^(?!(?:id|callListId|callListName|status|mode|autoAdvanceDelaySeconds|startedAt|endedAt|totalCalls|connects|connectionRate|talkTimeSeconds|meetingsBooked|pendingAi|failedAi|redials)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "callListId", "callListName", "status", "mode", "autoAdvanceDelaySeconds", "startedAt", "endedAt", "totalCalls", "connects", "connectionRate", "talkTimeSeconds", "meetingsBooked", "pendingAi", "failedAi", "redials" ] } }, "dispositionBreakdown": { "type": "array", "items": { "type": "object", "properties": { "disposition": { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "disposition", "count" ], "patternProperties": { "^(?!(?:disposition|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "disposition", "count" ] } } } }, "required": [ "report", "dispositionBreakdown" ], "patternProperties": { "^(?!(?:report|dispositionBreakdown)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "report", "dispositionBreakdown" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "$ref": "#/$defs/DialerSeatId" }, { "type": "null" } ] }, "userId": { "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" }, "active": { "type": "boolean" }, "assignedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "assignedByUserId": { "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" } ] }, "userName": { "$ref": "#/$defs/ShortText" }, "userEmail": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "id", "userId", "active", "assignedAt", "assignedByUserId", "userName", "userEmail" ], "patternProperties": { "^(?!(?:id|userId|active|assignedAt|assignedByUserId|userName|userEmail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "userId", "active", "assignedAt", "assignedByUserId", "userName", "userEmail" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "hasSeat": { "type": "boolean" }, "active": { "type": "boolean" } }, "required": [ "hasSeat", "active" ], "patternProperties": { "^(?!(?:hasSeat|active)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "hasSeat", "active" ] } }, { "type": "object", "properties": { "hasSeat": { "type": "boolean" }, "enabled": { "type": "boolean" }, "forwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] } }, "required": [ "hasSeat", "enabled", "forwardE164" ], "patternProperties": { "^(?!(?:hasSeat|enabled|forwardE164)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "hasSeat", "enabled", "forwardE164" ] } }, { "type": "object", "properties": { "totalDials": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectRate": { "type": "number", "minimum": 0, "maximum": 1 }, "meetingsBooked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "talkTimeSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "avgCallDurationSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "voicemailsDropped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbound": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "answered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "missed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notRouted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "talkTimeSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "total", "answered", "missed", "notRouted", "talkTimeSeconds" ], "patternProperties": { "^(?!(?:total|answered|missed|notRouted|talkTimeSeconds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "answered", "missed", "notRouted", "talkTimeSeconds" ] } }, "dailySeries": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/ShortText" }, "dials": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "meetings": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "dials", "connects", "meetings" ], "patternProperties": { "^(?!(?:date|dials|connects|meetings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "dials", "connects", "meetings" ] } } }, "dispositionBreakdown": { "type": "array", "items": { "type": "object", "properties": { "disposition": { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "disposition", "count" ], "patternProperties": { "^(?!(?:disposition|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "disposition", "count" ] } } } }, "required": [ "totalDials", "connects", "connectRate", "meetingsBooked", "talkTimeSeconds", "avgCallDurationSeconds", "voicemailsDropped", "inbound", "dailySeries", "dispositionBreakdown" ], "patternProperties": { "^(?!(?:totalDials|connects|connectRate|meetingsBooked|talkTimeSeconds|avgCallDurationSeconds|voicemailsDropped|inbound|dailySeries|dispositionBreakdown)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalDials", "connects", "connectRate", "meetingsBooked", "talkTimeSeconds", "avgCallDurationSeconds", "voicemailsDropped", "inbound", "dailySeries", "dispositionBreakdown" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "status": { "type": "string", "enum": [ "queued", "initiated", "ringing", "answered", "bridged", "completed", "no_answer", "busy", "failed", "canceled" ] }, "fromPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "toPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "counterpartyPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "repUserId": { "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" } ] }, "repName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "leadId": { "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" } ] }, "callListId": { "anyOf": [ { "$ref": "#/$defs/CallListId" }, { "type": "null" } ] }, "inboundRouteResult": { "anyOf": [ { "type": "string", "enum": [ "forwarded", "not_configured", "transfer_failed" ] }, { "type": "null" } ] }, "inboundForwardToE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "durationSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "effectiveDisposition": { "anyOf": [ { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, { "type": "null" } ] }, "dispositionJobStatus": { "anyOf": [ { "type": "string", "enum": [ "queued", "running", "completed", "failed", "canceled" ] }, { "type": "null" } ] }, "hasRecording": { "type": "boolean" }, "recordingPending": { "type": "boolean" }, "recordingFailed": { "type": "boolean" }, "hasTranscript": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "direction", "status", "fromPhoneE164", "toPhoneE164", "counterpartyPhoneE164", "repUserId", "repName", "leadId", "callListId", "inboundRouteResult", "inboundForwardToE164", "durationSeconds", "effectiveDisposition", "dispositionJobStatus", "hasRecording", "recordingPending", "recordingFailed", "hasTranscript", "createdAt" ], "patternProperties": { "^(?!(?:id|direction|status|fromPhoneE164|toPhoneE164|counterpartyPhoneE164|repUserId|repName|leadId|callListId|inboundRouteResult|inboundForwardToE164|durationSeconds|effectiveDisposition|dispositionJobStatus|hasRecording|recordingPending|recordingFailed|hasTranscript|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "direction", "status", "fromPhoneE164", "toPhoneE164", "counterpartyPhoneE164", "repUserId", "repName", "leadId", "callListId", "inboundRouteResult", "inboundForwardToE164", "durationSeconds", "effectiveDisposition", "dispositionJobStatus", "hasRecording", "recordingPending", "recordingFailed", "hasTranscript", "createdAt" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "call": { "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" }, "direction": { "type": "string", "enum": [ "outbound", "inbound" ] }, "status": { "type": "string", "enum": [ "queued", "initiated", "ringing", "answered", "bridged", "completed", "no_answer", "busy", "failed", "canceled" ] }, "voiceProvider": { "anyOf": [ { "type": "string", "enum": [ "twilio" ] } ] }, "fromPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "toPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "counterpartyPhoneE164": { "$ref": "#/$defs/E164PhoneNumber" }, "dialerNumberId": { "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" } ] }, "repUserId": { "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" } ] }, "sessionId": { "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" } ] }, "callListId": { "anyOf": [ { "$ref": "#/$defs/CallListId" }, { "type": "null" } ] }, "callListContactId": { "anyOf": [ { "$ref": "#/$defs/CallListContactId" }, { "type": "null" } ] }, "leadId": { "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" } ] }, "amdResult": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "hangupCause": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "inboundRouteResult": { "anyOf": [ { "type": "string", "enum": [ "forwarded", "not_configured", "transfer_failed" ] }, { "type": "null" } ] }, "inboundForwardToE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "voicemailDropArmed": { "type": "boolean" }, "voicemailDropped": { "type": "boolean" }, "voicemailRecordingId": { "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" } ] }, "voicemailDropMode": { "anyOf": [ { "type": "string", "enum": [ "drop_and_end", "drop_and_talk" ] }, { "type": "null" } ] }, "recordingConsentState": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "recordingSkipReason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "consentDisclosurePlayed": { "type": "boolean" }, "consentJurisdiction": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "processingStatus": { "type": "string", "enum": [ "pending", "recording_stored", "transcribed", "completed", "failed" ] }, "repNote": { "anyOf": [ { "$ref": "#/$defs/CallNote" }, { "type": "null" } ] }, "startedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "answeredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "durationSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "connectedSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "direction", "status", "voiceProvider", "fromPhoneE164", "toPhoneE164", "counterpartyPhoneE164", "dialerNumberId", "repUserId", "sessionId", "callListId", "callListContactId", "leadId", "amdResult", "hangupCause", "inboundRouteResult", "inboundForwardToE164", "voicemailDropArmed", "voicemailDropped", "voicemailRecordingId", "voicemailDropMode", "recordingConsentState", "recordingSkipReason", "consentDisclosurePlayed", "consentJurisdiction", "processingStatus", "repNote", "startedAt", "answeredAt", "endedAt", "durationSeconds", "connectedSeconds", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|direction|status|voiceProvider|fromPhoneE164|toPhoneE164|counterpartyPhoneE164|dialerNumberId|repUserId|sessionId|callListId|callListContactId|leadId|amdResult|hangupCause|inboundRouteResult|inboundForwardToE164|voicemailDropArmed|voicemailDropped|voicemailRecordingId|voicemailDropMode|recordingConsentState|recordingSkipReason|consentDisclosurePlayed|consentJurisdiction|processingStatus|repNote|startedAt|answeredAt|endedAt|durationSeconds|connectedSeconds|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "direction", "status", "voiceProvider", "fromPhoneE164", "toPhoneE164", "counterpartyPhoneE164", "dialerNumberId", "repUserId", "sessionId", "callListId", "callListContactId", "leadId", "amdResult", "hangupCause", "inboundRouteResult", "inboundForwardToE164", "voicemailDropArmed", "voicemailDropped", "voicemailRecordingId", "voicemailDropMode", "recordingConsentState", "recordingSkipReason", "consentDisclosurePlayed", "consentJurisdiction", "processingStatus", "repNote", "startedAt", "answeredAt", "endedAt", "durationSeconds", "connectedSeconds", "createdAt", "updatedAt" ] } }, "repName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "effectiveDisposition": { "anyOf": [ { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, { "type": "null" } ] }, "notes": { "anyOf": [ { "$ref": "#/$defs/CallNote" }, { "type": "null" } ] }, "dispositions": { "type": "array", "items": { "type": "object", "properties": { "disposition": { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, "source": { "type": "string", "enum": [ "ai_suggested", "manual" ] }, "note": { "anyOf": [ { "$ref": "#/$defs/CallNote" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "null" } ] } }, "required": [ "disposition", "source", "note", "confidence" ], "patternProperties": { "^(?!(?:disposition|source|note|confidence)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "disposition", "source", "note", "confidence" ] } }, "maxItems": 2 }, "dispositionJobStatus": { "anyOf": [ { "type": "string", "enum": [ "queued", "running", "completed", "failed", "canceled" ] }, { "type": "null" } ] }, "hasRecording": { "type": "boolean" }, "recordingPending": { "type": "boolean" }, "recordingFailed": { "type": "boolean" }, "hasTranscript": { "type": "boolean" }, "aiSummary": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "transcriptText": { "anyOf": [ { "$ref": "#/$defs/CallTranscriptText" }, { "type": "null" } ] }, "qualityStats": { "anyOf": [ { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "capturedAtMs": { "type": "number", "minimum": 0 }, "durationMs": { "type": "number", "minimum": 0 }, "sampleCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "mosAvg": { "anyOf": [ { "type": "number", "minimum": 1, "maximum": 5 }, { "type": "null" } ] }, "mosMin": { "anyOf": [ { "type": "number", "minimum": 1, "maximum": 5 }, { "type": "null" } ] }, "rttMsAvg": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "rttMsMax": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "concealedSamplesPct": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "jitterBufferDelayMsAvg": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "audioLevelAvg": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "classification": { "type": "string", "enum": [ "clean", "network_degraded", "insufficient_data" ] }, "inbound": { "type": "object", "properties": { "codec": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "clockRate": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "packets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "packetsLost": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "packetLossPct": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "jitterMsAvg": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "jitterMsMax": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] } }, "required": [ "codec", "clockRate", "packets", "packetsLost", "packetLossPct", "jitterMsAvg", "jitterMsMax" ], "patternProperties": { "^(?!(?:codec|clockRate|packets|packetsLost|packetLossPct|jitterMsAvg|jitterMsMax)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "codec", "clockRate", "packets", "packetsLost", "packetLossPct", "jitterMsAvg", "jitterMsMax" ] } }, "outbound": { "type": "object", "properties": { "codec": { "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "clockRate": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "packets": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "packetsLost": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "packetLossPct": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "jitterMsAvg": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "jitterMsMax": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] } }, "required": [ "codec", "clockRate", "packets", "packetsLost", "packetLossPct", "jitterMsAvg", "jitterMsMax" ], "patternProperties": { "^(?!(?:codec|clockRate|packets|packetsLost|packetLossPct|jitterMsAvg|jitterMsMax)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "codec", "clockRate", "packets", "packetsLost", "packetLossPct", "jitterMsAvg", "jitterMsMax" ] } } }, "required": [ "version", "capturedAtMs", "durationMs", "sampleCount", "rttMsAvg", "rttMsMax", "concealedSamplesPct", "jitterBufferDelayMsAvg", "audioLevelAvg", "classification", "inbound", "outbound" ], "patternProperties": { "^(?!(?:version|capturedAtMs|durationMs|sampleCount|mosAvg|mosMin|rttMsAvg|rttMsMax|concealedSamplesPct|jitterBufferDelayMsAvg|audioLevelAvg|classification|inbound|outbound)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "capturedAtMs", "durationMs", "sampleCount", "mosAvg", "mosMin", "rttMsAvg", "rttMsMax", "concealedSamplesPct", "jitterBufferDelayMsAvg", "audioLevelAvg", "classification", "inbound", "outbound" ] } }, { "type": "null" } ] } }, "required": [ "call", "repName", "effectiveDisposition", "notes", "dispositions", "dispositionJobStatus", "hasRecording", "recordingPending", "recordingFailed", "hasTranscript", "aiSummary" ], "patternProperties": { "^(?!(?:call|repName|effectiveDisposition|notes|dispositions|dispositionJobStatus|hasRecording|recordingPending|recordingFailed|hasTranscript|aiSummary|transcriptText|qualityStats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "call", "repName", "effectiveDisposition", "notes", "dispositions", "dispositionJobStatus", "hasRecording", "recordingPending", "recordingFailed", "hasTranscript", "aiSummary", "transcriptText", "qualityStats" ] } }, { "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" }, "status": { "type": "string", "enum": [ "queued", "initiated", "ringing", "answered", "bridged", "completed", "no_answer", "busy", "failed", "canceled" ] }, "hangupCause": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "amdResult": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "status", "hangupCause", "amdResult" ], "patternProperties": { "^(?!(?:id|status|hangupCause|amdResult)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "status", "hangupCause", "amdResult" ] } }, { "type": "object", "properties": { "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" }, "callListId": { "$ref": "#/$defs/CallListId" }, "callListName": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "active", "paused", "ended" ] }, "mode": { "type": "string", "enum": [ "manual", "power" ] }, "autoAdvanceDelaySeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "totalCalls": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionRate": { "type": "number", "minimum": 0, "maximum": 1 }, "talkTimeSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "meetingsBooked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pendingAi": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failedAi": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "redials": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "callListId", "callListName", "status", "mode", "autoAdvanceDelaySeconds", "startedAt", "endedAt", "totalCalls", "connects", "connectionRate", "talkTimeSeconds", "meetingsBooked", "pendingAi", "failedAi", "redials" ], "patternProperties": { "^(?!(?:id|callListId|callListName|status|mode|autoAdvanceDelaySeconds|startedAt|endedAt|totalCalls|connects|connectionRate|talkTimeSeconds|meetingsBooked|pendingAi|failedAi|redials)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "callListId", "callListName", "status", "mode", "autoAdvanceDelaySeconds", "startedAt", "endedAt", "totalCalls", "connects", "connectionRate", "talkTimeSeconds", "meetingsBooked", "pendingAi", "failedAi", "redials" ] } }, "maxItems": 100 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "session": { "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" }, "callListId": { "$ref": "#/$defs/CallListId" }, "userId": { "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" }, "dialerNumberId": { "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" } ] }, "dialerNumberIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 50 }, "mode": { "type": "string", "enum": [ "manual", "power" ] }, "autoAdvanceDelaySeconds": { "type": "integer", "minimum": 0, "maximum": 300 }, "rotationFrequency": { "type": "integer", "minimum": 1, "maximum": 100 }, "status": { "type": "string", "enum": [ "active", "paused", "ended" ] }, "currentContactId": { "anyOf": [ { "$ref": "#/$defs/CallListContactId" }, { "type": "null" } ] }, "currentLeadId": { "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" } ] }, "callsPlaced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "callsConnected": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "callListId", "userId", "dialerNumberId", "dialerNumberIds", "mode", "autoAdvanceDelaySeconds", "rotationFrequency", "status", "currentContactId", "currentLeadId", "callsPlaced", "callsConnected", "startedAt", "endedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|callListId|userId|dialerNumberId|dialerNumberIds|mode|autoAdvanceDelaySeconds|rotationFrequency|status|currentContactId|currentLeadId|callsPlaced|callsConnected|startedAt|endedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "callListId", "userId", "dialerNumberId", "dialerNumberIds", "mode", "autoAdvanceDelaySeconds", "rotationFrequency", "status", "currentContactId", "currentLeadId", "callsPlaced", "callsConnected", "startedAt", "endedAt", "createdAt", "updatedAt" ] } }, "currentCall": { "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" }, "status": { "type": "string", "enum": [ "queued", "initiated", "ringing", "answered", "bridged", "completed", "no_answer", "busy", "failed", "canceled" ] }, "hangupCause": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "status", "hangupCause" ], "patternProperties": { "^(?!(?:id|status|hangupCause)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "status", "hangupCause" ] } }, { "type": "null" } ] } }, "required": [ "session", "currentCall" ], "patternProperties": { "^(?!(?:session|currentCall)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "session", "currentCall" ] } }, { "type": "object", "properties": { "report": { "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" }, "callListId": { "$ref": "#/$defs/CallListId" }, "callListName": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "active", "paused", "ended" ] }, "mode": { "type": "string", "enum": [ "manual", "power" ] }, "autoAdvanceDelaySeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "endedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "totalCalls": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionRate": { "type": "number", "minimum": 0, "maximum": 1 }, "talkTimeSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "meetingsBooked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pendingAi": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failedAi": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "redials": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "callListId", "callListName", "status", "mode", "autoAdvanceDelaySeconds", "startedAt", "endedAt", "totalCalls", "connects", "connectionRate", "talkTimeSeconds", "meetingsBooked", "pendingAi", "failedAi", "redials" ], "patternProperties": { "^(?!(?:id|callListId|callListName|status|mode|autoAdvanceDelaySeconds|startedAt|endedAt|totalCalls|connects|connectionRate|talkTimeSeconds|meetingsBooked|pendingAi|failedAi|redials)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "callListId", "callListName", "status", "mode", "autoAdvanceDelaySeconds", "startedAt", "endedAt", "totalCalls", "connects", "connectionRate", "talkTimeSeconds", "meetingsBooked", "pendingAi", "failedAi", "redials" ] } }, "dispositionBreakdown": { "type": "array", "items": { "type": "object", "properties": { "disposition": { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "disposition", "count" ], "patternProperties": { "^(?!(?:disposition|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "disposition", "count" ] } } } }, "required": [ "report", "dispositionBreakdown" ], "patternProperties": { "^(?!(?:report|dispositionBreakdown)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "report", "dispositionBreakdown" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [ { "$ref": "#/$defs/DialerSeatId" }, { "type": "null" } ] }, "userId": { "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" }, "active": { "type": "boolean" }, "assignedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "assignedByUserId": { "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" } ] }, "userName": { "$ref": "#/$defs/ShortText" }, "userEmail": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "id", "userId", "active", "assignedAt", "assignedByUserId", "userName", "userEmail" ], "patternProperties": { "^(?!(?:id|userId|active|assignedAt|assignedByUserId|userName|userEmail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "userId", "active", "assignedAt", "assignedByUserId", "userName", "userEmail" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "hasSeat": { "type": "boolean" }, "active": { "type": "boolean" } }, "required": [ "hasSeat", "active" ], "patternProperties": { "^(?!(?:hasSeat|active)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "hasSeat", "active" ] } }, { "type": "object", "properties": { "hasSeat": { "type": "boolean" }, "enabled": { "type": "boolean" }, "forwardE164": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] } }, "required": [ "hasSeat", "enabled", "forwardE164" ], "patternProperties": { "^(?!(?:hasSeat|enabled|forwardE164)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "hasSeat", "enabled", "forwardE164" ] } }, { "type": "object", "properties": { "totalDials": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectRate": { "type": "number", "minimum": 0, "maximum": 1 }, "meetingsBooked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "talkTimeSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "avgCallDurationSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "voicemailsDropped": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbound": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "answered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "missed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notRouted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "talkTimeSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "total", "answered", "missed", "notRouted", "talkTimeSeconds" ], "patternProperties": { "^(?!(?:total|answered|missed|notRouted|talkTimeSeconds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "answered", "missed", "notRouted", "talkTimeSeconds" ] } }, "dailySeries": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/ShortText" }, "dials": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connects": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "meetings": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "dials", "connects", "meetings" ], "patternProperties": { "^(?!(?:date|dials|connects|meetings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "dials", "connects", "meetings" ] } } }, "dispositionBreakdown": { "type": "array", "items": { "type": "object", "properties": { "disposition": { "type": "string", "enum": [ "booked_meeting", "connected", "voicemail", "no_answer", "not_interested", "callback", "wrong_number", "dnc", "gatekeeper", "ai_gatekeeper", "busy", "failed" ] }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "disposition", "count" ], "patternProperties": { "^(?!(?:disposition|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "disposition", "count" ] } } } }, "required": [ "totalDials", "connects", "connectRate", "meetingsBooked", "talkTimeSeconds", "avgCallDurationSeconds", "voicemailsDropped", "inbound", "dailySeries", "dispositionBreakdown" ], "patternProperties": { "^(?!(?:totalDials|connects|connectRate|meetingsBooked|talkTimeSeconds|avgCallDurationSeconds|voicemailsDropped|inbound|dailySeries|dispositionBreakdown)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalDials", "connects", "connectRate", "meetingsBooked", "talkTimeSeconds", "avgCallDurationSeconds", "voicemailsDropped", "inbound", "dailySeries", "dispositionBreakdown" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `dialerCalls.list`: `GET /v1/workspaces/:workspaceId/dialer/calls` - `dialerCalls.get`: `GET /v1/workspaces/:workspaceId/dialer/calls/:callId` - `dialerCalls.status`: `GET /v1/workspaces/:workspaceId/dialer/calls/:callId/status` - `dialerSessions.list`: `GET /v1/workspaces/:workspaceId/dialer/sessions` - `dialerSessions.get`: `GET /v1/workspaces/:workspaceId/dialer/sessions/:sessionId` - `dialerSessions.report`: `GET /v1/workspaces/:workspaceId/dialer/sessions/:sessionId/report` - `dialerSeats.list`: `GET /v1/workspaces/:workspaceId/dialer/seats` - `dialerSeats.me`: `GET /v1/workspaces/:workspaceId/dialer/seats/me` - `dialerSeats.getInboundForwarding`: `GET /v1/workspaces/:workspaceId/dialer/seats/me/inbound-forwarding` - `dialerStats.overview`: `GET /v1/workspaces/:workspaceId/dialer/stats/overview` ## read_domains Read the workspace's existing domains, registration progress, and outbound transfers. Use to inspect domains a workspace already owns and their state. New domain purchases are no longer available. Scopes: domain:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "list" ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "cursor", "limit" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "get" ] }, "domainId": { "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": [ "kind", "domainId" ], "patternProperties": { "^(?!(?:kind|domainId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "domainId" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "registration_status" ] }, "domainId": { "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": [ "kind", "domainId" ], "patternProperties": { "^(?!(?:kind|domainId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "domainId" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer_status" ] }, "domainId": { "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": [ "kind", "domainId" ], "patternProperties": { "^(?!(?:kind|domainId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "domainId" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### 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" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "list" ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "cursor", "limit" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "get" ] }, "domainId": { "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": [ "kind", "domainId" ], "patternProperties": { "^(?!(?:kind|domainId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "domainId" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "registration_status" ] }, "domainId": { "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": [ "kind", "domainId" ], "patternProperties": { "^(?!(?:kind|domainId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "domainId" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "transfer_status" ] }, "domainId": { "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": [ "kind", "domainId" ], "patternProperties": { "^(?!(?:kind|domainId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "domainId" ] } } ] } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Money": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XCG", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWG" ] } }, "required": [ "amountMinor", "currency" ], "patternProperties": { "^(?!(?:amountMinor|currency)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "amountMinor", "currency" ] } }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "domainName": { "$ref": "#/$defs/DomainName" }, "registrar": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "registering", "renew_option_pending", "active", "renewal_due", "transfer_pending", "transferred_out", "expired", "failed" ] }, "registeredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "autoRenew": { "type": "boolean" }, "dnsProvider": { "$ref": "#/$defs/ShortText" }, "purchasePrice": { "anyOf": [ { "$ref": "#/$defs/Money" }, { "type": "null" } ] }, "renewalPrice": { "anyOf": [ { "$ref": "#/$defs/Money" }, { "type": "null" } ] }, "failureReason": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "domainName", "registrar", "status", "registeredAt", "expiresAt", "autoRenew", "dnsProvider", "purchasePrice", "renewalPrice", "failureReason", "createdAt" ], "patternProperties": { "^(?!(?:id|domainName|registrar|status|registeredAt|expiresAt|autoRenew|dnsProvider|purchasePrice|renewalPrice|failureReason|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "domainName", "registrar", "status", "registeredAt", "expiresAt", "autoRenew", "dnsProvider", "purchasePrice", "renewalPrice", "failureReason", "createdAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "domain": { "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" }, "domainName": { "$ref": "#/$defs/DomainName" }, "registrar": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "registering", "renew_option_pending", "active", "renewal_due", "transfer_pending", "transferred_out", "expired", "failed" ] }, "registeredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "autoRenew": { "type": "boolean" }, "dnsProvider": { "$ref": "#/$defs/ShortText" }, "purchasePrice": { "anyOf": [ { "$ref": "#/$defs/Money" }, { "type": "null" } ] }, "renewalPrice": { "anyOf": [ { "$ref": "#/$defs/Money" }, { "type": "null" } ] }, "failureReason": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "domainName", "registrar", "status", "registeredAt", "expiresAt", "autoRenew", "dnsProvider", "purchasePrice", "renewalPrice", "failureReason", "createdAt" ], "patternProperties": { "^(?!(?:id|domainName|registrar|status|registeredAt|expiresAt|autoRenew|dnsProvider|purchasePrice|renewalPrice|failureReason|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "domainName", "registrar", "status", "registeredAt", "expiresAt", "autoRenew", "dnsProvider", "purchasePrice", "renewalPrice", "failureReason", "createdAt" ] } }, "orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "kind": { "type": "string", "enum": [ "registration", "renewal" ] }, "status": { "type": "string", "enum": [ "pending", "paid", "fulfilled", "failed", "refund_pending", "refunded" ] }, "years": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "amount": { "anyOf": [ { "$ref": "#/$defs/Money" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "kind", "status", "years", "amount", "error", "createdAt" ], "patternProperties": { "^(?!(?:id|kind|status|years|amount|error|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "status", "years", "amount", "error", "createdAt" ] } }, "maxItems": 100 } }, "required": [ "domain", "orders" ], "patternProperties": { "^(?!(?:domain|orders)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "domain", "orders" ] } }, { "type": "object", "properties": { "state": { "type": "string", "enum": [ "idle", "running", "reconciling" ] }, "progress": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "message": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "progress", "message" ], "patternProperties": { "^(?!(?:state|progress|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "progress", "message" ] } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "registering", "renew_option_pending", "active", "renewal_due", "transfer_pending", "transferred_out", "expired", "failed" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "changed": { "type": "boolean" } }, "required": [ "status", "rawStatus", "changed" ], "patternProperties": { "^(?!(?:status|rawStatus|changed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "rawStatus", "changed" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "domainName": { "$ref": "#/$defs/DomainName" }, "registrar": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "registering", "renew_option_pending", "active", "renewal_due", "transfer_pending", "transferred_out", "expired", "failed" ] }, "registeredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "autoRenew": { "type": "boolean" }, "dnsProvider": { "$ref": "#/$defs/ShortText" }, "purchasePrice": { "anyOf": [ { "$ref": "#/$defs/Money" }, { "type": "null" } ] }, "renewalPrice": { "anyOf": [ { "$ref": "#/$defs/Money" }, { "type": "null" } ] }, "failureReason": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "domainName", "registrar", "status", "registeredAt", "expiresAt", "autoRenew", "dnsProvider", "purchasePrice", "renewalPrice", "failureReason", "createdAt" ], "patternProperties": { "^(?!(?:id|domainName|registrar|status|registeredAt|expiresAt|autoRenew|dnsProvider|purchasePrice|renewalPrice|failureReason|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "domainName", "registrar", "status", "registeredAt", "expiresAt", "autoRenew", "dnsProvider", "purchasePrice", "renewalPrice", "failureReason", "createdAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "domain": { "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" }, "domainName": { "$ref": "#/$defs/DomainName" }, "registrar": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "registering", "renew_option_pending", "active", "renewal_due", "transfer_pending", "transferred_out", "expired", "failed" ] }, "registeredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "autoRenew": { "type": "boolean" }, "dnsProvider": { "$ref": "#/$defs/ShortText" }, "purchasePrice": { "anyOf": [ { "$ref": "#/$defs/Money" }, { "type": "null" } ] }, "renewalPrice": { "anyOf": [ { "$ref": "#/$defs/Money" }, { "type": "null" } ] }, "failureReason": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "domainName", "registrar", "status", "registeredAt", "expiresAt", "autoRenew", "dnsProvider", "purchasePrice", "renewalPrice", "failureReason", "createdAt" ], "patternProperties": { "^(?!(?:id|domainName|registrar|status|registeredAt|expiresAt|autoRenew|dnsProvider|purchasePrice|renewalPrice|failureReason|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "domainName", "registrar", "status", "registeredAt", "expiresAt", "autoRenew", "dnsProvider", "purchasePrice", "renewalPrice", "failureReason", "createdAt" ] } }, "orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "kind": { "type": "string", "enum": [ "registration", "renewal" ] }, "status": { "type": "string", "enum": [ "pending", "paid", "fulfilled", "failed", "refund_pending", "refunded" ] }, "years": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "amount": { "anyOf": [ { "$ref": "#/$defs/Money" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "kind", "status", "years", "amount", "error", "createdAt" ], "patternProperties": { "^(?!(?:id|kind|status|years|amount|error|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "status", "years", "amount", "error", "createdAt" ] } }, "maxItems": 100 } }, "required": [ "domain", "orders" ], "patternProperties": { "^(?!(?:domain|orders)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "domain", "orders" ] } }, { "type": "object", "properties": { "state": { "type": "string", "enum": [ "idle", "running", "reconciling" ] }, "progress": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "message": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "progress", "message" ], "patternProperties": { "^(?!(?:state|progress|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "progress", "message" ] } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "registering", "renew_option_pending", "active", "renewal_due", "transfer_pending", "transferred_out", "expired", "failed" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "changed": { "type": "boolean" } }, "required": [ "status", "rawStatus", "changed" ], "patternProperties": { "^(?!(?:status|rawStatus|changed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "rawStatus", "changed" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `domains.list`: `GET /v1/workspaces/:workspaceId/domains` - `domains.get`: `GET /v1/workspaces/:workspaceId/domains/:domainId` - `domains.registrationStatus`: `GET /v1/workspaces/:workspaceId/domains/:domainId/registration-status` - `domains.transferStatus`: `GET /v1/workspaces/:workspaceId/domains/:domainId/transfer-status` ## read_heyreach Read the workspace's HeyReach LinkedIn automation as it is right now: the connection, sender accounts and their session status, campaigns with their sequences and enrolled leads, lists, lead tags, synced LinkedIn conversations, a sender's network, activity statistics, an email-enrichment job, and the webhook deliveries this workspace received. Use before proposing any LinkedIn outreach change — every read is a live provider read with the workspace's own key, so it is the only honest answer to what HeyReach is doing. Page through campaigns, lists, leads, and network with offset/limit; conversation search pages with the provider cursor. Nothing is cached locally: a read costs a HeyReach API call and HeyReach rate-limits the workspace, so do not poll tight loops. `HeyReachNotConnected` means the workspace has no key — a person must connect one in Settings. HeyReach's own documents (sequences, account status, lead lookups, per-campaign statistics) come back verbatim as provider JSON. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "target": { "type": "string", "enum": [ "connection" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId|target)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target" ] } }, { "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" }, "target": { "type": "string", "enum": [ "proxy_countries" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId|target)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target" ] } }, { "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" }, "target": { "type": "string", "enum": [ "webhooks" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId|target)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target" ] } }, { "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" }, "target": { "type": "string", "enum": [ "accounts" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId|target|offset|limit|keyword)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "offset", "limit", "keyword" ] } }, { "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" }, "target": { "type": "string", "enum": [ "account" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId|target|accountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "accountId" ] } }, { "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" }, "target": { "type": "string", "enum": [ "account_status" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId|target|accountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "accountId" ] } }, { "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" }, "target": { "type": "string", "enum": [ "network" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "pageNumber": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId|target|accountId|pageNumber|pageSize)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "accountId", "pageNumber", "pageSize" ] } }, { "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" }, "target": { "type": "string", "enum": [ "campaigns" ] }, "campaignSearch": { "$ref": "#/$defs/SearchHeyReachCampaignsInput" } }, "required": [ "workspaceId", "target", "campaignSearch" ], "patternProperties": { "^(?!(?:workspaceId|target|campaignSearch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "campaignSearch" ] } }, { "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" }, "target": { "type": "string", "enum": [ "campaign" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|target|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "campaignId" ] } }, { "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" }, "target": { "type": "string", "enum": [ "campaign_sequence" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|target|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "campaignId" ] } }, { "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" }, "target": { "type": "string", "enum": [ "campaign_leads" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|target|campaignId|offset|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "campaignId", "offset", "limit" ] } }, { "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" }, "target": { "type": "string", "enum": [ "campaigns_for_lead" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId|target|profileUrl|offset|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "profileUrl", "offset", "limit" ] } }, { "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" }, "target": { "type": "string", "enum": [ "lists" ] }, "listSearch": { "$ref": "#/$defs/SearchHeyReachListsInput" } }, "required": [ "workspaceId", "target", "listSearch" ], "patternProperties": { "^(?!(?:workspaceId|target|listSearch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "listSearch" ] } }, { "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" }, "target": { "type": "string", "enum": [ "list" ] }, "listId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "listId" ], "patternProperties": { "^(?!(?:workspaceId|target|listId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "listId" ] } }, { "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" }, "target": { "type": "string", "enum": [ "list_leads" ] }, "listId": { "$ref": "#/$defs/HeyReachId" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "listId" ], "patternProperties": { "^(?!(?:workspaceId|target|listId|offset|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "listId", "offset", "limit" ] } }, { "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" }, "target": { "type": "string", "enum": [ "lead" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId|target|profileUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "profileUrl" ] } }, { "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" }, "target": { "type": "string", "enum": [ "lead_tags" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId|target|profileUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "profileUrl" ] } }, { "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" }, "target": { "type": "string", "enum": [ "conversations" ] }, "conversationSearch": { "$ref": "#/$defs/SearchHeyReachConversationsInput" } }, "required": [ "workspaceId", "target", "conversationSearch" ], "patternProperties": { "^(?!(?:workspaceId|target|conversationSearch)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "conversationSearch" ] } }, { "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" }, "target": { "type": "string", "enum": [ "conversation" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "conversationId": { "$ref": "#/$defs/HeyReachConversationId" } }, "required": [ "workspaceId", "target", "accountId", "conversationId" ], "patternProperties": { "^(?!(?:workspaceId|target|accountId|conversationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "accountId", "conversationId" ] } }, { "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" }, "target": { "type": "string", "enum": [ "is_connection" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "accountId", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId|target|accountId|profileUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "accountId", "profileUrl" ] } }, { "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" }, "target": { "type": "string", "enum": [ "stats" ] }, "stats": { "$ref": "#/$defs/HeyReachStatsInput" } }, "required": [ "workspaceId", "target", "stats" ], "patternProperties": { "^(?!(?:workspaceId|target|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "stats" ] } }, { "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" }, "target": { "type": "string", "enum": [ "stats_by_campaign" ] }, "stats": { "$ref": "#/$defs/HeyReachStatsInput" } }, "required": [ "workspaceId", "target", "stats" ], "patternProperties": { "^(?!(?:workspaceId|target|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "stats" ] } }, { "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" }, "target": { "type": "string", "enum": [ "enrichment_job" ] }, "jobId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "jobId" ], "patternProperties": { "^(?!(?:workspaceId|target|jobId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "jobId" ] } }, { "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" }, "target": { "type": "string", "enum": [ "events" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId|target|offset|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "target", "offset", "limit" ] } } ], "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachCampaignStatus": { "type": "string", "enum": [ "DRAFT", "IN_PROGRESS", "PAUSED", "FINISHED", "CANCELED", "FAILED", "STARTING", "SCHEDULED" ] }, "SearchHeyReachCampaignsInput": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 }, "statuses": { "type": "array", "items": { "$ref": "#/$defs/HeyReachCampaignStatus" }, "maxItems": 8 }, "accountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 } }, "patternProperties": { "^(?!(?:offset|limit|keyword|statuses|accountIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "keyword", "statuses", "accountIds" ] } }, "LinkedInProfileUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "HeyReachListType": { "type": "string", "enum": [ "USER_LIST", "COMPANY_LIST" ] }, "SearchHeyReachListsInput": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 }, "listType": { "$ref": "#/$defs/HeyReachListType" }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 } }, "patternProperties": { "^(?!(?:offset|limit|keyword|listType|campaignIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "keyword", "listType", "campaignIds" ] } }, "HeyReachInstant": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d+)?)?(?:Z|[+-]\\d{2}:\\d{2})$" }, "SearchHeyReachConversationsInput": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4000 }, { "type": "null" } ] }, "from": { "$ref": "#/$defs/HeyReachInstant" }, "to": { "$ref": "#/$defs/HeyReachInstant" }, "filters": { "type": "object", "properties": { "linkedInAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "searchString": { "type": "string", "minLength": 0, "maxLength": 500 }, "leadLinkedInId": { "type": "string", "minLength": 1, "maxLength": 200 }, "leadProfileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "tags": { "type": "array", "items": { "type": "string", "minLength": 0, "maxLength": 100 }, "maxItems": 100 }, "latestAutoTagNames": { "type": "array", "items": { "type": "string", "minLength": 0, "maxLength": 100 }, "maxItems": 100 }, "seen": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:linkedInAccountIds|campaignIds|searchString|leadLinkedInId|leadProfileUrl|tags|latestAutoTagNames|seen)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "linkedInAccountIds", "campaignIds", "searchString", "leadLinkedInId", "leadProfileUrl", "tags", "latestAutoTagNames", "seen" ] } } }, "patternProperties": { "^(?!(?:limit|cursor|from|to|filters)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "cursor", "from", "to", "filters" ] } }, "HeyReachConversationId": { "type": "string", "minLength": 1, "maxLength": 2000 }, "HeyReachStatsInput": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "startDate": { "$ref": "#/$defs/HeyReachInstant" }, "endDate": { "$ref": "#/$defs/HeyReachInstant" } }, "required": [ "startDate", "endDate" ], "patternProperties": { "^(?!(?:accountIds|campaignIds|startDate|endDate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "accountIds", "campaignIds", "startDate", "endDate" ] } } } } ``` ### 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" }, "target": { "type": "string", "enum": [ "connection" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target" ] }, { "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" }, "target": { "type": "string", "enum": [ "proxy_countries" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target" ] }, { "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" }, "target": { "type": "string", "enum": [ "webhooks" ] } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target" ] }, { "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" }, "target": { "type": "string", "enum": [ "accounts" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|offset|limit|keyword)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "offset", "limit", "keyword" ] }, { "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" }, "target": { "type": "string", "enum": [ "account" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|accountId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "accountId" ] }, { "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" }, "target": { "type": "string", "enum": [ "account_status" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|accountId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "accountId" ] }, { "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" }, "target": { "type": "string", "enum": [ "network" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "pageNumber": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "accountId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|accountId|pageNumber|pageSize)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "accountId", "pageNumber", "pageSize" ] }, { "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" }, "target": { "type": "string", "enum": [ "campaigns" ] }, "campaignSearch": { "$ref": "#/$defs/SearchHeyReachCampaignsInput" } }, "required": [ "workspaceId", "target", "campaignSearch" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|campaignSearch)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "campaignSearch" ] }, { "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" }, "target": { "type": "string", "enum": [ "campaign" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "campaignId" ] }, { "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" }, "target": { "type": "string", "enum": [ "campaign_sequence" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|campaignId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "campaignId" ] }, { "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" }, "target": { "type": "string", "enum": [ "campaign_leads" ] }, "campaignId": { "$ref": "#/$defs/HeyReachId" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|campaignId|offset|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "campaignId", "offset", "limit" ] }, { "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" }, "target": { "type": "string", "enum": [ "campaigns_for_lead" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|profileUrl|offset|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "profileUrl", "offset", "limit" ] }, { "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" }, "target": { "type": "string", "enum": [ "lists" ] }, "listSearch": { "$ref": "#/$defs/SearchHeyReachListsInput" } }, "required": [ "workspaceId", "target", "listSearch" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|listSearch)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "listSearch" ] }, { "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" }, "target": { "type": "string", "enum": [ "list" ] }, "listId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "listId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|listId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "listId" ] }, { "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" }, "target": { "type": "string", "enum": [ "list_leads" ] }, "listId": { "$ref": "#/$defs/HeyReachId" }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target", "listId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|listId|offset|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "listId", "offset", "limit" ] }, { "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" }, "target": { "type": "string", "enum": [ "lead" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|profileUrl)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "profileUrl" ] }, { "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" }, "target": { "type": "string", "enum": [ "lead_tags" ] }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|profileUrl)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "profileUrl" ] }, { "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" }, "target": { "type": "string", "enum": [ "conversations" ] }, "conversationSearch": { "$ref": "#/$defs/SearchHeyReachConversationsInput" } }, "required": [ "workspaceId", "target", "conversationSearch" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|conversationSearch)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "conversationSearch" ] }, { "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" }, "target": { "type": "string", "enum": [ "conversation" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "conversationId": { "$ref": "#/$defs/HeyReachConversationId" } }, "required": [ "workspaceId", "target", "accountId", "conversationId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|accountId|conversationId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "accountId", "conversationId" ] }, { "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" }, "target": { "type": "string", "enum": [ "is_connection" ] }, "accountId": { "$ref": "#/$defs/HeyReachId" }, "profileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" } }, "required": [ "workspaceId", "target", "accountId", "profileUrl" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|accountId|profileUrl)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "accountId", "profileUrl" ] }, { "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" }, "target": { "type": "string", "enum": [ "stats" ] }, "stats": { "$ref": "#/$defs/HeyReachStatsInput" } }, "required": [ "workspaceId", "target", "stats" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|stats)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "stats" ] }, { "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" }, "target": { "type": "string", "enum": [ "stats_by_campaign" ] }, "stats": { "$ref": "#/$defs/HeyReachStatsInput" } }, "required": [ "workspaceId", "target", "stats" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|stats)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "stats" ] }, { "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" }, "target": { "type": "string", "enum": [ "enrichment_job" ] }, "jobId": { "$ref": "#/$defs/HeyReachId" } }, "required": [ "workspaceId", "target", "jobId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|jobId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "jobId" ] }, { "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" }, "target": { "type": "string", "enum": [ "events" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "target" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|target|offset|limit)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "target", "offset", "limit" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachCampaignStatus": { "type": "string", "enum": [ "DRAFT", "IN_PROGRESS", "PAUSED", "FINISHED", "CANCELED", "FAILED", "STARTING", "SCHEDULED" ] }, "SearchHeyReachCampaignsInput": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 }, "statuses": { "type": "array", "items": { "$ref": "#/$defs/HeyReachCampaignStatus" }, "maxItems": 8 }, "accountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 } }, "patternProperties": { "^(?!(?:offset|limit|keyword|statuses|accountIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "keyword", "statuses", "accountIds" ] } }, "LinkedInProfileUrl": { "type": "string", "minLength": 1, "maxLength": 2048 }, "HeyReachListType": { "type": "string", "enum": [ "USER_LIST", "COMPANY_LIST" ] }, "SearchHeyReachListsInput": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "keyword": { "type": "string", "minLength": 1, "maxLength": 200 }, "listType": { "$ref": "#/$defs/HeyReachListType" }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 } }, "patternProperties": { "^(?!(?:offset|limit|keyword|listType|campaignIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "keyword", "listType", "campaignIds" ] } }, "HeyReachInstant": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}(?::\\d{2}(?:\\.\\d+)?)?(?:Z|[+-]\\d{2}:\\d{2})$" }, "SearchHeyReachConversationsInput": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4000 }, { "type": "null" } ] }, "from": { "$ref": "#/$defs/HeyReachInstant" }, "to": { "$ref": "#/$defs/HeyReachInstant" }, "filters": { "type": "object", "properties": { "linkedInAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "searchString": { "type": "string", "minLength": 0, "maxLength": 500 }, "leadLinkedInId": { "type": "string", "minLength": 1, "maxLength": 200 }, "leadProfileUrl": { "$ref": "#/$defs/LinkedInProfileUrl" }, "tags": { "type": "array", "items": { "type": "string", "minLength": 0, "maxLength": 100 }, "maxItems": 100 }, "latestAutoTagNames": { "type": "array", "items": { "type": "string", "minLength": 0, "maxLength": 100 }, "maxItems": 100 }, "seen": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:linkedInAccountIds|campaignIds|searchString|leadLinkedInId|leadProfileUrl|tags|latestAutoTagNames|seen)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "linkedInAccountIds", "campaignIds", "searchString", "leadLinkedInId", "leadProfileUrl", "tags", "latestAutoTagNames", "seen" ] } } }, "patternProperties": { "^(?!(?:limit|cursor|from|to|filters)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "cursor", "from", "to", "filters" ] } }, "HeyReachConversationId": { "type": "string", "minLength": 1, "maxLength": 2000 }, "HeyReachStatsInput": { "type": "object", "properties": { "accountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "minItems": 0, "maxItems": 100 }, "startDate": { "$ref": "#/$defs/HeyReachInstant" }, "endDate": { "$ref": "#/$defs/HeyReachInstant" } }, "required": [ "startDate", "endDate" ], "patternProperties": { "^(?!(?:accountIds|campaignIds|startDate|endDate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "accountIds", "campaignIds", "startDate", "endDate" ] } } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HeyReachConnectionStatus": { "type": "object", "properties": { "connected": { "type": "boolean" }, "replyWebhookReady": { "type": "boolean" }, "connectionId": { "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" } ] }, "credential": { "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": { "$ref": "#/$defs/NonEmptyString" }, "kind": { "$ref": "#/$defs/NonEmptyString" }, "status": { "type": "string", "enum": [ "connected", "needs_reauthorization", "disabled", "disconnected" ] }, "fingerprint": { "$ref": "#/$defs/NonEmptyString" }, "lastFour": { "type": "string", "pattern": "^.{4}$" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "lastUsedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "provider", "kind", "status", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|provider|kind|status|fingerprint|lastFour|createdAt|updatedAt|lastUsedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "provider", "kind", "status", "fingerprint", "lastFour", "createdAt", "updatedAt", "lastUsedAt" ] } }, { "type": "null" } ] }, "connectedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastCheckedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "connected", "replyWebhookReady", "connectionId", "credential", "connectedAt", "lastCheckedAt" ], "patternProperties": { "^(?!(?:connected|replyWebhookReady|connectionId|credential|connectedAt|lastCheckedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "replyWebhookReady", "connectionId", "credential", "connectedAt", "lastCheckedAt" ] } }, "HeyReachId": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "HeyReachText": { "type": "string", "minLength": 0, "maxLength": 10000 }, "HeyReachAccount": { "type": "object", "properties": { "id": { "$ref": "#/$defs/HeyReachId" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "profileUrl": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "isActive": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "authIsValid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "activeCampaigns": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "isValidNavigator": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "isValidRecruiter": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "accountLimits": { "anyOf": [ { "type": "object", "additionalProperties": { "type": "number" } }, { "type": "null" } ] } }, "required": [ "id", "firstName", "lastName", "emailAddress", "profileUrl", "isActive", "authIsValid", "activeCampaigns", "isValidNavigator", "isValidRecruiter", "accountLimits" ], "patternProperties": { "^(?!(?:id|firstName|lastName|emailAddress|profileUrl|isActive|authIsValid|activeCampaigns|isValidNavigator|isValidRecruiter|accountLimits)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "firstName", "lastName", "emailAddress", "profileUrl", "isActive", "authIsValid", "activeCampaigns", "isValidNavigator", "isValidRecruiter", "accountLimits" ] } }, "HeyReachAccountPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachAccount" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "totalCount" ], "patternProperties": { "^(?!(?:items|totalCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount" ] } }, "HeyReachProxyCountryList": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/HeyReachText" }, "code": { "$ref": "#/$defs/HeyReachText" } }, "required": [ "name", "code" ], "patternProperties": { "^(?!(?:name|code)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "code" ] } }, "maxItems": 500 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, "HeyReachCampaign": { "type": "object", "properties": { "id": { "$ref": "#/$defs/HeyReachId" }, "name": { "$ref": "#/$defs/HeyReachText" }, "status": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "creationTime": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "linkedInUserListId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] }, "linkedInUserListName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "campaignAccountIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "maxItems": 1000 }, "progressStats": { "anyOf": [ { "type": "object", "properties": { "totalUsers": { "type": "number", "minimum": 0 }, "totalUsersInProgress": { "type": "number", "minimum": 0 }, "totalUsersPending": { "type": "number", "minimum": 0 }, "totalUsersFinished": { "type": "number", "minimum": 0 }, "totalUsersFailed": { "type": "number", "minimum": 0 } }, "required": [ "totalUsers", "totalUsersInProgress", "totalUsersPending", "totalUsersFinished", "totalUsersFailed" ], "patternProperties": { "^(?!(?:totalUsers|totalUsersInProgress|totalUsersPending|totalUsersFinished|totalUsersFailed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalUsers", "totalUsersInProgress", "totalUsersPending", "totalUsersFinished", "totalUsersFailed" ] } }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "creationTime", "linkedInUserListId", "linkedInUserListName", "campaignAccountIds", "progressStats" ], "patternProperties": { "^(?!(?:id|name|status|creationTime|linkedInUserListId|linkedInUserListName|campaignAccountIds|progressStats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "creationTime", "linkedInUserListId", "linkedInUserListName", "campaignAccountIds", "progressStats" ] } }, "HeyReachCampaignPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachCampaign" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "totalCount" ], "patternProperties": { "^(?!(?:items|totalCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount" ] } }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "HeyReachDocument": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "HeyReachDocumentPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachDocument" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "totalCount" ], "patternProperties": { "^(?!(?:items|totalCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount" ] } }, "HeyReachList": { "type": "object", "properties": { "id": { "$ref": "#/$defs/HeyReachId" }, "name": { "$ref": "#/$defs/HeyReachText" }, "totalItemsCount": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "count": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "listType": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "creationTime": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "campaignIds": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "maxItems": 1000 }, { "type": "null" } ] } }, "required": [ "id", "name", "totalItemsCount", "count", "listType", "creationTime", "campaignIds" ], "patternProperties": { "^(?!(?:id|name|totalItemsCount|count|listType|creationTime|campaignIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "totalItemsCount", "count", "listType", "creationTime", "campaignIds" ] } }, "HeyReachListPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachList" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "totalCount" ], "patternProperties": { "^(?!(?:items|totalCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount" ] } }, "HeyReachLeadTags": { "type": "object", "properties": { "tags": { "type": "array", "items": { "$ref": "#/$defs/HeyReachText" }, "maxItems": 1000 } }, "required": [ "tags" ], "patternProperties": { "^(?!(?:tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "tags" ] } ] } }, "HeyReachConversationId": { "type": "string", "minLength": 1, "maxLength": 2000 }, "HeyReachProfile": { "type": "object", "properties": { "id": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "linkedinId": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "profileUrl": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "headline": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "imageUrl": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "$ref": "#/$defs/HeyReachText" }, "maxItems": 1000 }, "customFields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[A-Za-z0-9_]+$", "maxLength": 100 }, "value": { "type": "string", "minLength": 0, "maxLength": 10000 } }, "required": [ "name", "value" ], "patternProperties": { "^(?!(?:name|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "value" ] } }, "maxItems": 100 } }, "required": [ "id", "linkedinId", "profileUrl", "firstName", "lastName", "headline", "imageUrl", "companyName", "emailAddress", "tags", "customFields" ], "patternProperties": { "^(?!(?:id|linkedinId|profileUrl|firstName|lastName|headline|imageUrl|companyName|emailAddress|tags|customFields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "linkedinId", "profileUrl", "firstName", "lastName", "headline", "imageUrl", "companyName", "emailAddress", "tags", "customFields" ] } }, "HeyReachMessage": { "type": "object", "properties": { "createdAt": { "$ref": "#/$defs/HeyReachText" }, "body": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "subject": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "sender": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "isInMail": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "createdAt", "body", "subject", "sender", "isInMail" ], "patternProperties": { "^(?!(?:createdAt|body|subject|sender|isInMail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "createdAt", "body", "subject", "sender", "isInMail" ] } }, "HeyReachConversation": { "type": "object", "properties": { "id": { "$ref": "#/$defs/HeyReachConversationId" }, "linkedInAccountId": { "$ref": "#/$defs/HeyReachId" }, "read": { "type": "boolean" }, "groupChat": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "blockedByMe": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "blockedByParticipant": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "lastMessageAt": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "lastMessageText": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "lastMessageSender": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "totalMessages": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "campaignId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] }, "correspondentProfile": { "anyOf": [ { "$ref": "#/$defs/HeyReachProfile" }, { "type": "null" } ] }, "linkedInAccount": { "anyOf": [ { "$ref": "#/$defs/HeyReachAccount" }, { "type": "null" } ] }, "messages": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/HeyReachMessage" }, "maxItems": 1000 }, { "type": "null" } ] } }, "required": [ "id", "linkedInAccountId", "read", "groupChat", "blockedByMe", "blockedByParticipant", "lastMessageAt", "lastMessageText", "lastMessageSender", "totalMessages", "campaignId", "correspondentProfile", "linkedInAccount", "messages" ], "patternProperties": { "^(?!(?:id|linkedInAccountId|read|groupChat|blockedByMe|blockedByParticipant|lastMessageAt|lastMessageText|lastMessageSender|totalMessages|campaignId|correspondentProfile|linkedInAccount|messages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "linkedInAccountId", "read", "groupChat", "blockedByMe", "blockedByParticipant", "lastMessageAt", "lastMessageText", "lastMessageSender", "totalMessages", "campaignId", "correspondentProfile", "linkedInAccount", "messages" ] } }, "HeyReachConversationPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachConversation" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextCursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4000 }, { "type": "null" } ] }, "hasNextPage": { "type": "boolean" } }, "required": [ "items", "totalCount", "nextCursor", "hasNextPage" ], "patternProperties": { "^(?!(?:items|totalCount|nextCursor|hasNextPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount", "nextCursor", "hasNextPage" ] } }, "HeyReachConnectionCheck": { "type": "object", "properties": { "isConnection": { "type": "boolean" } }, "required": [ "isConnection" ], "patternProperties": { "^(?!(?:isConnection)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "isConnection" ] } ] } }, "HeyReachStats": { "type": "object", "properties": { "overallStats": { "type": "object", "additionalProperties": { "type": "number" } }, "byDayStats": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "number" } } } }, "required": [ "overallStats", "byDayStats" ], "patternProperties": { "^(?!(?:overallStats|byDayStats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "overallStats", "byDayStats" ] } }, "HeyReachEnrichmentJob": { "type": "object", "properties": { "jobId": { "$ref": "#/$defs/HeyReachId" }, "status": { "type": "string", "enum": [ "PENDING", "IN_PROGRESS", "COMPLETED", "FAILED" ] }, "data": { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "ENRICHED", "EMAIL_NOT_FOUND", "CANCELLED", "FAILED" ] }, "message": { "$ref": "#/$defs/HeyReachText" }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/HeyReachText" }, { "type": "null" } ] }, "memberId": { "$ref": "#/$defs/HeyReachText" }, "profileUrl": { "$ref": "#/$defs/HeyReachText" } }, "required": [ "status", "message", "emailAddress", "memberId", "profileUrl" ], "patternProperties": { "^(?!(?:status|message|emailAddress|memberId|profileUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "message", "emailAddress", "memberId", "profileUrl" ] } }, { "type": "null" } ] } }, "required": [ "jobId", "status", "data" ], "patternProperties": { "^(?!(?:jobId|status|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "jobId", "status", "data" ] } }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "HeyReachWebhookEventType": { "type": "string", "enum": [ "CONNECTION_REQUEST_SENT", "CONNECTION_REQUEST_ACCEPTED", "MESSAGE_SENT", "MESSAGE_REPLY_RECEIVED", "INMAIL_SENT", "INMAIL_REPLY_RECEIVED", "EVERY_MESSAGE_REPLY_RECEIVED", "FOLLOW_SENT", "LIKED_POST", "VIEWED_PROFILE", "CAMPAIGN_COMPLETED", "LEAD_TAG_UPDATED" ] }, "HeyReachEvent": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "webhookId": { "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" } ] }, "eventType": { "$ref": "#/$defs/HeyReachWebhookEventType" }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "payload": { "$ref": "#/$defs/HeyReachDocument" } }, "required": [ "id", "webhookId", "eventType", "receivedAt", "payload" ], "patternProperties": { "^(?!(?:id|webhookId|eventType|receivedAt|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "webhookId", "eventType", "receivedAt", "payload" ] } }, "HeyReachEventPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachEvent" }, "maxItems": 100 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "totalCount" ], "patternProperties": { "^(?!(?:items|totalCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "totalCount" ] } }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HeyReachWebhookStatus": { "type": "string", "enum": [ "pending", "active", "failed", "deleting" ] }, "HeyReachWebhook": { "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" }, "remoteId": { "anyOf": [ { "$ref": "#/$defs/HeyReachId" }, { "type": "null" } ] }, "name": { "$ref": "#/$defs/ShortText" }, "eventType": { "$ref": "#/$defs/HeyReachWebhookEventType" }, "campaignIds": { "type": "array", "items": { "$ref": "#/$defs/HeyReachId" }, "maxItems": 100 }, "status": { "$ref": "#/$defs/HeyReachWebhookStatus" }, "lastReceivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "remoteId", "name", "eventType", "campaignIds", "status", "lastReceivedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|remoteId|name|eventType|campaignIds|status|lastReceivedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "remoteId", "name", "eventType", "campaignIds", "status", "lastReceivedAt", "createdAt" ] } }, "HeyReachWebhookList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/$defs/HeyReachWebhook" }, "maxItems": 200 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/HeyReachConnectionStatus" }, { "$ref": "#/$defs/HeyReachAccountPage" }, { "$ref": "#/$defs/HeyReachAccount" }, { "$ref": "#/$defs/HeyReachProxyCountryList" }, { "$ref": "#/$defs/HeyReachCampaignPage" }, { "$ref": "#/$defs/HeyReachCampaign" }, { "$ref": "#/$defs/HeyReachDocumentPage" }, { "$ref": "#/$defs/HeyReachListPage" }, { "$ref": "#/$defs/HeyReachList" }, { "$ref": "#/$defs/HeyReachLeadTags" }, { "$ref": "#/$defs/HeyReachConversationPage" }, { "$ref": "#/$defs/HeyReachConversation" }, { "$ref": "#/$defs/HeyReachConnectionCheck" }, { "$ref": "#/$defs/HeyReachStats" }, { "$ref": "#/$defs/HeyReachEnrichmentJob" }, { "$ref": "#/$defs/HeyReachEventPage" }, { "$ref": "#/$defs/HeyReachWebhookList" }, { "$ref": "#/$defs/HeyReachDocument" } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/HeyReachConnectionStatus" }, { "$ref": "#/$defs/HeyReachAccountPage" }, { "$ref": "#/$defs/HeyReachAccount" }, { "$ref": "#/$defs/HeyReachProxyCountryList" }, { "$ref": "#/$defs/HeyReachCampaignPage" }, { "$ref": "#/$defs/HeyReachCampaign" }, { "$ref": "#/$defs/HeyReachDocumentPage" }, { "$ref": "#/$defs/HeyReachListPage" }, { "$ref": "#/$defs/HeyReachList" }, { "$ref": "#/$defs/HeyReachLeadTags" }, { "$ref": "#/$defs/HeyReachConversationPage" }, { "$ref": "#/$defs/HeyReachConversation" }, { "$ref": "#/$defs/HeyReachConnectionCheck" }, { "$ref": "#/$defs/HeyReachStats" }, { "$ref": "#/$defs/HeyReachEnrichmentJob" }, { "$ref": "#/$defs/HeyReachEventPage" }, { "$ref": "#/$defs/HeyReachWebhookList" }, { "$ref": "#/$defs/HeyReachDocument" } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `heyreachConnection.status`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/status` - `heyreachAccounts.list`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts` - `heyreachAccounts.get`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId` - `heyreachAccounts.status`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId/status` - `heyreachAccounts.proxyCountries`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts/proxy-countries` - `heyreachCampaigns.list`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/search` - `heyreachCampaigns.get`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId` - `heyreachCampaigns.sequence`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/sequence` - `heyreachCampaigns.leads`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/:campaignId/leads` - `heyreachCampaigns.forLead`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/campaigns/for-lead` - `heyreachLists.list`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/lists/search` - `heyreachLists.get`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/lists/:listId` - `heyreachLists.leads`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/lists/:listId/leads` - `heyreachLeads.lookup`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/leads/lookup` - `heyreachLeads.tags`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/leads/tags` - `heyreachConversations.list`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/conversations/search` - `heyreachConversations.get`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId/conversations/:conversationId` - `heyreachInsights.network`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/accounts/:accountId/network` - `heyreachInsights.isConnection`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/network/connection` - `heyreachInsights.stats`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/statistics` - `heyreachInsights.statsByCampaign`: `POST /v1/workspaces/:workspaceId/integrations/heyreach/statistics/by-campaign` - `heyreachInsights.enrichStatus`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/enrichment/:jobId` - `heyreachInsights.events`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/events` - `heyreachWebhooks.list`: `GET /v1/workspaces/:workspaceId/integrations/heyreach/webhooks` ## read_inbox_health Reads workspace inboxes, aggregate stats, per-inbox row stats, analytics, recent-health alerts, deliverability state, placement runs, and subscription targets. Choose action for one native read; use batch_row_stats for up to 100 visible inbox IDs; omit it for a paginated inbox list plus aggregate stats. Filters apply only to the list; stats cover the Workspace. Use returned pagination for further pages. When the caller wants to mutate settings or dispatch work. Scopes: inbox:read, analytics:read, unibox:read Risk: read; confirmation: none; idempotency: none. ### 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": [ "overview" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "sortBy": { "type": "string", "enum": [ "emailAddress", "status", "dailySendingLimit", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "$ref": "#/$defs/ShortText" }, "tagIds": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|action|offset|limit|search|sortBy|sortOrder|provider|statuses|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "offset", "limit", "search", "sortBy", "sortOrder", "provider", "statuses", "tagIds" ] } }, { "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": [ "list" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "sortBy": { "type": "string", "enum": [ "emailAddress", "status", "dailySendingLimit", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "$ref": "#/$defs/ShortText" }, "tagIds": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|offset|limit|search|sortBy|sortOrder|provider|statuses|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "offset", "limit", "search", "sortBy", "sortOrder", "provider", "statuses", "tagIds" ] } }, { "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": [ "stats" ] } }, "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": [ "row_stats" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "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": [ "batch_row_stats" ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 } }, "required": [ "workspaceId", "action", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "account_analytics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "startDate": { "$ref": "#/$defs/LocalDate" }, "endDate": { "$ref": "#/$defs/LocalDate" }, "recipientProviders": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|startDate|endDate|recipientProviders)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "startDate", "endDate", "recipientProviders" ] } }, { "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": [ "warmup_analytics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "startDate": { "$ref": "#/$defs/LocalDate" }, "endDate": { "$ref": "#/$defs/LocalDate" }, "issuePage": { "type": "integer", "minimum": 1 }, "issuePageSize": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|startDate|endDate|issuePage|issuePageSize)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "startDate", "endDate", "issuePage", "issuePageSize" ] } }, { "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": [ "recent_health" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "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": [ "subscription_targets" ] } }, "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": [ "dns_status" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "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": [ "settings" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "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": [ "deliverability" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "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": [ "placement_diagnostics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "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": [ "export" ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 } }, "required": [ "workspaceId", "action", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxIds" ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } ``` ### 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": [ "overview" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "sortBy": { "type": "string", "enum": [ "emailAddress", "status", "dailySendingLimit", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "$ref": "#/$defs/ShortText" }, "tagIds": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|offset|limit|search|sortBy|sortOrder|provider|statuses|tagIds)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "offset", "limit", "search", "sortBy", "sortOrder", "provider", "statuses", "tagIds" ] }, { "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": [ "list" ] }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "search": { "$ref": "#/$defs/ShortText" }, "sortBy": { "type": "string", "enum": [ "emailAddress", "status", "dailySendingLimit", "createdAt", "updatedAt" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "provider": { "type": "string", "enum": [ "all", "google_workspace", "microsoft_365", "other" ] }, "statuses": { "$ref": "#/$defs/ShortText" }, "tagIds": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|offset|limit|search|sortBy|sortOrder|provider|statuses|tagIds)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "offset", "limit", "search", "sortBy", "sortOrder", "provider", "statuses", "tagIds" ] }, { "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": [ "stats" ] } }, "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": [ "row_stats" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "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": [ "batch_row_stats" ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 } }, "required": [ "workspaceId", "action", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxIds)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxIds" ] }, { "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": [ "account_analytics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "startDate": { "$ref": "#/$defs/LocalDate" }, "endDate": { "$ref": "#/$defs/LocalDate" }, "recipientProviders": { "$ref": "#/$defs/ShortText" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|startDate|endDate|recipientProviders)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "startDate", "endDate", "recipientProviders" ] }, { "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": [ "warmup_analytics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "startDate": { "$ref": "#/$defs/LocalDate" }, "endDate": { "$ref": "#/$defs/LocalDate" }, "issuePage": { "type": "integer", "minimum": 1 }, "issuePageSize": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|startDate|endDate|issuePage|issuePageSize)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "startDate", "endDate", "issuePage", "issuePageSize" ] }, { "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": [ "recent_health" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "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": [ "subscription_targets" ] } }, "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": [ "dns_status" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "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": [ "settings" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "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": [ "deliverability" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "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": [ "placement_diagnostics" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "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": [ "export" ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 } }, "required": [ "workspaceId", "action", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxIds)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxIds" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "HexColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "inboxes": { "type": "object", "properties": { "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", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "warmupReputationScore": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } }, "deliveryStatus": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ok", "degraded", "blocked", "unknown" ] }, "detail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "detail" ], "patternProperties": { "^(?!(?:state|detail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "detail" ] } }, "dnsRecords": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|statusDetail|createdAt|updatedAt|senderFirstName|senderLastName|dailySendingLimit|minGapSeconds|warmupEnabled|warmupReputationScore|tags|deliveryStatus|dnsRecords|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus", "dnsRecords", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, "stats": { "type": "object", "properties": { "totalInboxes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDomains": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ], "patternProperties": { "^(?!(?:totalInboxes|totalDomains|warmupCount|errorCount|alertCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ] } } }, "required": [ "inboxes", "stats" ], "patternProperties": { "^(?!(?:inboxes|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxes", "stats" ] } }, { "type": "object", "properties": { "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", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "warmupReputationScore": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } }, "deliveryStatus": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ok", "degraded", "blocked", "unknown" ] }, "detail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "detail" ], "patternProperties": { "^(?!(?:state|detail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "detail" ] } }, "dnsRecords": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|statusDetail|createdAt|updatedAt|senderFirstName|senderLastName|dailySendingLimit|minGapSeconds|warmupEnabled|warmupReputationScore|tags|deliveryStatus|dnsRecords|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus", "dnsRecords", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "totalInboxes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDomains": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ], "patternProperties": { "^(?!(?:totalInboxes|totalDomains|warmupCount|errorCount|alertCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ] } }, { "type": "object", "properties": { "dailySentEmails": { "$ref": "#/$defs/ShortText" }, "sendLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sendLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sendRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalWarmupEmails": { "$ref": "#/$defs/ShortText" }, "initialWarmupEmails": { "$ref": "#/$defs/ShortText" }, "warmupLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailDeliverability": { "$ref": "#/$defs/ShortText" }, "replyRate": { "$ref": "#/$defs/ShortText" }, "totalCampaigns": { "$ref": "#/$defs/ShortText" } }, "required": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ], "patternProperties": { "^(?!(?:dailySentEmails|sendLimitToday|sendLimitTarget|sendRampDaysRemaining|totalWarmupEmails|initialWarmupEmails|warmupLimitToday|warmupLimitTarget|warmupRampDaysRemaining|warmupEmailDeliverability|replyRate|totalCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "stats": { "type": "object", "properties": { "dailySentEmails": { "$ref": "#/$defs/ShortText" }, "sendLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sendLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sendRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalWarmupEmails": { "$ref": "#/$defs/ShortText" }, "initialWarmupEmails": { "$ref": "#/$defs/ShortText" }, "warmupLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailDeliverability": { "$ref": "#/$defs/ShortText" }, "replyRate": { "$ref": "#/$defs/ShortText" }, "totalCampaigns": { "$ref": "#/$defs/ShortText" } }, "required": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ], "patternProperties": { "^(?!(?:dailySentEmails|sendLimitToday|sendLimitTarget|sendRampDaysRemaining|totalWarmupEmails|initialWarmupEmails|warmupLimitToday|warmupLimitTarget|warmupRampDaysRemaining|warmupEmailDeliverability|replyRate|totalCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ] } } }, "required": [ "inboxId", "stats" ], "patternProperties": { "^(?!(?:inboxId|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "stats" ] } }, "maxItems": 100 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "totalLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "leadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "leadsContactedPercentage": { "type": "number" }, "totalEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRate": { "type": "number" }, "replyRateWithOOO": { "type": "number" }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyRate": { "type": "number" }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceRate": { "type": "number" }, "newLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCompletedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalLeads", "leadsContacted", "leadsContactedPercentage", "totalEmailsSent", "replyCount", "replyCountWithOOO", "replyRate", "replyRateWithOOO", "positiveReplyCount", "positiveReplyRate", "bounceCount", "bounceRate", "newLeadsContacted", "totalCompletedLeads" ], "patternProperties": { "^(?!(?:totalLeads|leadsContacted|leadsContactedPercentage|totalEmailsSent|replyCount|replyCountWithOOO|replyRate|replyRateWithOOO|positiveReplyCount|positiveReplyRate|bounceCount|bounceRate|newLeadsContacted|totalCompletedLeads|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalLeads", "leadsContacted", "leadsContactedPercentage", "totalEmailsSent", "replyCount", "replyCountWithOOO", "replyRate", "replyRateWithOOO", "positiveReplyCount", "positiveReplyRate", "bounceCount", "bounceRate", "newLeadsContacted", "totalCompletedLeads", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } }, "dailyEmailSent": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "newLead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "newLead", "followUp" ], "patternProperties": { "^(?!(?:date|newLead|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "newLead", "followUp" ] } } }, "dailyMetrics": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount" ], "patternProperties": { "^(?!(?:date|replyCountWithOOO|replyCount|positiveReplyCount|bounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount" ] } } } }, "required": [ "summary", "dailyEmailSent", "dailyMetrics" ], "patternProperties": { "^(?!(?:summary|dailyEmailSent|dailyMetrics)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyEmailSent", "dailyMetrics" ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "receivedBySeeds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sentByUs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "neverArrived": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "awaitingConfirmation": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInInbox": { "type": "number" }, "landedInInboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInSpam": { "type": "number" }, "landedInSpamCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInTabs": { "type": "number" }, "landedInTabsCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "object", "properties": { "windowMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "observed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unavailable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pending": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spamRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tabsRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "windowMinutes", "eligible", "observed", "inbox", "spam", "tabs", "unavailable", "pending", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:windowMinutes|eligible|observed|inbox|spam|tabs|unavailable|pending|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windowMinutes", "eligible", "observed", "inbox", "spam", "tabs", "unavailable", "pending", "inboxRate", "spamRate", "tabsRate" ] } }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "seedReplies": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "receivedBySeeds", "warmupEmailsSent", "sentByUs", "neverArrived", "awaitingConfirmation", "landedInInbox", "landedInInboxCount", "landedInSpam", "landedInSpamCount", "landedInTabs", "landedInTabsCount", "followUp", "bouncedCount", "seedReplies" ], "patternProperties": { "^(?!(?:receivedBySeeds|warmupEmailsSent|sentByUs|neverArrived|awaitingConfirmation|landedInInbox|landedInInboxCount|landedInSpam|landedInSpamCount|landedInTabs|landedInTabsCount|followUp|bouncedCount|seedReplies)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "receivedBySeeds", "warmupEmailsSent", "sentByUs", "neverArrived", "awaitingConfirmation", "landedInInbox", "landedInInboxCount", "landedInSpam", "landedInSpamCount", "landedInTabs", "landedInTabsCount", "followUp", "bouncedCount", "seedReplies" ] } }, "dailyDeliverability": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUpEligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUpUnavailable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "sent", "received", "inbox", "spam", "tabs", "followUpEligible", "followUpUnavailable" ], "patternProperties": { "^(?!(?:date|sent|received|inbox|spam|tabs|followUpEligible|followUpUnavailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "sent", "received", "inbox", "spam", "tabs", "followUpEligible", "followUpUnavailable" ] } } }, "placementByProvider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ShortText" }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "type": "number" }, "spamRate": { "type": "number" }, "tabsRate": { "type": "number" } }, "required": [ "provider", "received", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:provider|received|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "received", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ] } } }, "sevenDayEngagement": { "type": "object", "properties": { "window": { "type": "object", "properties": { "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "hours": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "from", "to", "hours" ], "patternProperties": { "^(?!(?:from|to|hours)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "hours" ] } }, "pool": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] }, "desired": { "$ref": "#/$defs/Union_" }, "applied": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "$ref": "#/$defs/ShortText" }, "desiredPolicy": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "appliedPolicy": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "unsupportedControls": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "lastSyncAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastSyncError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "providerId", "status", "desiredPolicy", "appliedPolicy", "unsupportedControls", "lastSyncAt", "lastSyncError" ], "patternProperties": { "^(?!(?:providerId|status|desiredPolicy|appliedPolicy|unsupportedControls|lastSyncAt|lastSyncError)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "desiredPolicy", "appliedPolicy", "unsupportedControls", "lastSyncAt", "lastSyncError" ] } } }, "observed": { "type": "object", "properties": { "composition": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "html": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "rate" ], "patternProperties": { "^(?!(?:count|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "rate" ] } }, "tracked": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "eligible", "rate" ], "patternProperties": { "^(?!(?:count|eligible|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "eligible", "rate" ] } }, "signed": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "eligible", "rate" ], "patternProperties": { "^(?!(?:count|eligible|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "eligible", "rate" ] } } }, "required": [ "total", "html", "tracked", "signed" ], "patternProperties": { "^(?!(?:total|html|tracked|signed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "html", "tracked", "signed" ] } }, "warmupip": { "type": "object", "properties": { "delivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "opens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openRate": { "type": "number" }, "clickRate": { "type": "number" } }, "required": [ "delivered", "opens", "clicks", "openRate", "clickRate" ], "patternProperties": { "^(?!(?:delivered|opens|clicks|openRate|clickRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivered", "opens", "clicks", "openRate", "clickRate" ] } }, "internalMesh": { "type": "object", "properties": { "delivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "read": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "important": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rescuedFromSpam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "delivered", "read", "clicked", "replied", "important", "rescuedFromSpam" ], "patternProperties": { "^(?!(?:delivered|read|clicked|replied|important|rescuedFromSpam)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivered", "read", "clicked", "replied", "important", "rescuedFromSpam" ] } }, "localTracking": { "type": "object", "properties": { "opens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rawOpens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rawClicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "opens", "clicks", "rawOpens", "rawClicks" ], "patternProperties": { "^(?!(?:opens|clicks|rawOpens|rawClicks)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "opens", "clicks", "rawOpens", "rawClicks" ] } } }, "required": [ "composition", "warmupip", "internalMesh", "localTracking" ], "patternProperties": { "^(?!(?:composition|warmupip|internalMesh|localTracking)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "composition", "warmupip", "internalMesh", "localTracking" ] } } }, "required": [ "window", "pool", "desired", "applied", "observed" ], "patternProperties": { "^(?!(?:window|pool|desired|applied|observed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "window", "pool", "desired", "applied", "observed" ] } }, "deliveryIssues": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "bounced", "failed" ] }, "receiverEmail": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "status", "receiverEmail", "reason", "occurredAt" ], "patternProperties": { "^(?!(?:status|receiverEmail|reason|occurredAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "receiverEmail", "reason", "occurredAt" ] } } }, "deliveryIssuesPagination": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "page", "pageSize", "total", "totalPages" ], "patternProperties": { "^(?!(?:page|pageSize|total|totalPages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "page", "pageSize", "total", "totalPages" ] } } }, "required": [ "summary", "dailyDeliverability", "placementByProvider", "sevenDayEngagement", "deliveryIssues", "deliveryIssuesPagination" ], "patternProperties": { "^(?!(?:summary|dailyDeliverability|placementByProvider|sevenDayEngagement|deliveryIssues|deliveryIssuesPagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyDeliverability", "placementByProvider", "sevenDayEngagement", "deliveryIssues", "deliveryIssuesPagination" ] } }, { "type": "object", "properties": { "windows": { "type": "object", "properties": { "evaluatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "bounceRecentStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "bouncePreviousStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyRecentEnd": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyRecentStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyPreviousStart": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "evaluatedAt", "bounceRecentStart", "bouncePreviousStart", "replyRecentEnd", "replyRecentStart", "replyPreviousStart" ], "patternProperties": { "^(?!(?:evaluatedAt|bounceRecentStart|bouncePreviousStart|replyRecentEnd|replyRecentStart|replyPreviousStart)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "evaluatedAt", "bounceRecentStart", "bouncePreviousStart", "replyRecentEnd", "replyRecentStart", "replyPreviousStart" ] } }, "policy": { "type": "object", "properties": { "windowDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyObservationHours": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minBounceSends": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minBounces": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceRatePercent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceIncreasePoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minReplyContacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "windowDays", "replyObservationHours", "minBounceSends", "minBounces", "bounceRatePercent", "bounceIncreasePoints", "minReplyContacts" ], "patternProperties": { "^(?!(?:windowDays|replyObservationHours|minBounceSends|minBounces|bounceRatePercent|bounceIncreasePoints|minReplyContacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windowDays", "replyObservationHours", "minBounceSends", "minBounces", "bounceRatePercent", "bounceIncreasePoints", "minReplyContacts" ] } }, "alerts": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "inbox", "domain" ] }, "key": { "$ref": "#/$defs/ShortText" }, "label": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "code": { "type": "string", "enum": [ "high_bounce_rate", "bounce_rate_increase", "reply_rate_drop" ] }, "title": { "$ref": "#/$defs/ShortText" }, "description": { "$ref": "#/$defs/ShortText" }, "recommendation": { "$ref": "#/$defs/ShortText" }, "recent": { "type": "object", "properties": { "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "sent", "bounced", "contacts", "replied" ], "patternProperties": { "^(?!(?:sent|bounced|contacts|replied)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sent", "bounced", "contacts", "replied" ] } }, "previous": { "type": "object", "properties": { "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "sent", "bounced", "contacts", "replied" ], "patternProperties": { "^(?!(?:sent|bounced|contacts|replied)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sent", "bounced", "contacts", "replied" ] } } }, "required": [ "id", "scope", "key", "label", "code", "title", "description", "recommendation", "recent", "previous" ], "patternProperties": { "^(?!(?:id|scope|key|label|code|title|description|recommendation|recent|previous)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "scope", "key", "label", "code", "title", "description", "recommendation", "recent", "previous" ] } }, "maxItems": 100 }, "totalAlerts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "evaluatedScopes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "insufficientBounceSamples": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "insufficientReplySamples": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "windows", "policy", "alerts", "totalAlerts", "evaluatedScopes", "insufficientBounceSamples", "insufficientReplySamples" ], "patternProperties": { "^(?!(?:windows|policy|alerts|totalAlerts|evaluatedScopes|insufficientBounceSamples|insufficientReplySamples)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windows", "policy", "alerts", "totalAlerts", "evaluatedScopes", "insufficientBounceSamples", "insufficientReplySamples" ] } }, { "type": "object", "properties": { "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" }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] } }, "required": [ "id", "emailAddress", "status", "provider" ], "patternProperties": { "^(?!(?:id|emailAddress|status|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "status", "provider" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] }, "runId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "step": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "records": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "runId", "step", "progress", "records", "error" ], "patternProperties": { "^(?!(?:state|runId|step|progress|records|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "runId", "step", "progress", "records", "error" ] } }, { "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" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 120, "maximum": 21600 }, { "type": "null" } ] }, "initialDailyLimit": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 100 }, { "type": "null" } ] }, "dailyIncrement": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50 }, { "type": "null" } ] }, "campaignEmailRampUp": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "customTrackingDomainVerified": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "isPlacementTestRecipient": { "type": "boolean" }, "canSyncNonCampaignEmails": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } } }, "required": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ], "patternProperties": { "^(?!(?:id|emailAddress|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|signature|customVariables|customTrackingDomain|customTrackingDomainVerified|syncNonCampaignEmails|isPlacementTestRecipient|canSyncNonCampaignEmails|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "hetrixtools" ] }, "monitoredValues": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "run": { "type": "object", "properties": { "runId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] } }, "required": [ "runId", "state" ], "patternProperties": { "^(?!(?:runId|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "state" ] } }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "kind": { "type": "string", "enum": [ "sending_domain", "tracking_domain" ] }, "value": { "$ref": "#/$defs/ShortText" }, "provider": { "$ref": "#/$defs/ShortText" }, "lastCheckStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "lastCheckedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "checkedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "listedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warningCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "timeoutCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "listings": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "assetId": { "$ref": "#/$defs/OpaqueId" }, "listName": { "$ref": "#/$defs/ShortText" }, "info": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "detailUrl": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "firstListedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastSeenListedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "assetId", "listName", "info", "detailUrl", "firstListedAt", "lastSeenListedAt" ], "patternProperties": { "^(?!(?:id|assetId|listName|info|detailUrl|firstListedAt|lastSeenListedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "assetId", "listName", "info", "detailUrl", "firstListedAt", "lastSeenListedAt" ] } } } }, "required": [ "id", "kind", "value", "provider", "lastCheckStatus", "lastCheckedAt", "checkedCount", "listedCount", "warningCount", "timeoutCount", "lastError", "listings" ], "patternProperties": { "^(?!(?:id|kind|value|provider|lastCheckStatus|lastCheckedAt|checkedCount|listedCount|warningCount|timeoutCount|lastError|listings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "provider", "lastCheckStatus", "lastCheckedAt", "checkedCount", "listedCount", "warningCount", "timeoutCount", "lastError", "listings" ] } } } }, "required": [ "provider", "monitoredValues", "run", "assets" ], "patternProperties": { "^(?!(?:provider|monitoredValues|run|assets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "monitoredValues", "run", "assets" ] } }, { "type": "object", "properties": { "recipients": { "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", "other" ] } }, "required": [ "id", "emailAddress", "provider" ], "patternProperties": { "^(?!(?:id|emailAddress|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider" ] } } }, "tests": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "recipientInboxId": { "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" }, "subject": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "pending", "sending", "observing", "completed", "failed", "send_uncertain" ] }, "sentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "errorMessage": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "observations": { "type": "array", "items": { "type": "object", "properties": { "checkpointSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "placement": { "type": "string", "enum": [ "inbox", "tabs", "spam", "other", "not_found", "error" ] }, "isRead": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "observedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "checkpointSeconds", "placement", "isRead", "errorMessage", "observedAt" ], "patternProperties": { "^(?!(?:checkpointSeconds|placement|isRead|errorMessage|observedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "checkpointSeconds", "placement", "isRead", "errorMessage", "observedAt" ] } } } }, "required": [ "id", "recipientInboxId", "subject", "status", "sentAt", "createdAt", "errorMessage", "observations" ], "patternProperties": { "^(?!(?:id|recipientInboxId|subject|status|sentAt|createdAt|errorMessage|observations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "recipientInboxId", "subject", "status", "sentAt", "createdAt", "errorMessage", "observations" ] } } } }, "required": [ "recipients", "tests" ], "patternProperties": { "^(?!(?:recipients|tests)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recipients", "tests" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "dailyWarmupLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "tags": { "$ref": "#/$defs/ShortText" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "emailAddress", "provider", "status", "statusDetail", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "dailyWarmupLimit", "tags", "createdAt" ], "patternProperties": { "^(?!(?:emailAddress|provider|status|statusDetail|dailySendingLimit|minGapSeconds|warmupEnabled|dailyWarmupLimit|tags|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "provider", "status", "statusDetail", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "dailyWarmupLimit", "tags", "createdAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "inboxes": { "type": "object", "properties": { "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", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "warmupReputationScore": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } }, "deliveryStatus": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ok", "degraded", "blocked", "unknown" ] }, "detail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "detail" ], "patternProperties": { "^(?!(?:state|detail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "detail" ] } }, "dnsRecords": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|statusDetail|createdAt|updatedAt|senderFirstName|senderLastName|dailySendingLimit|minGapSeconds|warmupEnabled|warmupReputationScore|tags|deliveryStatus|dnsRecords|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus", "dnsRecords", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, "stats": { "type": "object", "properties": { "totalInboxes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDomains": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ], "patternProperties": { "^(?!(?:totalInboxes|totalDomains|warmupCount|errorCount|alertCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ] } } }, "required": [ "inboxes", "stats" ], "patternProperties": { "^(?!(?:inboxes|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxes", "stats" ] } }, { "type": "object", "properties": { "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", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "warmupReputationScore": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } }, "deliveryStatus": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "ok", "degraded", "blocked", "unknown" ] }, "detail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "detail" ], "patternProperties": { "^(?!(?:state|detail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "detail" ] } }, "dnsRecords": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status|statusDetail|createdAt|updatedAt|senderFirstName|senderLastName|dailySendingLimit|minGapSeconds|warmupEnabled|warmupReputationScore|tags|deliveryStatus|dnsRecords|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status", "statusDetail", "createdAt", "updatedAt", "senderFirstName", "senderLastName", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "warmupReputationScore", "tags", "deliveryStatus", "dnsRecords", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } } }, "pagination": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currentPage": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasNextPage": { "type": "boolean" }, "hasPreviousPage": { "type": "boolean" } }, "required": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ], "patternProperties": { "^(?!(?:total|totalPages|currentPage|pageSize|offset|hasNextPage|hasPreviousPage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "totalPages", "currentPage", "pageSize", "offset", "hasNextPage", "hasPreviousPage" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "totalInboxes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalDomains": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errorCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ], "patternProperties": { "^(?!(?:totalInboxes|totalDomains|warmupCount|errorCount|alertCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalInboxes", "totalDomains", "warmupCount", "errorCount", "alertCount" ] } }, { "type": "object", "properties": { "dailySentEmails": { "$ref": "#/$defs/ShortText" }, "sendLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sendLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sendRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalWarmupEmails": { "$ref": "#/$defs/ShortText" }, "initialWarmupEmails": { "$ref": "#/$defs/ShortText" }, "warmupLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailDeliverability": { "$ref": "#/$defs/ShortText" }, "replyRate": { "$ref": "#/$defs/ShortText" }, "totalCampaigns": { "$ref": "#/$defs/ShortText" } }, "required": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ], "patternProperties": { "^(?!(?:dailySentEmails|sendLimitToday|sendLimitTarget|sendRampDaysRemaining|totalWarmupEmails|initialWarmupEmails|warmupLimitToday|warmupLimitTarget|warmupRampDaysRemaining|warmupEmailDeliverability|replyRate|totalCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "stats": { "type": "object", "properties": { "dailySentEmails": { "$ref": "#/$defs/ShortText" }, "sendLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sendLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "sendRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalWarmupEmails": { "$ref": "#/$defs/ShortText" }, "initialWarmupEmails": { "$ref": "#/$defs/ShortText" }, "warmupLimitToday": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupLimitTarget": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupRampDaysRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailDeliverability": { "$ref": "#/$defs/ShortText" }, "replyRate": { "$ref": "#/$defs/ShortText" }, "totalCampaigns": { "$ref": "#/$defs/ShortText" } }, "required": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ], "patternProperties": { "^(?!(?:dailySentEmails|sendLimitToday|sendLimitTarget|sendRampDaysRemaining|totalWarmupEmails|initialWarmupEmails|warmupLimitToday|warmupLimitTarget|warmupRampDaysRemaining|warmupEmailDeliverability|replyRate|totalCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dailySentEmails", "sendLimitToday", "sendLimitTarget", "sendRampDaysRemaining", "totalWarmupEmails", "initialWarmupEmails", "warmupLimitToday", "warmupLimitTarget", "warmupRampDaysRemaining", "warmupEmailDeliverability", "replyRate", "totalCampaigns" ] } } }, "required": [ "inboxId", "stats" ], "patternProperties": { "^(?!(?:inboxId|stats)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "stats" ] } }, "maxItems": 100 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "totalLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "leadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "leadsContactedPercentage": { "type": "number" }, "totalEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRate": { "type": "number" }, "replyRateWithOOO": { "type": "number" }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyRate": { "type": "number" }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceRate": { "type": "number" }, "newLeadsContacted": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCompletedLeads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recipientBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "senderBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unclassifiedBounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "totalLeads", "leadsContacted", "leadsContactedPercentage", "totalEmailsSent", "replyCount", "replyCountWithOOO", "replyRate", "replyRateWithOOO", "positiveReplyCount", "positiveReplyRate", "bounceCount", "bounceRate", "newLeadsContacted", "totalCompletedLeads" ], "patternProperties": { "^(?!(?:totalLeads|leadsContacted|leadsContactedPercentage|totalEmailsSent|replyCount|replyCountWithOOO|replyRate|replyRateWithOOO|positiveReplyCount|positiveReplyRate|bounceCount|bounceRate|newLeadsContacted|totalCompletedLeads|recipientBounceCount|senderBounceCount|unclassifiedBounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "totalLeads", "leadsContacted", "leadsContactedPercentage", "totalEmailsSent", "replyCount", "replyCountWithOOO", "replyRate", "replyRateWithOOO", "positiveReplyCount", "positiveReplyRate", "bounceCount", "bounceRate", "newLeadsContacted", "totalCompletedLeads", "recipientBounceCount", "senderBounceCount", "unclassifiedBounceCount" ] } }, "dailyEmailSent": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "newLead": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "newLead", "followUp" ], "patternProperties": { "^(?!(?:date|newLead|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "newLead", "followUp" ] } } }, "dailyMetrics": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "replyCountWithOOO": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "positiveReplyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount" ], "patternProperties": { "^(?!(?:date|replyCountWithOOO|replyCount|positiveReplyCount|bounceCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "replyCountWithOOO", "replyCount", "positiveReplyCount", "bounceCount" ] } } } }, "required": [ "summary", "dailyEmailSent", "dailyMetrics" ], "patternProperties": { "^(?!(?:summary|dailyEmailSent|dailyMetrics)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyEmailSent", "dailyMetrics" ] } }, { "type": "object", "properties": { "summary": { "type": "object", "properties": { "receivedBySeeds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sentByUs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "neverArrived": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "awaitingConfirmation": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInInbox": { "type": "number" }, "landedInInboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInSpam": { "type": "number" }, "landedInSpamCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "landedInTabs": { "type": "number" }, "landedInTabsCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUp": { "type": "object", "properties": { "windowMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "observed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unavailable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pending": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spamRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "tabsRate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "windowMinutes", "eligible", "observed", "inbox", "spam", "tabs", "unavailable", "pending", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:windowMinutes|eligible|observed|inbox|spam|tabs|unavailable|pending|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windowMinutes", "eligible", "observed", "inbox", "spam", "tabs", "unavailable", "pending", "inboxRate", "spamRate", "tabsRate" ] } }, "bouncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "seedReplies": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "receivedBySeeds", "warmupEmailsSent", "sentByUs", "neverArrived", "awaitingConfirmation", "landedInInbox", "landedInInboxCount", "landedInSpam", "landedInSpamCount", "landedInTabs", "landedInTabsCount", "followUp", "bouncedCount", "seedReplies" ], "patternProperties": { "^(?!(?:receivedBySeeds|warmupEmailsSent|sentByUs|neverArrived|awaitingConfirmation|landedInInbox|landedInInboxCount|landedInSpam|landedInSpamCount|landedInTabs|landedInTabsCount|followUp|bouncedCount|seedReplies)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "receivedBySeeds", "warmupEmailsSent", "sentByUs", "neverArrived", "awaitingConfirmation", "landedInInbox", "landedInInboxCount", "landedInSpam", "landedInSpamCount", "landedInTabs", "landedInTabsCount", "followUp", "bouncedCount", "seedReplies" ] } }, "dailyDeliverability": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUpEligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "followUpUnavailable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "sent", "received", "inbox", "spam", "tabs", "followUpEligible", "followUpUnavailable" ], "patternProperties": { "^(?!(?:date|sent|received|inbox|spam|tabs|followUpEligible|followUpUnavailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "sent", "received", "inbox", "spam", "tabs", "followUpEligible", "followUpUnavailable" ] } } }, "placementByProvider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ShortText" }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "type": "number" }, "spamRate": { "type": "number" }, "tabsRate": { "type": "number" } }, "required": [ "provider", "received", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:provider|received|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "received", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ] } } }, "sevenDayEngagement": { "type": "object", "properties": { "window": { "type": "object", "properties": { "from": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "to": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "hours": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "from", "to", "hours" ], "patternProperties": { "^(?!(?:from|to|hours)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "hours" ] } }, "pool": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] }, "desired": { "$ref": "#/$defs/Union_" }, "applied": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "$ref": "#/$defs/ShortText" }, "desiredPolicy": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "appliedPolicy": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "unsupportedControls": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "lastSyncAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastSyncError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "providerId", "status", "desiredPolicy", "appliedPolicy", "unsupportedControls", "lastSyncAt", "lastSyncError" ], "patternProperties": { "^(?!(?:providerId|status|desiredPolicy|appliedPolicy|unsupportedControls|lastSyncAt|lastSyncError)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "desiredPolicy", "appliedPolicy", "unsupportedControls", "lastSyncAt", "lastSyncError" ] } } }, "observed": { "type": "object", "properties": { "composition": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "html": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "rate" ], "patternProperties": { "^(?!(?:count|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "rate" ] } }, "tracked": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "eligible", "rate" ], "patternProperties": { "^(?!(?:count|eligible|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "eligible", "rate" ] } }, "signed": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rate": { "type": "number" } }, "required": [ "count", "eligible", "rate" ], "patternProperties": { "^(?!(?:count|eligible|rate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "count", "eligible", "rate" ] } } }, "required": [ "total", "html", "tracked", "signed" ], "patternProperties": { "^(?!(?:total|html|tracked|signed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "html", "tracked", "signed" ] } }, "warmupip": { "type": "object", "properties": { "delivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "opens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "openRate": { "type": "number" }, "clickRate": { "type": "number" } }, "required": [ "delivered", "opens", "clicks", "openRate", "clickRate" ], "patternProperties": { "^(?!(?:delivered|opens|clicks|openRate|clickRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivered", "opens", "clicks", "openRate", "clickRate" ] } }, "internalMesh": { "type": "object", "properties": { "delivered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "read": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicked": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "important": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rescuedFromSpam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "delivered", "read", "clicked", "replied", "important", "rescuedFromSpam" ], "patternProperties": { "^(?!(?:delivered|read|clicked|replied|important|rescuedFromSpam)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "delivered", "read", "clicked", "replied", "important", "rescuedFromSpam" ] } }, "localTracking": { "type": "object", "properties": { "opens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "clicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rawOpens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rawClicks": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "opens", "clicks", "rawOpens", "rawClicks" ], "patternProperties": { "^(?!(?:opens|clicks|rawOpens|rawClicks)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "opens", "clicks", "rawOpens", "rawClicks" ] } } }, "required": [ "composition", "warmupip", "internalMesh", "localTracking" ], "patternProperties": { "^(?!(?:composition|warmupip|internalMesh|localTracking)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "composition", "warmupip", "internalMesh", "localTracking" ] } } }, "required": [ "window", "pool", "desired", "applied", "observed" ], "patternProperties": { "^(?!(?:window|pool|desired|applied|observed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "window", "pool", "desired", "applied", "observed" ] } }, "deliveryIssues": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "bounced", "failed" ] }, "receiverEmail": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "status", "receiverEmail", "reason", "occurredAt" ], "patternProperties": { "^(?!(?:status|receiverEmail|reason|occurredAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "receiverEmail", "reason", "occurredAt" ] } } }, "deliveryIssuesPagination": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageSize": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalPages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "page", "pageSize", "total", "totalPages" ], "patternProperties": { "^(?!(?:page|pageSize|total|totalPages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "page", "pageSize", "total", "totalPages" ] } } }, "required": [ "summary", "dailyDeliverability", "placementByProvider", "sevenDayEngagement", "deliveryIssues", "deliveryIssuesPagination" ], "patternProperties": { "^(?!(?:summary|dailyDeliverability|placementByProvider|sevenDayEngagement|deliveryIssues|deliveryIssuesPagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyDeliverability", "placementByProvider", "sevenDayEngagement", "deliveryIssues", "deliveryIssuesPagination" ] } }, { "type": "object", "properties": { "windows": { "type": "object", "properties": { "evaluatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "bounceRecentStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "bouncePreviousStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyRecentEnd": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyRecentStart": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "replyPreviousStart": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "evaluatedAt", "bounceRecentStart", "bouncePreviousStart", "replyRecentEnd", "replyRecentStart", "replyPreviousStart" ], "patternProperties": { "^(?!(?:evaluatedAt|bounceRecentStart|bouncePreviousStart|replyRecentEnd|replyRecentStart|replyPreviousStart)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "evaluatedAt", "bounceRecentStart", "bouncePreviousStart", "replyRecentEnd", "replyRecentStart", "replyPreviousStart" ] } }, "policy": { "type": "object", "properties": { "windowDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyObservationHours": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minBounceSends": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minBounces": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceRatePercent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounceIncreasePoints": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minReplyContacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "windowDays", "replyObservationHours", "minBounceSends", "minBounces", "bounceRatePercent", "bounceIncreasePoints", "minReplyContacts" ], "patternProperties": { "^(?!(?:windowDays|replyObservationHours|minBounceSends|minBounces|bounceRatePercent|bounceIncreasePoints|minReplyContacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windowDays", "replyObservationHours", "minBounceSends", "minBounces", "bounceRatePercent", "bounceIncreasePoints", "minReplyContacts" ] } }, "alerts": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ShortText" }, "scope": { "type": "string", "enum": [ "inbox", "domain" ] }, "key": { "$ref": "#/$defs/ShortText" }, "label": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "code": { "type": "string", "enum": [ "high_bounce_rate", "bounce_rate_increase", "reply_rate_drop" ] }, "title": { "$ref": "#/$defs/ShortText" }, "description": { "$ref": "#/$defs/ShortText" }, "recommendation": { "$ref": "#/$defs/ShortText" }, "recent": { "type": "object", "properties": { "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "sent", "bounced", "contacts", "replied" ], "patternProperties": { "^(?!(?:sent|bounced|contacts|replied)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sent", "bounced", "contacts", "replied" ] } }, "previous": { "type": "object", "properties": { "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "bounced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "sent", "bounced", "contacts", "replied" ], "patternProperties": { "^(?!(?:sent|bounced|contacts|replied)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sent", "bounced", "contacts", "replied" ] } } }, "required": [ "id", "scope", "key", "label", "code", "title", "description", "recommendation", "recent", "previous" ], "patternProperties": { "^(?!(?:id|scope|key|label|code|title|description|recommendation|recent|previous)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "scope", "key", "label", "code", "title", "description", "recommendation", "recent", "previous" ] } }, "maxItems": 100 }, "totalAlerts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "evaluatedScopes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "insufficientBounceSamples": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "insufficientReplySamples": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "windows", "policy", "alerts", "totalAlerts", "evaluatedScopes", "insufficientBounceSamples", "insufficientReplySamples" ], "patternProperties": { "^(?!(?:windows|policy|alerts|totalAlerts|evaluatedScopes|insufficientBounceSamples|insufficientReplySamples)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windows", "policy", "alerts", "totalAlerts", "evaluatedScopes", "insufficientBounceSamples", "insufficientReplySamples" ] } }, { "type": "object", "properties": { "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" }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] } }, "required": [ "id", "emailAddress", "status", "provider" ], "patternProperties": { "^(?!(?:id|emailAddress|status|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "status", "provider" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] }, "runId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "step": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "records": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "state", "runId", "step", "progress", "records", "error" ], "patternProperties": { "^(?!(?:state|runId|step|progress|records|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "runId", "step", "progress", "records", "error" ] } }, { "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" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 120, "maximum": 21600 }, { "type": "null" } ] }, "initialDailyLimit": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 100 }, { "type": "null" } ] }, "dailyIncrement": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50 }, { "type": "null" } ] }, "campaignEmailRampUp": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "customTrackingDomainVerified": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "isPlacementTestRecipient": { "type": "boolean" }, "canSyncNonCampaignEmails": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } } }, "required": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ], "patternProperties": { "^(?!(?:id|emailAddress|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|signature|customVariables|customTrackingDomain|customTrackingDomainVerified|syncNonCampaignEmails|isPlacementTestRecipient|canSyncNonCampaignEmails|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "hetrixtools" ] }, "monitoredValues": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "run": { "type": "object", "properties": { "runId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] } }, "required": [ "runId", "state" ], "patternProperties": { "^(?!(?:runId|state)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "state" ] } }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "kind": { "type": "string", "enum": [ "sending_domain", "tracking_domain" ] }, "value": { "$ref": "#/$defs/ShortText" }, "provider": { "$ref": "#/$defs/ShortText" }, "lastCheckStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "lastCheckedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "checkedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "listedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warningCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "timeoutCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastError": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "listings": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "assetId": { "$ref": "#/$defs/OpaqueId" }, "listName": { "$ref": "#/$defs/ShortText" }, "info": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "detailUrl": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "firstListedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastSeenListedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "assetId", "listName", "info", "detailUrl", "firstListedAt", "lastSeenListedAt" ], "patternProperties": { "^(?!(?:id|assetId|listName|info|detailUrl|firstListedAt|lastSeenListedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "assetId", "listName", "info", "detailUrl", "firstListedAt", "lastSeenListedAt" ] } } } }, "required": [ "id", "kind", "value", "provider", "lastCheckStatus", "lastCheckedAt", "checkedCount", "listedCount", "warningCount", "timeoutCount", "lastError", "listings" ], "patternProperties": { "^(?!(?:id|kind|value|provider|lastCheckStatus|lastCheckedAt|checkedCount|listedCount|warningCount|timeoutCount|lastError|listings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "provider", "lastCheckStatus", "lastCheckedAt", "checkedCount", "listedCount", "warningCount", "timeoutCount", "lastError", "listings" ] } } } }, "required": [ "provider", "monitoredValues", "run", "assets" ], "patternProperties": { "^(?!(?:provider|monitoredValues|run|assets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "monitoredValues", "run", "assets" ] } }, { "type": "object", "properties": { "recipients": { "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", "other" ] } }, "required": [ "id", "emailAddress", "provider" ], "patternProperties": { "^(?!(?:id|emailAddress|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider" ] } } }, "tests": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "recipientInboxId": { "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" }, "subject": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "pending", "sending", "observing", "completed", "failed", "send_uncertain" ] }, "sentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "errorMessage": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "observations": { "type": "array", "items": { "type": "object", "properties": { "checkpointSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "placement": { "type": "string", "enum": [ "inbox", "tabs", "spam", "other", "not_found", "error" ] }, "isRead": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "errorMessage": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "observedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "checkpointSeconds", "placement", "isRead", "errorMessage", "observedAt" ], "patternProperties": { "^(?!(?:checkpointSeconds|placement|isRead|errorMessage|observedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "checkpointSeconds", "placement", "isRead", "errorMessage", "observedAt" ] } } } }, "required": [ "id", "recipientInboxId", "subject", "status", "sentAt", "createdAt", "errorMessage", "observations" ], "patternProperties": { "^(?!(?:id|recipientInboxId|subject|status|sentAt|createdAt|errorMessage|observations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "recipientInboxId", "subject", "status", "sentAt", "createdAt", "errorMessage", "observations" ] } } } }, "required": [ "recipients", "tests" ], "patternProperties": { "^(?!(?:recipients|tests)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "recipients", "tests" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] }, "statusDetail": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "warmupEnabled": { "type": "boolean" }, "dailyWarmupLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "tags": { "$ref": "#/$defs/ShortText" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "emailAddress", "provider", "status", "statusDetail", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "dailyWarmupLimit", "tags", "createdAt" ], "patternProperties": { "^(?!(?:emailAddress|provider|status|statusDetail|dailySendingLimit|minGapSeconds|warmupEnabled|dailyWarmupLimit|tags|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "provider", "status", "statusDetail", "dailySendingLimit", "minGapSeconds", "warmupEnabled", "dailyWarmupLimit", "tags", "createdAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `inboxes.list`: `GET /v1/workspaces/:workspaceId/inboxes` - `inboxes.stats`: `GET /v1/workspaces/:workspaceId/inboxes/stats` - `inboxes.rowStats`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/row-stats` - `inboxes.batchRowStats`: `POST /v1/workspaces/:workspaceId/inboxes/row-stats/batch` - `inboxes.accountAnalytics`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/account-analytics` - `inboxes.warmupAnalytics`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/warmup-analytics` - `inboxes.recentHealth`: `GET /v1/workspaces/:workspaceId/inboxes/recent-health` - `inboxes.subscriptionTargets`: `GET /v1/workspaces/:workspaceId/inboxes/subscription-targets` - `inboxes.dnsCheckStatus`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/dns-check-status` - `inboxSettings.get`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/settings` - `inboxDeliverability.get`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/deliverability` - `inboxPlacementDiagnostics.get`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/placement-diagnostics` - `inboxBulk.export`: `POST /v1/workspaces/:workspaceId/inboxes/bulk/export` ## read_leads Read leads, their contact points, campaign/list membership views, timelines, and notes. Set view to list (default), get, campaign, lead_list, timeline, search, contact_points, or notes. Use view=list to page workspace leads (the default); choose get, campaign, lead_list, timeline, search, contact_points, or notes for the corresponding read. There is no bulk export; page with bounds instead. Hidden timeline sources are reported, not failures. Scopes: lead:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "view": { "type": "string", "enum": [ "list", "get", "campaign", "lead_list", "timeline", "search", "contact_points", "notes" ] }, "leadId": { "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" }, "leadListId": { "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" }, "campaignId": { "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": "string" }, "offset": { "type": "integer", "minimum": 0 }, "sortBy": { "type": "string", "enum": [ "firstName", "lastName", "company", "createdAt", "updatedAt", "email", "ladder", "rank" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "assigneeUserIds": { "type": "string" }, "cursorAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "cursorId": { "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" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|view|leadId|leadListId|campaignId|query|offset|sortBy|sortOrder|assigneeUserIds|cursorAt|cursorId|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "view", "leadId", "leadListId", "campaignId", "query", "offset", "sortBy", "sortOrder", "assigneeUserIds", "cursorAt", "cursorId", "cursor", "limit" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### 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" }, "view": { "type": "string", "enum": [ "list", "get", "campaign", "lead_list", "timeline", "search", "contact_points", "notes" ] }, "leadId": { "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" }, "leadListId": { "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" }, "campaignId": { "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": "string" }, "offset": { "type": "integer", "minimum": 0 }, "sortBy": { "type": "string", "enum": [ "firstName", "lastName", "company", "createdAt", "updatedAt", "email", "ladder", "rank" ] }, "sortOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "assigneeUserIds": { "type": "string" }, "cursorAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "cursorId": { "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" }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|view|leadId|leadListId|campaignId|query|offset|sortBy|sortOrder|assigneeUserIds|cursorAt|cursorId|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "view", "leadId", "leadListId", "campaignId", "query", "offset", "sortBy", "sortOrder", "assigneeUserIds", "cursorAt", "cursorId", "cursor", "limit" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "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 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "email": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "company": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "city": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": true }, "ladder": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "rank": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "emails": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "phones": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "activity": { "type": "object", "properties": { "campaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "emailCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "callCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recordingCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastActivityAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "campaignCount", "emailCount", "replyCount", "callCount", "recordingCount", "lastActivityAt" ], "patternProperties": { "^(?!(?:campaignCount|emailCount|replyCount|callCount|recordingCount|lastActivityAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignCount", "emailCount", "replyCount", "callCount", "recordingCount", "lastActivityAt" ] } } }, "required": [ "id", "email", "firstName", "lastName", "company", "phoneNumber", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "ladder", "rank", "createdAt", "updatedAt", "emails", "phones", "activity" ], "patternProperties": { "^(?!(?:id|email|firstName|lastName|company|phoneNumber|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|ladder|rank|createdAt|updatedAt|emails|phones|activity)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "email", "firstName", "lastName", "company", "phoneNumber", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "ladder", "rank", "createdAt", "updatedAt", "emails", "phones", "activity" ] } } }, "activityVisibility": { "type": "object", "properties": { "campaigns": { "type": "boolean" }, "replies": { "type": "boolean" }, "calls": { "type": "boolean" } }, "required": [ "campaigns", "replies", "calls" ], "patternProperties": { "^(?!(?:campaigns|replies|calls)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaigns", "replies", "calls" ] } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "offset", "limit", "total" ], "patternProperties": { "^(?!(?:offset|limit|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "total" ] } } }, "required": [ "items", "activityVisibility", "pagination" ], "patternProperties": { "^(?!(?:items|activityVisibility|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "activityVisibility", "pagination" ] } }, { "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" }, "organizationId": { "type": "string" }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneBase": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneExtension": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "locality": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "source": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "organizationId", "emailAddress", "phoneNumber", "phoneBase", "phoneExtension", "firstName", "lastName", "companyName", "companyWebsiteUrl", "jobTitle", "locality", "region", "country", "timezone", "personalLinkedInUrl", "companyLinkedInUrl", "source", "customFieldValues", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|organizationId|emailAddress|phoneNumber|phoneBase|phoneExtension|firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl|source|customFieldValues|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "organizationId", "emailAddress", "phoneNumber", "phoneBase", "phoneExtension", "firstName", "lastName", "companyName", "companyWebsiteUrl", "jobTitle", "locality", "region", "country", "timezone", "personalLinkedInUrl", "companyLinkedInUrl", "source", "customFieldValues", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "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" }, "leadId": { "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" } ] }, "email": { "$ref": "#/$defs/LeadStoredText" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "company": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyDomain": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "city": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": true }, "status": { "type": "string", "enum": [ "not_contacted", "contacted", "completed", "task_pending", "task_failed", "paused", "out_of_office", "bounced", "unsubscribed", "ladder_queued", "moved_to_subsequence" ] }, "bounceCategory": { "anyOf": [ { "type": "string", "enum": [ "recipient", "sender" ] }, { "type": "null" } ] }, "recipientEsp": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "emailSecurityGateway": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "image": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "isFormerMember": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isFormerMember" ], "patternProperties": { "^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isFormerMember" ] } } }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } } }, "required": [ "id", "leadId", "email", "firstName", "lastName", "company", "jobTitle", "companyDomain", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "status", "recipientEsp", "emailSecurityGateway", "assignees", "labels" ], "patternProperties": { "^(?!(?:id|leadId|email|firstName|lastName|company|jobTitle|companyDomain|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|status|bounceCategory|recipientEsp|emailSecurityGateway|assignees|labels)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "leadId", "email", "firstName", "lastName", "company", "jobTitle", "companyDomain", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "status", "bounceCategory", "recipientEsp", "emailSecurityGateway", "assignees", "labels" ] } } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "offset", "limit", "total" ], "patternProperties": { "^(?!(?:offset|limit|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "total" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "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" }, "email": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "company": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "city": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": true }, "ladder": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "rank": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "emails": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "phones": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "activity": { "type": "object", "properties": { "campaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "emailCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "callCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recordingCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastActivityAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "campaignCount", "emailCount", "replyCount", "callCount", "recordingCount", "lastActivityAt" ], "patternProperties": { "^(?!(?:campaignCount|emailCount|replyCount|callCount|recordingCount|lastActivityAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignCount", "emailCount", "replyCount", "callCount", "recordingCount", "lastActivityAt" ] } } }, "required": [ "id", "email", "firstName", "lastName", "company", "phoneNumber", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "ladder", "rank", "createdAt", "updatedAt", "emails", "phones", "activity" ], "patternProperties": { "^(?!(?:id|email|firstName|lastName|company|phoneNumber|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|ladder|rank|createdAt|updatedAt|emails|phones|activity)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "email", "firstName", "lastName", "company", "phoneNumber", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "ladder", "rank", "createdAt", "updatedAt", "emails", "phones", "activity" ] } } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "offset", "limit", "total" ], "patternProperties": { "^(?!(?:offset|limit|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "total" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "events": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "campaign_enrolled" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "campaignId": { "type": "string" }, "campaignName": { "$ref": "#/$defs/LeadStoredText" }, "status": { "type": "string", "enum": [ "not_contacted", "contacted", "completed", "task_pending", "task_failed", "paused", "out_of_office", "bounced", "unsubscribed", "ladder_queued", "moved_to_subsequence" ] }, "bounceCategory": { "anyOf": [ { "type": "string", "enum": [ "recipient", "sender" ] }, { "type": "null" } ] }, "emailAddress": { "$ref": "#/$defs/LeadStoredText" } }, "required": [ "kind", "occurredAt", "sortId", "campaignId", "campaignName", "status", "emailAddress" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|campaignId|campaignName|status|bounceCategory|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "campaignId", "campaignName", "status", "bounceCategory", "emailAddress" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "email_sent" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "campaignId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "threadId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "openCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "firstOpenedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "kind", "occurredAt", "sortId", "campaignId", "campaignName", "threadId", "openCount", "firstOpenedAt" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|campaignId|campaignName|threadId|openCount|firstOpenedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "campaignId", "campaignName", "threadId", "openCount", "firstOpenedAt" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "email_opened" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "openCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "kind", "occurredAt", "sortId", "campaignName", "openCount" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|campaignName|openCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "campaignName", "openCount" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "email_replied" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "from": { "$ref": "#/$defs/LeadStoredText" }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "type": "string" }, "threadId": { "type": "string" } }, "required": [ "kind", "occurredAt", "sortId", "from", "subject", "snippet", "threadId" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|from|subject|snippet|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "from", "subject", "snippet", "threadId" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "task" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "title": { "$ref": "#/$defs/LeadStoredText" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "outcome": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "kind", "occurredAt", "sortId", "title", "completedAt", "outcome" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|title|completedAt|outcome)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "title", "completedAt", "outcome" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "call" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "direction": { "$ref": "#/$defs/ShortText" }, "status": { "$ref": "#/$defs/ShortText" }, "durationSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "counterpartyPhoneE164": { "$ref": "#/$defs/ShortText" }, "repUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "disposition": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "note": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "hasRecording": { "type": "boolean" }, "hasTranscript": { "type": "boolean" }, "aiSummary": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "kind", "occurredAt", "sortId", "direction", "status", "durationSeconds", "counterpartyPhoneE164", "repUserId", "repName", "disposition", "note", "hasRecording", "hasTranscript", "aiSummary" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|direction|status|durationSeconds|counterpartyPhoneE164|repUserId|repName|disposition|note|hasRecording|hasTranscript|aiSummary)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "direction", "status", "durationSeconds", "counterpartyPhoneE164", "repUserId", "repName", "disposition", "note", "hasRecording", "hasTranscript", "aiSummary" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "contact_point" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "pointKind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/LeadStoredText" }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "kind", "occurredAt", "sortId", "pointKind", "value", "badReason" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|pointKind|value|badReason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "pointKind", "value", "badReason" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "crm_note_pushed" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "provider": { "$ref": "#/$defs/ShortText" }, "sourceKind": { "$ref": "#/$defs/ShortText" } }, "required": [ "kind", "occurredAt", "sortId", "provider", "sourceKind" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|provider|sourceKind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "provider", "sourceKind" ] } } ] } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] }, "hiddenSources": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "undatedEnrollments": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "nextCursor", "hiddenSources", "undatedEnrollments" ], "patternProperties": { "^(?!(?:events|nextCursor|hiddenSources|undatedEnrollments)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "events", "nextCursor", "hiddenSources", "undatedEnrollments" ] } }, { "type": "object", "properties": { "leads": { "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" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "source": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "id", "firstName", "lastName", "companyName", "jobTitle", "emailAddress", "phoneNumber", "source" ], "patternProperties": { "^(?!(?:id|firstName|lastName|companyName|jobTitle|emailAddress|phoneNumber|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "firstName", "lastName", "companyName", "jobTitle", "emailAddress", "phoneNumber", "source" ] } }, "maxItems": 25 } }, "required": [ "leads" ], "patternProperties": { "^(?!(?:leads)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "leads" ] } ] } }, { "type": "object", "properties": { "emails": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "phones": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "ladder": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "key": { "$ref": "#/$defs/ShortText" }, "rank": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "key", "rank" ], "patternProperties": { "^(?!(?:id|key|rank)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "key", "rank" ] } }, { "type": "null" } ] } }, "required": [ "emails", "phones", "ladder" ], "patternProperties": { "^(?!(?:emails|phones|ladder)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emails", "phones", "ladder" ] } }, { "type": "object", "properties": { "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" }, "leadId": { "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" }, "body": { "type": "string" }, "authorUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "authorName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "leadId", "body", "authorUserId", "authorName", "createdAt" ], "patternProperties": { "^(?!(?:id|leadId|body|authorUserId|authorName|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "leadId", "body", "authorUserId", "authorName", "createdAt" ] } }, "maxItems": 50 }, "nextCursor": { "anyOf": [ { "type": "object", "properties": { "at": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "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" } }, "required": [ "at", "id" ], "patternProperties": { "^(?!(?:at|id)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "at", "id" ] } }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "email": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "company": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "city": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": true }, "ladder": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "rank": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "emails": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "phones": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "activity": { "type": "object", "properties": { "campaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "emailCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "callCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recordingCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastActivityAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "campaignCount", "emailCount", "replyCount", "callCount", "recordingCount", "lastActivityAt" ], "patternProperties": { "^(?!(?:campaignCount|emailCount|replyCount|callCount|recordingCount|lastActivityAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignCount", "emailCount", "replyCount", "callCount", "recordingCount", "lastActivityAt" ] } } }, "required": [ "id", "email", "firstName", "lastName", "company", "phoneNumber", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "ladder", "rank", "createdAt", "updatedAt", "emails", "phones", "activity" ], "patternProperties": { "^(?!(?:id|email|firstName|lastName|company|phoneNumber|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|ladder|rank|createdAt|updatedAt|emails|phones|activity)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "email", "firstName", "lastName", "company", "phoneNumber", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "ladder", "rank", "createdAt", "updatedAt", "emails", "phones", "activity" ] } } }, "activityVisibility": { "type": "object", "properties": { "campaigns": { "type": "boolean" }, "replies": { "type": "boolean" }, "calls": { "type": "boolean" } }, "required": [ "campaigns", "replies", "calls" ], "patternProperties": { "^(?!(?:campaigns|replies|calls)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaigns", "replies", "calls" ] } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "offset", "limit", "total" ], "patternProperties": { "^(?!(?:offset|limit|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "total" ] } } }, "required": [ "items", "activityVisibility", "pagination" ], "patternProperties": { "^(?!(?:items|activityVisibility|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "activityVisibility", "pagination" ] } }, { "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" }, "organizationId": { "type": "string" }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneBase": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneExtension": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "locality": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "source": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "organizationId", "emailAddress", "phoneNumber", "phoneBase", "phoneExtension", "firstName", "lastName", "companyName", "companyWebsiteUrl", "jobTitle", "locality", "region", "country", "timezone", "personalLinkedInUrl", "companyLinkedInUrl", "source", "customFieldValues", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|organizationId|emailAddress|phoneNumber|phoneBase|phoneExtension|firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl|source|customFieldValues|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "organizationId", "emailAddress", "phoneNumber", "phoneBase", "phoneExtension", "firstName", "lastName", "companyName", "companyWebsiteUrl", "jobTitle", "locality", "region", "country", "timezone", "personalLinkedInUrl", "companyLinkedInUrl", "source", "customFieldValues", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "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" }, "leadId": { "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" } ] }, "email": { "$ref": "#/$defs/LeadStoredText" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "company": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyDomain": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "city": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": true }, "status": { "type": "string", "enum": [ "not_contacted", "contacted", "completed", "task_pending", "task_failed", "paused", "out_of_office", "bounced", "unsubscribed", "ladder_queued", "moved_to_subsequence" ] }, "bounceCategory": { "anyOf": [ { "type": "string", "enum": [ "recipient", "sender" ] }, { "type": "null" } ] }, "recipientEsp": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "emailSecurityGateway": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "image": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "isFormerMember": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isFormerMember" ], "patternProperties": { "^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isFormerMember" ] } } }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } } }, "required": [ "id", "leadId", "email", "firstName", "lastName", "company", "jobTitle", "companyDomain", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "status", "recipientEsp", "emailSecurityGateway", "assignees", "labels" ], "patternProperties": { "^(?!(?:id|leadId|email|firstName|lastName|company|jobTitle|companyDomain|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|status|bounceCategory|recipientEsp|emailSecurityGateway|assignees|labels)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "leadId", "email", "firstName", "lastName", "company", "jobTitle", "companyDomain", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "status", "bounceCategory", "recipientEsp", "emailSecurityGateway", "assignees", "labels" ] } } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "offset", "limit", "total" ], "patternProperties": { "^(?!(?:offset|limit|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "total" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "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" }, "email": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "company": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "city": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "state": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "type": "object", "additionalProperties": true }, "ladder": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "rank": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "emails": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "phones": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "activity": { "type": "object", "properties": { "campaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "emailCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "callCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recordingCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "lastActivityAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "campaignCount", "emailCount", "replyCount", "callCount", "recordingCount", "lastActivityAt" ], "patternProperties": { "^(?!(?:campaignCount|emailCount|replyCount|callCount|recordingCount|lastActivityAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignCount", "emailCount", "replyCount", "callCount", "recordingCount", "lastActivityAt" ] } } }, "required": [ "id", "email", "firstName", "lastName", "company", "phoneNumber", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "ladder", "rank", "createdAt", "updatedAt", "emails", "phones", "activity" ], "patternProperties": { "^(?!(?:id|email|firstName|lastName|company|phoneNumber|jobTitle|companyWebsiteUrl|personalLinkedInUrl|companyLinkedInUrl|city|state|country|timezone|customFieldValues|ladder|rank|createdAt|updatedAt|emails|phones|activity)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "email", "firstName", "lastName", "company", "phoneNumber", "jobTitle", "companyWebsiteUrl", "personalLinkedInUrl", "companyLinkedInUrl", "city", "state", "country", "timezone", "customFieldValues", "ladder", "rank", "createdAt", "updatedAt", "emails", "phones", "activity" ] } } }, "pagination": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "offset", "limit", "total" ], "patternProperties": { "^(?!(?:offset|limit|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "offset", "limit", "total" ] } } }, "required": [ "items", "pagination" ], "patternProperties": { "^(?!(?:items|pagination)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "pagination" ] } }, { "type": "object", "properties": { "events": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "campaign_enrolled" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "campaignId": { "type": "string" }, "campaignName": { "$ref": "#/$defs/LeadStoredText" }, "status": { "type": "string", "enum": [ "not_contacted", "contacted", "completed", "task_pending", "task_failed", "paused", "out_of_office", "bounced", "unsubscribed", "ladder_queued", "moved_to_subsequence" ] }, "bounceCategory": { "anyOf": [ { "type": "string", "enum": [ "recipient", "sender" ] }, { "type": "null" } ] }, "emailAddress": { "$ref": "#/$defs/LeadStoredText" } }, "required": [ "kind", "occurredAt", "sortId", "campaignId", "campaignName", "status", "emailAddress" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|campaignId|campaignName|status|bounceCategory|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "campaignId", "campaignName", "status", "bounceCategory", "emailAddress" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "email_sent" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "campaignId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "threadId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "openCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "firstOpenedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "kind", "occurredAt", "sortId", "campaignId", "campaignName", "threadId", "openCount", "firstOpenedAt" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|campaignId|campaignName|threadId|openCount|firstOpenedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "campaignId", "campaignName", "threadId", "openCount", "firstOpenedAt" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "email_opened" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "campaignName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "openCount": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "kind", "occurredAt", "sortId", "campaignName", "openCount" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|campaignName|openCount)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "campaignName", "openCount" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "email_replied" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "from": { "$ref": "#/$defs/LeadStoredText" }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "type": "string" }, "threadId": { "type": "string" } }, "required": [ "kind", "occurredAt", "sortId", "from", "subject", "snippet", "threadId" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|from|subject|snippet|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "from", "subject", "snippet", "threadId" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "task" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "title": { "$ref": "#/$defs/LeadStoredText" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "outcome": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "kind", "occurredAt", "sortId", "title", "completedAt", "outcome" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|title|completedAt|outcome)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "title", "completedAt", "outcome" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "call" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "direction": { "$ref": "#/$defs/ShortText" }, "status": { "$ref": "#/$defs/ShortText" }, "durationSeconds": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "counterpartyPhoneE164": { "$ref": "#/$defs/ShortText" }, "repUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "repName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "disposition": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "note": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "hasRecording": { "type": "boolean" }, "hasTranscript": { "type": "boolean" }, "aiSummary": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "kind", "occurredAt", "sortId", "direction", "status", "durationSeconds", "counterpartyPhoneE164", "repUserId", "repName", "disposition", "note", "hasRecording", "hasTranscript", "aiSummary" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|direction|status|durationSeconds|counterpartyPhoneE164|repUserId|repName|disposition|note|hasRecording|hasTranscript|aiSummary)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "direction", "status", "durationSeconds", "counterpartyPhoneE164", "repUserId", "repName", "disposition", "note", "hasRecording", "hasTranscript", "aiSummary" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "contact_point" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "pointKind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/LeadStoredText" }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "kind", "occurredAt", "sortId", "pointKind", "value", "badReason" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|pointKind|value|badReason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "pointKind", "value", "badReason" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "crm_note_pushed" ] } ] }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "sortId": { "type": "string" }, "provider": { "$ref": "#/$defs/ShortText" }, "sourceKind": { "$ref": "#/$defs/ShortText" } }, "required": [ "kind", "occurredAt", "sortId", "provider", "sourceKind" ], "patternProperties": { "^(?!(?:kind|occurredAt|sortId|provider|sourceKind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "occurredAt", "sortId", "provider", "sourceKind" ] } } ] } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] }, "hiddenSources": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "undatedEnrollments": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "events", "nextCursor", "hiddenSources", "undatedEnrollments" ], "patternProperties": { "^(?!(?:events|nextCursor|hiddenSources|undatedEnrollments)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "events", "nextCursor", "hiddenSources", "undatedEnrollments" ] } }, { "type": "object", "properties": { "leads": { "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" }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "source": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "id", "firstName", "lastName", "companyName", "jobTitle", "emailAddress", "phoneNumber", "source" ], "patternProperties": { "^(?!(?:id|firstName|lastName|companyName|jobTitle|emailAddress|phoneNumber|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "firstName", "lastName", "companyName", "jobTitle", "emailAddress", "phoneNumber", "source" ] } }, "maxItems": 25 } }, "required": [ "leads" ], "patternProperties": { "^(?!(?:leads)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "leads" ] } ] } }, { "type": "object", "properties": { "emails": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "phones": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "contactType": { "$ref": "#/$defs/LeadStoredText" }, "sourceValue": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "position": { "type": "integer", "exclusiveMinimum": 0 }, "status": { "type": "string", "enum": [ "active", "bad" ] }, "badReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "badAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ], "patternProperties": { "^(?!(?:id|kind|value|contactType|sourceValue|position|status|badReason|badAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "value", "contactType", "sourceValue", "position", "status", "badReason", "badAt" ] } } }, "ladder": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "key": { "$ref": "#/$defs/ShortText" }, "rank": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "key", "rank" ], "patternProperties": { "^(?!(?:id|key|rank)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "key", "rank" ] } }, { "type": "null" } ] } }, "required": [ "emails", "phones", "ladder" ], "patternProperties": { "^(?!(?:emails|phones|ladder)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emails", "phones", "ladder" ] } }, { "type": "object", "properties": { "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" }, "leadId": { "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" }, "body": { "type": "string" }, "authorUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "authorName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "leadId", "body", "authorUserId", "authorName", "createdAt" ], "patternProperties": { "^(?!(?:id|leadId|body|authorUserId|authorName|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "leadId", "body", "authorUserId", "authorName", "createdAt" ] } }, "maxItems": 50 }, "nextCursor": { "anyOf": [ { "type": "object", "properties": { "at": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "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" } }, "required": [ "at", "id" ], "patternProperties": { "^(?!(?:at|id)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "at", "id" ] } }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `leads.list`: `GET /v1/workspaces/:workspaceId/leads` - `leads.get`: `GET /v1/workspaces/:workspaceId/leads/:leadId` - `leads.listByCampaign`: `GET /v1/workspaces/:workspaceId/leads/by-campaign/:campaignId` - `leads.listByList`: `GET /v1/workspaces/:workspaceId/leads/by-list/:leadListId` - `leads.timeline`: `GET /v1/workspaces/:workspaceId/leads/:leadId/timeline` - `leads.search`: `POST /v1/workspaces/:workspaceId/leads/search` - `leads.contactPoints`: `GET /v1/workspaces/:workspaceId/leads/:leadId/contact-points` - `leads.notes.list`: `GET /v1/workspaces/:workspaceId/leads/:leadId/notes` ## read_organization_api_key_access Read the members' personal API keys that can act in an Organization (ADR-075 §3): owner, full or restricted access there, block state, last use, and expiry. Use for access reviews and offboarding: which keys can reach this Organization, and through whom. Requires orgApiKey:manage in the Organization. Never returns a secret or a key's reach in other Organizations. Scopes: orgApiKey:manage Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "organizationId": { "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": [ "list", "get" ] }, "apiKeyId": { "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": [ "organizationId", "action" ], "patternProperties": { "^(?!(?:organizationId|action|apiKeyId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "action", "apiKeyId" ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "organizationId": { "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": [ "list", "get" ] }, "apiKeyId": { "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": [ "organizationId", "action" ], "patternProperties": { "^(?!(?:organizationId|action|apiKeyId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "action", "apiKeyId" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "apiKeys": { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "owner": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/LeadStoredText" }, "email": { "$ref": "#/$defs/LeadStoredText" } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, { "type": "null" } ] }, "ownerUserId": { "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" }, "access": { "type": "string", "enum": [ "full", "restricted" ] }, "grant": { "anyOf": [ { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } }, { "type": "null" } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blocked": { "type": "boolean" }, "blockedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "owner", "ownerUserId", "access", "grant", "prefix", "blocked", "blockedAt", "expiresAt", "lastUsedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|owner|ownerUserId|access|grant|prefix|blocked|blockedAt|expiresAt|lastUsedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "owner", "ownerUserId", "access", "grant", "prefix", "blocked", "blockedAt", "expiresAt", "lastUsedAt", "createdAt" ] } } } }, "required": [ "apiKeys" ], "patternProperties": { "^(?!(?:apiKeys)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "apiKeys" ] } ] } }, { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "owner": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/LeadStoredText" }, "email": { "$ref": "#/$defs/LeadStoredText" } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, { "type": "null" } ] }, "ownerUserId": { "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" }, "access": { "type": "string", "enum": [ "full", "restricted" ] }, "grant": { "anyOf": [ { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } }, { "type": "null" } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blocked": { "type": "boolean" }, "blockedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "owner", "ownerUserId", "access", "grant", "prefix", "blocked", "blockedAt", "expiresAt", "lastUsedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|owner|ownerUserId|access|grant|prefix|blocked|blockedAt|expiresAt|lastUsedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "owner", "ownerUserId", "access", "grant", "prefix", "blocked", "blockedAt", "expiresAt", "lastUsedAt", "createdAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "apiKeys": { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "owner": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/LeadStoredText" }, "email": { "$ref": "#/$defs/LeadStoredText" } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, { "type": "null" } ] }, "ownerUserId": { "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" }, "access": { "type": "string", "enum": [ "full", "restricted" ] }, "grant": { "anyOf": [ { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } }, { "type": "null" } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blocked": { "type": "boolean" }, "blockedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "owner", "ownerUserId", "access", "grant", "prefix", "blocked", "blockedAt", "expiresAt", "lastUsedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|owner|ownerUserId|access|grant|prefix|blocked|blockedAt|expiresAt|lastUsedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "owner", "ownerUserId", "access", "grant", "prefix", "blocked", "blockedAt", "expiresAt", "lastUsedAt", "createdAt" ] } } } }, "required": [ "apiKeys" ], "patternProperties": { "^(?!(?:apiKeys)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "apiKeys" ] } ] } }, { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "owner": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/LeadStoredText" }, "email": { "$ref": "#/$defs/LeadStoredText" } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, { "type": "null" } ] }, "ownerUserId": { "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" }, "access": { "type": "string", "enum": [ "full", "restricted" ] }, "grant": { "anyOf": [ { "type": "object", "properties": { "organizationId": { "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" }, "organizationName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "organizationPermissions": { "type": "array", "items": { "type": "string" } }, "allWorkspaces": { "anyOf": [ { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "roles", "permissions" ], "patternProperties": { "^(?!(?:roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "roles", "permissions" ] } }, { "type": "null" } ] }, "workspaces": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "roles": { "type": "array", "items": { "type": "string" } }, "permissions": { "type": "array", "items": { "type": "string" } } }, "required": [ "workspaceId", "workspaceName", "roles", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|roles|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "roles", "permissions" ] } } } }, "required": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ], "patternProperties": { "^(?!(?:organizationId|organizationName|organizationPermissions|allWorkspaces|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "organizationName", "organizationPermissions", "allWorkspaces", "workspaces" ] } }, { "type": "null" } ] }, "prefix": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "blocked": { "type": "boolean" }, "blockedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "owner", "ownerUserId", "access", "grant", "prefix", "blocked", "blockedAt", "expiresAt", "lastUsedAt", "createdAt" ], "patternProperties": { "^(?!(?:id|name|owner|ownerUserId|access|grant|prefix|blocked|blockedAt|expiresAt|lastUsedAt|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "owner", "ownerUserId", "access", "grant", "prefix", "blocked", "blockedAt", "expiresAt", "lastUsedAt", "createdAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `organizationApiKeys.list`: `GET /v1/organizations/:organizationId/api-keys` - `organizationApiKeys.get`: `GET /v1/organizations/:organizationId/api-keys/:apiKeyId` ## read_organization_audit_log Read an Organization's append-only audit log: membership, role, invitation, API-key, MCP-grant, ownership, and Workspace-lifecycle changes, newest first. Call to answer who changed access or configuration and when (access reviews, incident questions). Page with nextCursor. Only the owner and audit:read holders see the whole Organization; a Workspace Admin must name one Workspace they administer. Anyone else gets not found. Scopes: audit:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "organizationId": { "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" }, "cursor": { "$ref": "#/$defs/OpaqueId" }, "limit": { "type": "integer", "minimum": 1, "maximum": 200 } }, "required": [ "organizationId" ], "patternProperties": { "^(?!(?:organizationId|workspaceId|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "workspaceId", "cursor", "limit" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "organizationId": { "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" }, "cursor": { "$ref": "#/$defs/OpaqueId" }, "limit": { "type": "integer", "minimum": 1, "maximum": 200 } }, "required": [ "organizationId" ], "patternProperties": { "^(?!(?:organizationId|workspaceId|cursor|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "workspaceId", "cursor", "limit" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "OrganizationAuditEvent": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "occurredAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "organizationId": { "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": { "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" } ] }, "actor": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "user", "api_key", "agent", "operator", "system" ] }, "id": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "label": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "kind", "id", "label" ], "patternProperties": { "^(?!(?:kind|id|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "id", "label" ] } }, "action": { "$ref": "#/$defs/ShortText" }, "targetKind": { "$ref": "#/$defs/ShortText" }, "targetId": { "$ref": "#/$defs/OpaqueId" }, "before": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "after": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "requestId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "metadata": { "$ref": "#/$defs/Union_" } }, "required": [ "id", "occurredAt", "organizationId", "workspaceId", "actor", "action", "targetKind", "targetId", "before", "after", "requestId", "metadata" ], "patternProperties": { "^(?!(?:id|occurredAt|organizationId|workspaceId|actor|action|targetKind|targetId|before|after|requestId|metadata)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "occurredAt", "organizationId", "workspaceId", "actor", "action", "targetKind", "targetId", "before", "after", "requestId", "metadata" ] } }, "OrganizationAuditPage": { "type": "object", "properties": { "events": { "type": "array", "items": { "$ref": "#/$defs/OrganizationAuditEvent" } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "scope": { "type": "string", "enum": [ "organization", "workspace" ] } }, "required": [ "events", "nextCursor", "scope" ], "patternProperties": { "^(?!(?:events|nextCursor|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "events", "nextCursor", "scope" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/OrganizationAuditPage" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/OrganizationAuditPage" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `organizations.listAuditEvents`: `GET /v1/organizations/:organizationId/audit-events` ## read_organizations List the caller's Organizations and read one Organization's details, permissions, Workspaces, transfers, or deletion impact. Call to learn which Organizations and Workspaces the user can see before managing members, roles, or Workspaces. Invisible Organizations and Workspaces answer not found; do not probe ids. Scopes: org:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "get" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaces" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "transfers" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "deletionPreview" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } } ], "$defs": { "ReadOrganizationsInput": { "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "get" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaces" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "transfers" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "deletionPreview" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } } ] } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "get" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaces" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "transfers" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "deletionPreview" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } } ], "$defs": { "ReadOrganizationsInput": { "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "get" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaces" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "transfers" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "deletionPreview" ] } ] }, "organizationId": { "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": [ "view", "organizationId" ], "patternProperties": { "^(?!(?:view|organizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "organizationId" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "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$" }, "ReadOrganizationsOutput": { "anyOf": [ { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isOwner": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] } }, "visibleWorkspaceCount": { "type": "integer" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "logo", "isOwner", "permissions", "visibleWorkspaceCount", "createdAt" ], "patternProperties": { "^(?!(?:id|name|logo|isOwner|permissions|visibleWorkspaceCount|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "logo", "isOwner", "permissions", "visibleWorkspaceCount", "createdAt" ] } } }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isOwner": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] } }, "visibleWorkspaceCount": { "type": "integer" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "slug": { "$ref": "#/$defs/ShortText" }, "owner": { "anyOf": [ { "type": "object", "properties": { "userId": { "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" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, { "type": "null" } ] } }, "required": [ "id", "name", "logo", "isOwner", "permissions", "visibleWorkspaceCount", "createdAt", "slug", "owner" ], "patternProperties": { "^(?!(?:id|name|logo|isOwner|permissions|visibleWorkspaceCount|createdAt|slug|owner)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "logo", "isOwner", "permissions", "visibleWorkspaceCount", "createdAt", "slug", "owner" ] } }, { "type": "object", "properties": { "organizationId": { "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" }, "isOwner": { "type": "boolean" }, "organization": { "type": "array", "items": { "type": "string", "enum": [ "audit:read", "billing:manage", "billing:read", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "role:manage", "role:read", "usage:read", "workspace:create", "workspace:delete", "workspace:transfer" ] } }, "allWorkspaces": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "canDelete": { "type": "boolean" }, "canTransferOwnership": { "type": "boolean" } }, "required": [ "organizationId", "isOwner", "organization", "allWorkspaces", "canDelete", "canTransferOwnership" ], "patternProperties": { "^(?!(?:organizationId|isOwner|organization|allWorkspaces|canDelete|canTransferOwnership)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "isOwner", "organization", "allWorkspaces", "canDelete", "canTransferOwnership" ] } }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/ShortText" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "access": { "type": "string", "enum": [ "data", "metadata" ] }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "slug", "logo", "access", "permissions", "createdAt" ], "patternProperties": { "^(?!(?:id|name|slug|logo|access|permissions|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "access", "permissions", "createdAt" ] } } }, { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspace": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, "from": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, "to": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, "direction": { "type": "string", "enum": [ "outgoing", "incoming" ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "cancelled" ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "resolvedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "workspace", "from", "to", "direction", "status", "createdAt", "resolvedAt" ], "patternProperties": { "^(?!(?:id|workspace|from|to|direction|status|createdAt|resolvedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspace", "from", "to", "direction", "status", "createdAt", "resolvedAt" ] } } }, { "type": "object", "properties": { "organizationId": { "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": { "$ref": "#/$defs/ShortText" }, "workspaces": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } } }, "members": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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" }, "email": { "type": "string" } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } } }, "blockedReason": { "anyOf": [ { "type": "string", "enum": [ "only_owned_organization", "active_subscription", "purchased_resources" ] }, { "type": "null" } ] } }, "required": [ "organizationId", "name", "workspaces", "members", "blockedReason" ], "patternProperties": { "^(?!(?:organizationId|name|workspaces|members|blockedReason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "name", "workspaces", "members", "blockedReason" ] } } ] } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/ReadOrganizationsOutput" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/ReadOrganizationsOutput" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `organizations.list`: `GET /v1/organizations` - `organizations.get`: `GET /v1/organizations/:organizationId` - `organizations.myPermissions`: `GET /v1/organizations/:organizationId/permissions` - `organizationWorkspaces.list`: `GET /v1/organizations/:organizationId/workspaces` - `organizationWorkspaces.listTransfers`: `GET /v1/organizations/:organizationId/workspace-transfers` - `organizations.deletionPreview`: `GET /v1/organizations/:organizationId/deletion-preview` ## read_own_identity Read the caller's own credential, permission split, session, and selected-workspace context. Call first to learn which principal and selected workspace the credential resolves to. Never returns secrets or provider identifiers; do not probe for them. Scopes: workspace:read Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "whoami" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "session" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaceCount" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listWorkspaces" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "activeWorkspace" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listInvitations" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "invitationPreview" ] } ] }, "token": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "view", "token" ], "patternProperties": { "^(?!(?:view|token)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "token" ] } } ], "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ReadOwnIdentityInput": { "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "whoami" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "session" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaceCount" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listWorkspaces" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "activeWorkspace" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listInvitations" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "invitationPreview" ] } ] }, "token": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "view", "token" ], "patternProperties": { "^(?!(?:view|token)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "token" ] } } ] } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "whoami" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "session" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaceCount" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listWorkspaces" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "activeWorkspace" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listInvitations" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "invitationPreview" ] } ] }, "token": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "view", "token" ], "patternProperties": { "^(?!(?:view|token)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "token" ] } } ], "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ReadOwnIdentityInput": { "anyOf": [ { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "whoami" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "permissions" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "session" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "workspaceCount" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listWorkspaces" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "activeWorkspace" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "listInvitations" ] } ] } }, "required": [ "view" ], "patternProperties": { "^(?!(?:view)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "view" ] } ] } }, { "type": "object", "properties": { "view": { "anyOf": [ { "type": "string", "enum": [ "invitationPreview" ] } ] }, "token": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "view", "token" ], "patternProperties": { "^(?!(?:view|token)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "view", "token" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "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$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "WorkspaceRoleSlug": { "type": "string", "minLength": 1, "maxLength": 128 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "MaskedEmail": { "type": "string", "pattern": "^[a-z]\\*\\*\\*@[^\\s]+$" }, "ReadOwnIdentityOutput": { "anyOf": [ { "type": "object", "properties": { "authMethod": { "type": "string", "enum": [ "api_key", "session", "workos_agent" ] }, "organization": { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "slug", "logo", "createdAt" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt" ] } }, "credential": { "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" }, "permissions": { "type": "object", "additionalProperties": true } }, "required": [ "id", "permissions" ], "patternProperties": { "^(?!(?:id|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "permissions" ] } }, { "type": "null" } ] }, "agent": { "anyOf": [ { "type": "object", "properties": { "registrationId": { "$ref": "#/$defs/OpaqueId" }, "kind": { "$ref": "#/$defs/ShortText" }, "actorUserId": { "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" }, "permissions": { "type": "object", "additionalProperties": true } }, "required": [ "registrationId", "kind", "actorUserId", "permissions" ], "patternProperties": { "^(?!(?:registrationId|kind|actorUserId|permissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "registrationId", "kind", "actorUserId", "permissions" ] } }, { "type": "null" } ] }, "mcpGrant": { "anyOf": [ { "type": "object", "properties": { "grantId": { "$ref": "#/$defs/OpaqueId" }, "scopes": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "bundles": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } } }, "required": [ "grantId", "scopes", "bundles" ], "patternProperties": { "^(?!(?:grantId|scopes|bundles)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "grantId", "scopes", "bundles" ] } }, { "type": "null" } ] } }, "required": [ "authMethod", "organization", "credential", "agent", "mcpGrant" ], "patternProperties": { "^(?!(?:authMethod|organization|credential|agent|mcpGrant)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authMethod", "organization", "credential", "agent", "mcpGrant" ] } }, { "type": "object", "properties": { "authMethod": { "type": "string", "enum": [ "api_key", "session", "workos_agent" ] }, "organizationId": { "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" }, "credentialId": { "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" } ] }, "agentRegistrationId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "selectedPermissions": { "type": "object", "additionalProperties": true }, "unselectedPermissions": { "type": "object", "additionalProperties": true } }, "required": [ "authMethod", "organizationId", "credentialId", "agentRegistrationId", "selectedPermissions", "unselectedPermissions" ], "patternProperties": { "^(?!(?:authMethod|organizationId|credentialId|agentRegistrationId|selectedPermissions|unselectedPermissions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authMethod", "organizationId", "credentialId", "agentRegistrationId", "selectedPermissions", "unselectedPermissions" ] } }, { "type": "object", "properties": { "authMethod": { "type": "string", "enum": [ "api_key", "session", "workos_agent" ] }, "principalKind": { "type": "string", "enum": [ "human", "agent", "personal_api_key" ] }, "user": { "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" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "hasCompletedOnboarding": { "type": "boolean" } }, "required": [ "id", "name", "email", "image", "hasCompletedOnboarding" ], "patternProperties": { "^(?!(?:id|name|email|image|hasCompletedOnboarding)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "email", "image", "hasCompletedOnboarding" ] } }, { "type": "null" } ] }, "activeWorkspaceId": { "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" } ] } }, "required": [ "authMethod", "principalKind", "user", "activeWorkspaceId" ], "patternProperties": { "^(?!(?:authMethod|principalKind|user|activeWorkspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authMethod", "principalKind", "user", "activeWorkspaceId" ] } }, { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "role": { "$ref": "#/$defs/WorkspaceRoleSlug" }, "customerOrganizationId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "id", "name", "slug", "logo", "createdAt" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt|role|customerOrganizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt", "role", "customerOrganizationId" ] } } }, { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/NonEmptyString" }, "logo": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "metadata": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "enabledFeatures": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "customerOrganizationId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "canManageOrganizationMembers": { "type": "boolean" }, "members": { "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" }, "userId": { "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" }, "role": { "$ref": "#/$defs/WorkspaceRoleSlug" }, "workspaceAccess": { "type": "string", "enum": [ "selected", "all" ] }, "canWidenToAll": { "type": "boolean" }, "parentMembershipId": { "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" } ] }, "workspaceMembershipId": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "user": { "type": "object", "properties": { "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] } }, "required": [ "name", "email", "image" ], "patternProperties": { "^(?!(?:name|email|image)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "email", "image" ] } } }, "required": [ "id", "userId", "role", "workspaceAccess", "canWidenToAll", "workspaceMembershipId", "createdAt", "user" ], "patternProperties": { "^(?!(?:id|userId|role|workspaceAccess|canWidenToAll|parentMembershipId|workspaceMembershipId|createdAt|user)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "userId", "role", "workspaceAccess", "canWidenToAll", "parentMembershipId", "workspaceMembershipId", "createdAt", "user" ] } } } }, "required": [ "id", "name", "slug", "logo", "createdAt", "enabledFeatures", "customerOrganizationId", "canManageOrganizationMembers", "members" ], "patternProperties": { "^(?!(?:id|name|slug|logo|createdAt|metadata|enabledFeatures|customerOrganizationId|canManageOrganizationMembers|members)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "logo", "createdAt", "metadata", "enabledFeatures", "customerOrganizationId", "canManageOrganizationMembers", "members" ] } }, { "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" }, "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "organizationId": { "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" }, "organizationName": { "$ref": "#/$defs/ShortText" }, "inviterName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "organization", "allWorkspaces", "workspace" ] }, "name": { "$ref": "#/$defs/ShortText" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "kind", "name", "roles" ], "patternProperties": { "^(?!(?:kind|name|roles)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "name", "roles" ] } } } }, "required": [ "id", "email", "status", "expiresAt", "organizationId", "organizationName", "inviterName", "targets" ], "patternProperties": { "^(?!(?:id|email|status|expiresAt|organizationId|organizationName|inviterName|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "email", "status", "expiresAt", "organizationId", "organizationName", "inviterName", "targets" ] } } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "accepted", "revoked", "expired" ] }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "organizationName": { "$ref": "#/$defs/ShortText" }, "inviterName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "maskedEmail": { "$ref": "#/$defs/MaskedEmail" }, "isExpired": { "type": "boolean" }, "isForCurrentUser": { "type": "boolean" }, "targets": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "organization", "allWorkspaces", "workspace" ] }, "name": { "$ref": "#/$defs/ShortText" }, "roles": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "kind", "name", "roles" ], "patternProperties": { "^(?!(?:kind|name|roles)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "name", "roles" ] } } } }, "required": [ "status", "expiresAt", "organizationName", "inviterName", "maskedEmail", "isExpired", "isForCurrentUser", "targets" ], "patternProperties": { "^(?!(?:status|expiresAt|organizationName|inviterName|maskedEmail|isExpired|isForCurrentUser|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "expiresAt", "organizationName", "inviterName", "maskedEmail", "isExpired", "isForCurrentUser", "targets" ] } } ] } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/ReadOwnIdentityOutput" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/ReadOwnIdentityOutput" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `me.whoami`: `GET /v1/me` - `me.permissions`: `GET /v1/me/permissions` - `me.session`: `GET /v1/me/session` - `me.workspaceCount`: `GET /v1/me/workspace-count` - `me.listWorkspaces`: `GET /v1/me/workspaces` - `me.activeWorkspace`: `GET /v1/me/active-workspace` - `me.listInvitations`: `GET /v1/me/invitations` - `me.invitationPreview`: `GET /v1/me/invitations/preview` ## read_sequence_templates Read the sequence-template library visible to a workspace (system ∪ workspace-owned), one template, or its category list. Set view to list (default), categories, or get; a templateId without view selects get. Use view=list to inspect templates (the default), view=categories for available categories, or view=get with templateId for one template. System templates are read-only; do not probe for write access through this tool. Scopes: template:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "view": { "type": "string", "enum": [ "list", "categories", "get" ] }, "templateId": { "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" }, "category": { "type": "string" }, "includeSystem": { "type": "boolean" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|view|templateId|category|includeSystem)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "view", "templateId", "category", "includeSystem" ] } } ``` ### 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" }, "view": { "type": "string", "enum": [ "list", "categories", "get" ] }, "templateId": { "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" }, "category": { "type": "string" }, "includeSystem": { "type": "boolean" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|view|templateId|category|includeSystem)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "view", "templateId", "category", "includeSystem" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "TemplateName": { "type": "string", "minLength": 1, "maxLength": 200 }, "TemplateDescription": { "type": "string", "minLength": 1, "maxLength": 1000 }, "TemplateCategory": { "type": "string", "minLength": 1, "maxLength": 100 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "$ref": "#/$defs/Arrays_" }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "Arrays_": { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, "EditorStateJson": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "$ref": "#/$defs/Arrays_" }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "TemplateStep": { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "email_content" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "variants": { "type": "array", "items": { "type": "object", "properties": { "variantOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subject": { "anyOf": [ { "$ref": "#/$defs/EditorStateJson" }, { "type": "null" } ] }, "body": { "anyOf": [ { "$ref": "#/$defs/EditorStateJson" }, { "type": "null" } ] } }, "required": [ "variantOrder", "subject", "body" ], "patternProperties": { "^(?!(?:variantOrder|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "variantOrder", "subject", "body" ] } }, "minItems": 1 } }, "required": [ "type", "delayMinutes", "variants" ], "patternProperties": { "^(?!(?:type|delayMinutes|variants)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "variants" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "manual_review" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "notificationMessage": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "notificationMessage" ], "patternProperties": { "^(?!(?:type|delayMinutes|notificationMessage)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "notificationMessage" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "linked_in_connection_request" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionNote": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "connectionNote" ], "patternProperties": { "^(?!(?:type|delayMinutes|connectionNote)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "connectionNote" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "linked_in_in_mail" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "subject": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "subject", "body" ], "patternProperties": { "^(?!(?:type|delayMinutes|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "subject", "body" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "phone_call" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "script": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "script" ], "patternProperties": { "^(?!(?:type|delayMinutes|script)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "script" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "text_message" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "message": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "mediaUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "message" ], "patternProperties": { "^(?!(?:type|delayMinutes|message|mediaUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "message", "mediaUrl" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "http_post_request" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "url": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "headers": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "bodyTemplate": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "url", "headers", "bodyTemplate" ], "patternProperties": { "^(?!(?:type|delayMinutes|url|headers|bodyTemplate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "url", "headers", "bodyTemplate" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "heyreach_campaign" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaignId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "campaignName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "linkedInAccountId": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] } }, "required": [ "type", "delayMinutes", "campaignId" ], "patternProperties": { "^(?!(?:type|delayMinutes|connectionId|campaignId|campaignName|linkedInAccountId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "connectionId", "campaignId", "campaignName", "linkedInAccountId" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "attio_task" ] } ] }, "delayMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "content": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ] }, "assigneeMemberIds": { "type": "array", "items": { "type": "string" } }, "onMissingAssignee": { "type": "string", "enum": [ "skip", "fail" ] }, "deadlineOffsetDays": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "personLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } }, "companyLink": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sourceVariable": { "type": "string" }, "matchBy": { "type": "string", "enum": [ "email", "domain", "record_id" ] }, "createIfMissing": { "type": "boolean" } }, "required": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ], "patternProperties": { "^(?!(?:enabled|sourceVariable|matchBy|createIfMissing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "enabled", "sourceVariable", "matchBy", "createIfMissing" ] } } }, "required": [ "type", "delayMinutes", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ], "patternProperties": { "^(?!(?:type|delayMinutes|content|assigneeMemberIds|onMissingAssignee|deadlineOffsetDays|personLink|companyLink)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "delayMinutes", "content", "assigneeMemberIds", "onMissingAssignee", "deadlineOffsetDays", "personLink", "companyLink" ] } } ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "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" }, "name": { "$ref": "#/$defs/TemplateName" }, "description": { "anyOf": [ { "$ref": "#/$defs/TemplateDescription" }, { "type": "null" } ] }, "category": { "anyOf": [ { "$ref": "#/$defs/TemplateCategory" }, { "type": "null" } ] }, "isSystem": { "type": "boolean" }, "organizationId": { "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" } ] }, "steps": { "type": "array", "items": { "$ref": "#/$defs/TemplateStep" }, "maxItems": 50 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|description|category|isSystem|organizationId|steps|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ] } } }, { "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" }, "name": { "$ref": "#/$defs/TemplateName" }, "description": { "anyOf": [ { "$ref": "#/$defs/TemplateDescription" }, { "type": "null" } ] }, "category": { "anyOf": [ { "$ref": "#/$defs/TemplateCategory" }, { "type": "null" } ] }, "isSystem": { "type": "boolean" }, "organizationId": { "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" } ] }, "steps": { "type": "array", "items": { "$ref": "#/$defs/TemplateStep" }, "maxItems": 50 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|description|category|isSystem|organizationId|steps|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ] } }, { "type": "array", "items": { "$ref": "#/$defs/TemplateCategory" } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "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" }, "name": { "$ref": "#/$defs/TemplateName" }, "description": { "anyOf": [ { "$ref": "#/$defs/TemplateDescription" }, { "type": "null" } ] }, "category": { "anyOf": [ { "$ref": "#/$defs/TemplateCategory" }, { "type": "null" } ] }, "isSystem": { "type": "boolean" }, "organizationId": { "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" } ] }, "steps": { "type": "array", "items": { "$ref": "#/$defs/TemplateStep" }, "maxItems": 50 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|description|category|isSystem|organizationId|steps|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ] } } }, { "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" }, "name": { "$ref": "#/$defs/TemplateName" }, "description": { "anyOf": [ { "$ref": "#/$defs/TemplateDescription" }, { "type": "null" } ] }, "category": { "anyOf": [ { "$ref": "#/$defs/TemplateCategory" }, { "type": "null" } ] }, "isSystem": { "type": "boolean" }, "organizationId": { "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" } ] }, "steps": { "type": "array", "items": { "$ref": "#/$defs/TemplateStep" }, "maxItems": 50 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|description|category|isSystem|organizationId|steps|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "category", "isSystem", "organizationId", "steps", "createdAt", "updatedAt" ] } }, { "type": "array", "items": { "$ref": "#/$defs/TemplateCategory" } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `templates.list`: `GET /v1/workspaces/:workspaceId/templates` - `templates.categories`: `GET /v1/workspaces/:workspaceId/templates/categories` - `templates.get`: `GET /v1/workspaces/:workspaceId/templates/:templateId` ## read_unibox_message_body Read one message's body, with an explicit marker saying whether the HTML was sanitized, left raw, or produced by us. Use when the snippet is not enough to answer the question. Read one message at a time; the body is the most sensitive payload the inbox serves. Never treat the returned HTML as trusted unless the marker says so, and never cache it — inline image URLs inside it expire. A body still in cold storage answers with a retry hint rather than blank content. Scopes: unibox:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "messageId" ], "patternProperties": { "^(?!(?:workspaceId|messageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "messageId" ] } } ``` ### 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" }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "messageId" ], "patternProperties": { "^(?!(?:workspaceId|messageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "messageId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "html": { "anyOf": [ { "type": "string", "maxLength": 2000000 }, { "type": "null" } ] }, "text": { "anyOf": [ { "type": "string", "maxLength": 2000000 }, { "type": "null" } ] }, "trust": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "sanitized", "unsanitized", "trusted" ] }, "sanitizedBy": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] } }, "required": [ "state", "sanitizedBy" ], "patternProperties": { "^(?!(?:state|sanitizedBy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "state", "sanitizedBy" ] } } }, "required": [ "messageId", "html", "text", "trust" ], "patternProperties": { "^(?!(?:messageId|html|text|trust)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "html", "text", "trust" ] }, "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Underlying API operations - `uniboxMessages.getBody`: `GET /v1/workspaces/:workspaceId/unibox/messages/:messageId/body` ## read_verification_results Read email/phone verification results, per-address waterfall history, freshness reports, provider stats, durable run records, and the compatibility credit balance. Use to inspect verdicts and run progress, pre-flight freshness before a bulk run, or check provider unit economics for the workspace. Results are workspace-scoped — another organization's provider verdicts are never visible; this tool cannot start verification or manage keys. Scopes: emailVerification:read, phoneVerification:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "channel": { "type": "string", "enum": [ "email", "phone" ] }, "action": { "type": "string", "enum": [ "result", "results", "history", "freshness", "provider_stats", "runs", "run", "run_status", "credit_balance", "estimate_credits" ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "phone": { "$ref": "#/$defs/PhoneNumberInput" }, "phones": { "type": "array", "items": { "$ref": "#/$defs/PhoneNumberInput" }, "minItems": 1, "maxItems": 500 }, "runId": { "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": "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" } ] }, "freshness": { "type": "object", "properties": { "emails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5000 }, "scope": { "type": "object", "properties": { "campaignId": { "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" }, "search": { "$ref": "#/$defs/ShortText" }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "campaignId" ], "patternProperties": { "^(?!(?:campaignId|search|assigneeUserIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "search", "assigneeUserIds" ] } } }, "patternProperties": { "^(?!(?:emails|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emails", "scope" ] } }, "estimate": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 1 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } }, "limit": { "type": "integer", "minimum": 1, "maximum": 200 } }, "required": [ "workspaceId", "channel", "action" ], "patternProperties": { "^(?!(?:workspaceId|channel|action|email|phone|phones|runId|freshness|estimate|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "channel", "action", "email", "phone", "phones", "runId", "freshness", "estimate", "limit" ] }, "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "PhoneNumberInput": { "type": "string", "minLength": 1, "maxLength": 64 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### 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" }, "channel": { "type": "string", "enum": [ "email", "phone" ] }, "action": { "type": "string", "enum": [ "result", "results", "history", "freshness", "provider_stats", "runs", "run", "run_status", "credit_balance", "estimate_credits" ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "phone": { "$ref": "#/$defs/PhoneNumberInput" }, "phones": { "type": "array", "items": { "$ref": "#/$defs/PhoneNumberInput" }, "minItems": 1, "maxItems": 500 }, "runId": { "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": "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" } ] }, "freshness": { "type": "object", "properties": { "emails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5000 }, "scope": { "type": "object", "properties": { "campaignId": { "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" }, "search": { "$ref": "#/$defs/ShortText" }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "campaignId" ], "patternProperties": { "^(?!(?:campaignId|search|assigneeUserIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "search", "assigneeUserIds" ] } } }, "patternProperties": { "^(?!(?:emails|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emails", "scope" ] } }, "estimate": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 1 } }, "required": [ "count" ], "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } }, "limit": { "type": "integer", "minimum": 1, "maximum": 200 } }, "required": [ "workspaceId", "channel", "action" ], "patternProperties": { "^(?!(?:workspaceId|channel|action|email|phone|phones|runId|freshness|estimate|limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "channel", "action", "email", "phone", "phones", "runId", "freshness", "estimate", "limit" ] }, "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "PhoneNumberInput": { "type": "string", "minLength": 1, "maxLength": 64 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "source": { "type": "string", "enum": [ "cache", "dns", "provider" ] }, "provider": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "flags": { "type": "object", "properties": { "role": { "type": "boolean" }, "disposable": { "type": "boolean" }, "spamtrap": { "type": "boolean" }, "freeProvider": { "type": "boolean" } }, "patternProperties": { "^(?!(?:role|disposable|spamtrap|freeProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "role", "disposable", "spamtrap", "freeProvider" ] } }, "verifiedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "fromCache": { "type": "boolean" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "resolved": { "type": "boolean" } }, "required": [ "providerId", "status", "rawStatus", "confidence", "resolved" ], "patternProperties": { "^(?!(?:providerId|status|rawStatus|confidence|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "rawStatus", "confidence", "resolved" ] } } } }, "required": [ "email", "status", "source", "provider", "confidence", "verifiedAt", "fromCache", "attempts" ], "patternProperties": { "^(?!(?:email|status|source|provider|confidence|flags|verifiedAt|fromCache|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "status", "source", "provider", "confidence", "flags", "verifiedAt", "fromCache", "attempts" ] } }, { "anyOf": [ { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "source": { "type": "string", "enum": [ "provider", "dns", "sending-signal", "cache" ] }, "provider": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "flags": { "type": "object", "properties": { "role": { "type": "boolean" }, "disposable": { "type": "boolean" }, "spamtrap": { "type": "boolean" }, "freeProvider": { "type": "boolean" } }, "patternProperties": { "^(?!(?:role|disposable|spamtrap|freeProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "role", "disposable", "spamtrap", "freeProvider" ] } }, "verifiedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "email", "status", "source", "confidence", "verifiedAt" ], "patternProperties": { "^(?!(?:email|status|source|provider|confidence|flags|verifiedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "status", "source", "provider", "confidence", "flags", "verifiedAt" ] } }, { "type": "null" } ] }, { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "runs": { "type": "array", "items": { "type": "object", "properties": { "requestId": { "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" } ] }, "checkedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "hops": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "rawStatus": { "$ref": "#/$defs/ShortText" }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "resolved": { "type": "boolean" } }, "required": [ "provider", "status", "rawStatus", "confidence", "resolved" ], "patternProperties": { "^(?!(?:provider|status|rawStatus|confidence|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "status", "rawStatus", "confidence", "resolved" ] } } } }, "required": [ "requestId", "checkedAt", "hops" ], "patternProperties": { "^(?!(?:requestId|checkedAt|hops)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "requestId", "checkedAt", "hops" ] } } } }, "required": [ "email", "runs" ], "patternProperties": { "^(?!(?:email|runs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "runs" ] } }, { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "knownCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "mostRecentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "capped": { "type": "boolean" }, "cap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "known": { "type": "array", "items": { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "lastVerifiedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "email", "status", "lastVerifiedAt" ], "patternProperties": { "^(?!(?:email|status|lastVerifiedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "status", "lastVerifiedAt" ] } }, "maxItems": 100 } }, "required": [ "total", "knownCount", "mostRecentAt", "capped", "cap", "known" ], "patternProperties": { "^(?!(?:total|knownCount|mostRecentAt|capped|cap|known)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "knownCount", "mostRecentAt", "capped", "cap", "known" ] } }, { "type": "object", "properties": { "providers": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ShortText" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "resolved": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "resolvedValid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "resolvedInvalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "resolvedCatchAll": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "provider", "attempts", "resolved", "resolvedValid", "resolvedInvalid", "resolvedCatchAll" ], "patternProperties": { "^(?!(?:provider|attempts|resolved|resolvedValid|resolvedInvalid|resolvedCatchAll)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "attempts", "resolved", "resolvedValid", "resolvedInvalid", "resolvedCatchAll" ] } } } }, "required": [ "providers" ], "patternProperties": { "^(?!(?:providers)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "providers" ] } ] } }, { "type": "object", "properties": { "runs": { "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" }, "kind": { "type": "string", "enum": [ "single", "bulk" ] }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countValid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countInvalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countCatchAll": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countUnknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requestedBy": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countCatchAll", "countUnknown", "requestedBy", "createdAt", "completedAt" ], "patternProperties": { "^(?!(?:id|kind|status|total|processed|countValid|countInvalid|countCatchAll|countUnknown|requestedBy|createdAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countCatchAll", "countUnknown", "requestedBy", "createdAt", "completedAt" ] } } } }, "required": [ "runs" ], "patternProperties": { "^(?!(?:runs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "runs" ] } ] } }, { "anyOf": [ { "type": "object", "properties": { "run": { "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" }, "kind": { "type": "string", "enum": [ "single", "bulk" ] }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countValid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countInvalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countCatchAll": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countUnknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requestedBy": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countCatchAll", "countUnknown", "requestedBy", "createdAt", "completedAt" ], "patternProperties": { "^(?!(?:id|kind|status|total|processed|countValid|countInvalid|countCatchAll|countUnknown|requestedBy|createdAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countCatchAll", "countUnknown", "requestedBy", "createdAt", "completedAt" ] } }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "provider": { "$ref": "#/$defs/ShortText" } }, "required": [ "email", "status", "provider" ], "patternProperties": { "^(?!(?:email|status|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "status", "provider" ] } } } }, "required": [ "run", "addresses" ], "patternProperties": { "^(?!(?:run|addresses)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "run", "addresses" ] } }, { "type": "null" } ] }, { "type": "object", "properties": { "runId": { "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" }, "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "counts": { "type": "object", "properties": { "valid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "invalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "catchAll": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "valid", "invalid", "catchAll", "unknown" ], "patternProperties": { "^(?!(?:valid|invalid|catchAll|unknown)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "valid", "invalid", "catchAll", "unknown" ] } } }, "required": [ "runId", "state", "total", "processed", "progress", "counts" ], "patternProperties": { "^(?!(?:runId|state|total|processed|progress|counts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "state", "total", "processed", "progress", "counts" ] } }, { "type": "object", "properties": { "billingEnabled": { "type": "boolean", "enum": [ false ] }, "balance": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "reserved": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "available": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "billingEnabled", "balance", "reserved", "available" ], "patternProperties": { "^(?!(?:billingEnabled|balance|reserved|available)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "billingEnabled", "balance", "reserved", "available" ] } }, { "type": "object", "properties": { "estimatedCredits": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "estimatedCredits" ], "patternProperties": { "^(?!(?:estimatedCredits)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "estimatedCredits" ] } ] } }, { "type": "object", "properties": { "phone": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] }, "source": { "type": "string", "enum": [ "cache", "format", "provider" ] }, "provider": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "flags": { "type": "object", "properties": { "lineType": { "type": "string", "enum": [ "mobile", "landline", "voip", "toll_free", "premium", "unknown" ] }, "carrier": { "$ref": "#/$defs/ShortText" }, "isPrepaid": { "type": "boolean" }, "activityScore": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "isLitigatorRisk": { "type": "boolean" }, "countryCode": { "$ref": "#/$defs/ShortText" }, "e164Format": { "$ref": "#/$defs/ShortText" } }, "patternProperties": { "^(?!(?:lineType|carrier|isPrepaid|activityScore|isLitigatorRisk|countryCode|e164Format)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format" ] } }, "verifiedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "fromCache": { "type": "boolean" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "resolved": { "type": "boolean" } }, "required": [ "providerId", "status", "rawStatus", "confidence", "resolved" ], "patternProperties": { "^(?!(?:providerId|status|rawStatus|confidence|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "rawStatus", "confidence", "resolved" ] } } } }, "required": [ "phone", "status", "source", "provider", "confidence", "verifiedAt", "fromCache", "attempts" ], "patternProperties": { "^(?!(?:phone|status|source|provider|confidence|flags|verifiedAt|fromCache|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phone", "status", "source", "provider", "confidence", "flags", "verifiedAt", "fromCache", "attempts" ] } }, { "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" }, "phoneNumber": { "$ref": "#/$defs/ShortText" }, "provider": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] }, "rawStatus": { "$ref": "#/$defs/ShortText" }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "lineType": { "anyOf": [ { "type": "string", "enum": [ "mobile", "landline", "voip", "toll_free", "premium", "unknown" ] }, { "type": "null" } ] }, "carrier": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "isPrepaid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "activityScore": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "isLitigatorRisk": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "countryCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "e164Format": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "verificationRequestId": { "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" } ] }, "runId": { "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" } ] }, "resolved": { "type": "boolean" }, "checkedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneNumber", "provider", "status", "rawStatus", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format", "verificationRequestId", "runId", "resolved", "checkedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneNumber|provider|status|rawStatus|confidence|lineType|carrier|isPrepaid|activityScore|isLitigatorRisk|countryCode|e164Format|verificationRequestId|runId|resolved|checkedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneNumber", "provider", "status", "rawStatus", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format", "verificationRequestId", "runId", "resolved", "checkedAt", "createdAt", "updatedAt" ] } }, { "type": "null" } ] }, { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] }, "provider": { "$ref": "#/$defs/ShortText" }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "lineType": { "anyOf": [ { "type": "string", "enum": [ "mobile", "landline", "voip", "toll_free", "premium", "unknown" ] }, { "type": "null" } ] }, "carrier": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "isPrepaid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "activityScore": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "isLitigatorRisk": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "e164Format": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "checkedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "phoneNumber", "status", "provider", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "e164Format", "checkedAt" ], "patternProperties": { "^(?!(?:phoneNumber|status|provider|confidence|lineType|carrier|isPrepaid|activityScore|isLitigatorRisk|e164Format|checkedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phoneNumber", "status", "provider", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "e164Format", "checkedAt" ] } } } }, "required": [ "results" ], "patternProperties": { "^(?!(?:results)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "results" ] } ] } }, { "type": "object", "properties": { "results": { "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" }, "phoneNumber": { "$ref": "#/$defs/ShortText" }, "provider": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] }, "rawStatus": { "$ref": "#/$defs/ShortText" }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "lineType": { "anyOf": [ { "type": "string", "enum": [ "mobile", "landline", "voip", "toll_free", "premium", "unknown" ] }, { "type": "null" } ] }, "carrier": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "isPrepaid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "activityScore": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "isLitigatorRisk": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "countryCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "e164Format": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "verificationRequestId": { "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" } ] }, "runId": { "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" } ] }, "resolved": { "type": "boolean" }, "checkedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneNumber", "provider", "status", "rawStatus", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format", "verificationRequestId", "runId", "resolved", "checkedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneNumber|provider|status|rawStatus|confidence|lineType|carrier|isPrepaid|activityScore|isLitigatorRisk|countryCode|e164Format|verificationRequestId|runId|resolved|checkedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneNumber", "provider", "status", "rawStatus", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format", "verificationRequestId", "runId", "resolved", "checkedAt", "createdAt", "updatedAt" ] } } } }, "required": [ "results" ], "patternProperties": { "^(?!(?:results)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "results" ] } ] } }, { "type": "object", "properties": { "runs": { "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" }, "kind": { "type": "string", "enum": [ "single", "bulk" ] }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countValid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countInvalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countUnknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requestedBy": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countUnknown", "requestedBy", "createdAt", "completedAt" ], "patternProperties": { "^(?!(?:id|kind|status|total|processed|countValid|countInvalid|countUnknown|requestedBy|createdAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countUnknown", "requestedBy", "createdAt", "completedAt" ] } } } }, "required": [ "runs" ], "patternProperties": { "^(?!(?:runs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "runs" ] } ] } }, { "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" }, "kind": { "type": "string", "enum": [ "single", "bulk" ] }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countValid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countInvalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countUnknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requestedBy": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countUnknown", "requestedBy", "createdAt", "completedAt" ], "patternProperties": { "^(?!(?:id|kind|status|total|processed|countValid|countInvalid|countUnknown|requestedBy|createdAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countUnknown", "requestedBy", "createdAt", "completedAt" ] } }, { "type": "null" } ] }, { "type": "object", "properties": { "runId": { "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" }, "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "counts": { "type": "object", "properties": { "valid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "invalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "valid", "invalid", "unknown" ], "patternProperties": { "^(?!(?:valid|invalid|unknown)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] } } }, "required": [ "runId", "state", "total", "processed", "progress", "counts" ], "patternProperties": { "^(?!(?:runId|state|total|processed|progress|counts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "state", "total", "processed", "progress", "counts" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "source": { "type": "string", "enum": [ "cache", "dns", "provider" ] }, "provider": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "flags": { "type": "object", "properties": { "role": { "type": "boolean" }, "disposable": { "type": "boolean" }, "spamtrap": { "type": "boolean" }, "freeProvider": { "type": "boolean" } }, "patternProperties": { "^(?!(?:role|disposable|spamtrap|freeProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "role", "disposable", "spamtrap", "freeProvider" ] } }, "verifiedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "fromCache": { "type": "boolean" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "resolved": { "type": "boolean" } }, "required": [ "providerId", "status", "rawStatus", "confidence", "resolved" ], "patternProperties": { "^(?!(?:providerId|status|rawStatus|confidence|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "rawStatus", "confidence", "resolved" ] } } } }, "required": [ "email", "status", "source", "provider", "confidence", "verifiedAt", "fromCache", "attempts" ], "patternProperties": { "^(?!(?:email|status|source|provider|confidence|flags|verifiedAt|fromCache|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "status", "source", "provider", "confidence", "flags", "verifiedAt", "fromCache", "attempts" ] } }, { "anyOf": [ { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "source": { "type": "string", "enum": [ "provider", "dns", "sending-signal", "cache" ] }, "provider": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "flags": { "type": "object", "properties": { "role": { "type": "boolean" }, "disposable": { "type": "boolean" }, "spamtrap": { "type": "boolean" }, "freeProvider": { "type": "boolean" } }, "patternProperties": { "^(?!(?:role|disposable|spamtrap|freeProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "role", "disposable", "spamtrap", "freeProvider" ] } }, "verifiedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "email", "status", "source", "confidence", "verifiedAt" ], "patternProperties": { "^(?!(?:email|status|source|provider|confidence|flags|verifiedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "status", "source", "provider", "confidence", "flags", "verifiedAt" ] } }, { "type": "null" } ] }, { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "runs": { "type": "array", "items": { "type": "object", "properties": { "requestId": { "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" } ] }, "checkedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "hops": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "rawStatus": { "$ref": "#/$defs/ShortText" }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "resolved": { "type": "boolean" } }, "required": [ "provider", "status", "rawStatus", "confidence", "resolved" ], "patternProperties": { "^(?!(?:provider|status|rawStatus|confidence|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "status", "rawStatus", "confidence", "resolved" ] } } } }, "required": [ "requestId", "checkedAt", "hops" ], "patternProperties": { "^(?!(?:requestId|checkedAt|hops)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "requestId", "checkedAt", "hops" ] } } } }, "required": [ "email", "runs" ], "patternProperties": { "^(?!(?:email|runs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "runs" ] } }, { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "knownCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "mostRecentAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "capped": { "type": "boolean" }, "cap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "known": { "type": "array", "items": { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "lastVerifiedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "email", "status", "lastVerifiedAt" ], "patternProperties": { "^(?!(?:email|status|lastVerifiedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "status", "lastVerifiedAt" ] } }, "maxItems": 100 } }, "required": [ "total", "knownCount", "mostRecentAt", "capped", "cap", "known" ], "patternProperties": { "^(?!(?:total|knownCount|mostRecentAt|capped|cap|known)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "total", "knownCount", "mostRecentAt", "capped", "cap", "known" ] } }, { "type": "object", "properties": { "providers": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ShortText" }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "resolved": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "resolvedValid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "resolvedInvalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "resolvedCatchAll": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "provider", "attempts", "resolved", "resolvedValid", "resolvedInvalid", "resolvedCatchAll" ], "patternProperties": { "^(?!(?:provider|attempts|resolved|resolvedValid|resolvedInvalid|resolvedCatchAll)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "attempts", "resolved", "resolvedValid", "resolvedInvalid", "resolvedCatchAll" ] } } } }, "required": [ "providers" ], "patternProperties": { "^(?!(?:providers)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "providers" ] } ] } }, { "type": "object", "properties": { "runs": { "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" }, "kind": { "type": "string", "enum": [ "single", "bulk" ] }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countValid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countInvalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countCatchAll": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countUnknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requestedBy": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countCatchAll", "countUnknown", "requestedBy", "createdAt", "completedAt" ], "patternProperties": { "^(?!(?:id|kind|status|total|processed|countValid|countInvalid|countCatchAll|countUnknown|requestedBy|createdAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countCatchAll", "countUnknown", "requestedBy", "createdAt", "completedAt" ] } } } }, "required": [ "runs" ], "patternProperties": { "^(?!(?:runs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "runs" ] } ] } }, { "anyOf": [ { "type": "object", "properties": { "run": { "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" }, "kind": { "type": "string", "enum": [ "single", "bulk" ] }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countValid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countInvalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countCatchAll": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countUnknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requestedBy": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countCatchAll", "countUnknown", "requestedBy", "createdAt", "completedAt" ], "patternProperties": { "^(?!(?:id|kind|status|total|processed|countValid|countInvalid|countCatchAll|countUnknown|requestedBy|createdAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countCatchAll", "countUnknown", "requestedBy", "createdAt", "completedAt" ] } }, "addresses": { "type": "array", "items": { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "provider": { "$ref": "#/$defs/ShortText" } }, "required": [ "email", "status", "provider" ], "patternProperties": { "^(?!(?:email|status|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "status", "provider" ] } } } }, "required": [ "run", "addresses" ], "patternProperties": { "^(?!(?:run|addresses)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "run", "addresses" ] } }, { "type": "null" } ] }, { "type": "object", "properties": { "runId": { "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" }, "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "counts": { "type": "object", "properties": { "valid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "invalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "catchAll": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "valid", "invalid", "catchAll", "unknown" ], "patternProperties": { "^(?!(?:valid|invalid|catchAll|unknown)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "valid", "invalid", "catchAll", "unknown" ] } } }, "required": [ "runId", "state", "total", "processed", "progress", "counts" ], "patternProperties": { "^(?!(?:runId|state|total|processed|progress|counts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "state", "total", "processed", "progress", "counts" ] } }, { "type": "object", "properties": { "billingEnabled": { "type": "boolean", "enum": [ false ] }, "balance": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "reserved": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "available": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "billingEnabled", "balance", "reserved", "available" ], "patternProperties": { "^(?!(?:billingEnabled|balance|reserved|available)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "billingEnabled", "balance", "reserved", "available" ] } }, { "type": "object", "properties": { "estimatedCredits": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "estimatedCredits" ], "patternProperties": { "^(?!(?:estimatedCredits)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "estimatedCredits" ] } ] } }, { "type": "object", "properties": { "phone": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] }, "source": { "type": "string", "enum": [ "cache", "format", "provider" ] }, "provider": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "flags": { "type": "object", "properties": { "lineType": { "type": "string", "enum": [ "mobile", "landline", "voip", "toll_free", "premium", "unknown" ] }, "carrier": { "$ref": "#/$defs/ShortText" }, "isPrepaid": { "type": "boolean" }, "activityScore": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "isLitigatorRisk": { "type": "boolean" }, "countryCode": { "$ref": "#/$defs/ShortText" }, "e164Format": { "$ref": "#/$defs/ShortText" } }, "patternProperties": { "^(?!(?:lineType|carrier|isPrepaid|activityScore|isLitigatorRisk|countryCode|e164Format)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format" ] } }, "verifiedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "fromCache": { "type": "boolean" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "resolved": { "type": "boolean" } }, "required": [ "providerId", "status", "rawStatus", "confidence", "resolved" ], "patternProperties": { "^(?!(?:providerId|status|rawStatus|confidence|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "rawStatus", "confidence", "resolved" ] } } } }, "required": [ "phone", "status", "source", "provider", "confidence", "verifiedAt", "fromCache", "attempts" ], "patternProperties": { "^(?!(?:phone|status|source|provider|confidence|flags|verifiedAt|fromCache|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phone", "status", "source", "provider", "confidence", "flags", "verifiedAt", "fromCache", "attempts" ] } }, { "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" }, "phoneNumber": { "$ref": "#/$defs/ShortText" }, "provider": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] }, "rawStatus": { "$ref": "#/$defs/ShortText" }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "lineType": { "anyOf": [ { "type": "string", "enum": [ "mobile", "landline", "voip", "toll_free", "premium", "unknown" ] }, { "type": "null" } ] }, "carrier": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "isPrepaid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "activityScore": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "isLitigatorRisk": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "countryCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "e164Format": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "verificationRequestId": { "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" } ] }, "runId": { "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" } ] }, "resolved": { "type": "boolean" }, "checkedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneNumber", "provider", "status", "rawStatus", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format", "verificationRequestId", "runId", "resolved", "checkedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneNumber|provider|status|rawStatus|confidence|lineType|carrier|isPrepaid|activityScore|isLitigatorRisk|countryCode|e164Format|verificationRequestId|runId|resolved|checkedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneNumber", "provider", "status", "rawStatus", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format", "verificationRequestId", "runId", "resolved", "checkedAt", "createdAt", "updatedAt" ] } }, { "type": "null" } ] }, { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "phoneNumber": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] }, "provider": { "$ref": "#/$defs/ShortText" }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "lineType": { "anyOf": [ { "type": "string", "enum": [ "mobile", "landline", "voip", "toll_free", "premium", "unknown" ] }, { "type": "null" } ] }, "carrier": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "isPrepaid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "activityScore": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "isLitigatorRisk": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "e164Format": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "checkedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "phoneNumber", "status", "provider", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "e164Format", "checkedAt" ], "patternProperties": { "^(?!(?:phoneNumber|status|provider|confidence|lineType|carrier|isPrepaid|activityScore|isLitigatorRisk|e164Format|checkedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phoneNumber", "status", "provider", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "e164Format", "checkedAt" ] } } } }, "required": [ "results" ], "patternProperties": { "^(?!(?:results)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "results" ] } ] } }, { "type": "object", "properties": { "results": { "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" }, "phoneNumber": { "$ref": "#/$defs/ShortText" }, "provider": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] }, "rawStatus": { "$ref": "#/$defs/ShortText" }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "lineType": { "anyOf": [ { "type": "string", "enum": [ "mobile", "landline", "voip", "toll_free", "premium", "unknown" ] }, { "type": "null" } ] }, "carrier": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "isPrepaid": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "activityScore": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "isLitigatorRisk": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "countryCode": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "e164Format": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "verificationRequestId": { "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" } ] }, "runId": { "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" } ] }, "resolved": { "type": "boolean" }, "checkedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "phoneNumber", "provider", "status", "rawStatus", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format", "verificationRequestId", "runId", "resolved", "checkedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|phoneNumber|provider|status|rawStatus|confidence|lineType|carrier|isPrepaid|activityScore|isLitigatorRisk|countryCode|e164Format|verificationRequestId|runId|resolved|checkedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "phoneNumber", "provider", "status", "rawStatus", "confidence", "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format", "verificationRequestId", "runId", "resolved", "checkedAt", "createdAt", "updatedAt" ] } } } }, "required": [ "results" ], "patternProperties": { "^(?!(?:results)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "results" ] } ] } }, { "type": "object", "properties": { "runs": { "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" }, "kind": { "type": "string", "enum": [ "single", "bulk" ] }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countValid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countInvalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countUnknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requestedBy": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countUnknown", "requestedBy", "createdAt", "completedAt" ], "patternProperties": { "^(?!(?:id|kind|status|total|processed|countValid|countInvalid|countUnknown|requestedBy|createdAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countUnknown", "requestedBy", "createdAt", "completedAt" ] } } } }, "required": [ "runs" ], "patternProperties": { "^(?!(?:runs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "runs" ] } ] } }, { "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" }, "kind": { "type": "string", "enum": [ "single", "bulk" ] }, "status": { "type": "string", "enum": [ "queued", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countValid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countInvalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "countUnknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "requestedBy": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countUnknown", "requestedBy", "createdAt", "completedAt" ], "patternProperties": { "^(?!(?:id|kind|status|total|processed|countValid|countInvalid|countUnknown|requestedBy|createdAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "status", "total", "processed", "countValid", "countInvalid", "countUnknown", "requestedBy", "createdAt", "completedAt" ] } }, { "type": "null" } ] }, { "type": "object", "properties": { "runId": { "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" }, "state": { "type": "string", "enum": [ "idle", "running", "completed", "failed" ] }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "processed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "counts": { "type": "object", "properties": { "valid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "invalid": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unknown": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "valid", "invalid", "unknown" ], "patternProperties": { "^(?!(?:valid|invalid|unknown)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] } } }, "required": [ "runId", "state", "total", "processed", "progress", "counts" ], "patternProperties": { "^(?!(?:runId|state|total|processed|progress|counts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "state", "total", "processed", "progress", "counts" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `emailVerification.status`: `GET /v1/workspaces/:workspaceId/verification/runs/:runId/status` - `emailVerification.getResult`: `GET /v1/workspaces/:workspaceId/verification/results/:email` - `emailVerification.history`: `GET /v1/workspaces/:workspaceId/verification/results/:email/history` - `emailVerification.freshness`: `POST /v1/workspaces/:workspaceId/verification/freshness` - `emailVerification.providerStats`: `GET /v1/workspaces/:workspaceId/verification/provider-stats` - `emailVerification.listRuns`: `GET /v1/workspaces/:workspaceId/verification/runs` - `emailVerification.getRun`: `GET /v1/workspaces/:workspaceId/verification/runs/:runId` - `emailVerification.creditBalance`: `GET /v1/workspaces/:workspaceId/verification/credits` - `emailVerification.estimateCredits`: `POST /v1/workspaces/:workspaceId/verification/credits/estimate` - `phoneVerification.status`: `GET /v1/workspaces/:workspaceId/phone-verification/runs/:runId/status` - `phoneVerification.getResult`: `GET /v1/workspaces/:workspaceId/phone-verification/results/:phone` - `phoneVerification.getResults`: `POST /v1/workspaces/:workspaceId/phone-verification/results/batch` - `phoneVerification.history`: `GET /v1/workspaces/:workspaceId/phone-verification/results/:phone/history` - `phoneVerification.listRuns`: `GET /v1/workspaces/:workspaceId/phone-verification/runs` - `phoneVerification.getRun`: `GET /v1/workspaces/:workspaceId/phone-verification/runs/:runId` ## read_warmup_stats Read warmup placement statistics for one inbox or the whole workspace — rates, daily series, and breakdowns, never peer identities. Use to report warmup progress, inbox placement, or follow-up funnel health for the workspace. Stats are aggregates only; they never expose warmup peer addresses, and they do not manage providers or inboxes. Scopes: inbox:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "startDate": { "$ref": "#/$defs/LocalDate" }, "endDate": { "$ref": "#/$defs/LocalDate" }, "groupBy": { "type": "string", "enum": [ "esp", "recipient_esp", "tag", "domain" ] } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|inboxId|startDate|endDate|groupBy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxId", "startDate", "endDate", "groupBy" ] }, "$defs": { "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } ``` ### 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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "startDate": { "$ref": "#/$defs/LocalDate" }, "endDate": { "$ref": "#/$defs/LocalDate" }, "groupBy": { "type": "string", "enum": [ "esp", "recipient_esp", "tag", "domain" ] } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|inboxId|startDate|endDate|groupBy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxId", "startDate", "endDate", "groupBy" ] }, "$defs": { "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "LocalDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "summary": { "type": "object", "properties": { "reputationScore": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "totalEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalEmailsReceived": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deliverabilityRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "currentDailyVolume": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "targetDailyVolume": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupProgress": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "reputationScore", "totalEmailsSent", "totalEmailsReceived", "deliverabilityRate", "currentDailyVolume", "targetDailyVolume", "warmupProgress" ], "patternProperties": { "^(?!(?:reputationScore|totalEmailsSent|totalEmailsReceived|deliverabilityRate|currentDailyVolume|targetDailyVolume|warmupProgress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reputationScore", "totalEmailsSent", "totalEmailsReceived", "deliverabilityRate", "currentDailyVolume", "targetDailyVolume", "warmupProgress" ] } }, "dailyStats": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxDelivery": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spamDelivery": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabsDelivery": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "opens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "sent", "received", "inboxDelivery", "spamDelivery", "tabsDelivery", "opens" ], "patternProperties": { "^(?!(?:date|sent|received|inboxDelivery|spamDelivery|tabsDelivery|opens)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "sent", "received", "inboxDelivery", "spamDelivery", "tabsDelivery", "opens" ] } } }, "sendsByProvider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ShortText" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "provider", "sent" ], "patternProperties": { "^(?!(?:provider|sent)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "sent" ] } } } }, "required": [ "summary", "dailyStats", "sendsByProvider" ], "patternProperties": { "^(?!(?:summary|dailyStats|sendsByProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyStats", "sendsByProvider" ] } }, { "type": "object", "properties": { "inboxesWarming": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "summary": { "type": "object", "properties": { "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sentByUs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "neverArrived": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "awaitingConfirmation": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "spamRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "tabsRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "followUp": { "type": "object", "properties": { "windowMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "observed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unavailable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pending": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "daily": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "received", "inbox", "spam", "tabs" ], "patternProperties": { "^(?!(?:date|received|inbox|spam|tabs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "received", "inbox", "spam", "tabs" ] } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "key": { "$ref": "#/$defs/ShortText" }, "label": { "$ref": "#/$defs/ShortText" }, "inboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "spamRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "tabsRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "key", "label", "inboxCount", "received", "sent", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:key|label|inboxCount|received|sent|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "label", "inboxCount", "received", "sent", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ] } } } }, "required": [ "windowMinutes", "eligible", "observed", "unavailable", "pending", "daily", "groups" ], "patternProperties": { "^(?!(?:windowMinutes|eligible|observed|unavailable|pending|daily|groups)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windowMinutes", "eligible", "observed", "unavailable", "pending", "daily", "groups" ] } } }, "required": [ "sent", "received", "inbox", "spam", "tabs", "sentByUs", "neverArrived", "awaitingConfirmation", "inboxRate", "spamRate", "tabsRate", "followUp" ], "patternProperties": { "^(?!(?:sent|received|inbox|spam|tabs|sentByUs|neverArrived|awaitingConfirmation|inboxRate|spamRate|tabsRate|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sent", "received", "inbox", "spam", "tabs", "sentByUs", "neverArrived", "awaitingConfirmation", "inboxRate", "spamRate", "tabsRate", "followUp" ] } }, "daily": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "sent", "received", "inbox", "spam", "tabs" ], "patternProperties": { "^(?!(?:date|sent|received|inbox|spam|tabs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "sent", "received", "inbox", "spam", "tabs" ] } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "key": { "$ref": "#/$defs/ShortText" }, "label": { "$ref": "#/$defs/ShortText" }, "inboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "spamRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "tabsRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "key", "label", "inboxCount", "received", "sent", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:key|label|inboxCount|received|sent|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "label", "inboxCount", "received", "sent", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ] } } } }, "required": [ "inboxesWarming", "summary", "daily", "groups" ], "patternProperties": { "^(?!(?:inboxesWarming|summary|daily|groups)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxesWarming", "summary", "daily", "groups" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "summary": { "type": "object", "properties": { "reputationScore": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "totalEmailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalEmailsReceived": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "deliverabilityRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "currentDailyVolume": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "targetDailyVolume": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warmupProgress": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "reputationScore", "totalEmailsSent", "totalEmailsReceived", "deliverabilityRate", "currentDailyVolume", "targetDailyVolume", "warmupProgress" ], "patternProperties": { "^(?!(?:reputationScore|totalEmailsSent|totalEmailsReceived|deliverabilityRate|currentDailyVolume|targetDailyVolume|warmupProgress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reputationScore", "totalEmailsSent", "totalEmailsReceived", "deliverabilityRate", "currentDailyVolume", "targetDailyVolume", "warmupProgress" ] } }, "dailyStats": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxDelivery": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spamDelivery": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabsDelivery": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "opens": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "sent", "received", "inboxDelivery", "spamDelivery", "tabsDelivery", "opens" ], "patternProperties": { "^(?!(?:date|sent|received|inboxDelivery|spamDelivery|tabsDelivery|opens)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "sent", "received", "inboxDelivery", "spamDelivery", "tabsDelivery", "opens" ] } } }, "sendsByProvider": { "type": "array", "items": { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ShortText" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "provider", "sent" ], "patternProperties": { "^(?!(?:provider|sent)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "sent" ] } } } }, "required": [ "summary", "dailyStats", "sendsByProvider" ], "patternProperties": { "^(?!(?:summary|dailyStats|sendsByProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "dailyStats", "sendsByProvider" ] } }, { "type": "object", "properties": { "inboxesWarming": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "summary": { "type": "object", "properties": { "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sentByUs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "neverArrived": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "awaitingConfirmation": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "spamRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "tabsRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "followUp": { "type": "object", "properties": { "windowMinutes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "eligible": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "observed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unavailable": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pending": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "daily": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "received", "inbox", "spam", "tabs" ], "patternProperties": { "^(?!(?:date|received|inbox|spam|tabs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "received", "inbox", "spam", "tabs" ] } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "key": { "$ref": "#/$defs/ShortText" }, "label": { "$ref": "#/$defs/ShortText" }, "inboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "spamRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "tabsRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "key", "label", "inboxCount", "received", "sent", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:key|label|inboxCount|received|sent|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "label", "inboxCount", "received", "sent", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ] } } } }, "required": [ "windowMinutes", "eligible", "observed", "unavailable", "pending", "daily", "groups" ], "patternProperties": { "^(?!(?:windowMinutes|eligible|observed|unavailable|pending|daily|groups)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "windowMinutes", "eligible", "observed", "unavailable", "pending", "daily", "groups" ] } } }, "required": [ "sent", "received", "inbox", "spam", "tabs", "sentByUs", "neverArrived", "awaitingConfirmation", "inboxRate", "spamRate", "tabsRate", "followUp" ], "patternProperties": { "^(?!(?:sent|received|inbox|spam|tabs|sentByUs|neverArrived|awaitingConfirmation|inboxRate|spamRate|tabsRate|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "sent", "received", "inbox", "spam", "tabs", "sentByUs", "neverArrived", "awaitingConfirmation", "inboxRate", "spamRate", "tabsRate", "followUp" ] } }, "daily": { "type": "array", "items": { "type": "object", "properties": { "date": { "$ref": "#/$defs/LocalDate" }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "date", "sent", "received", "inbox", "spam", "tabs" ], "patternProperties": { "^(?!(?:date|sent|received|inbox|spam|tabs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "date", "sent", "received", "inbox", "spam", "tabs" ] } } }, "groups": { "type": "array", "items": { "type": "object", "properties": { "key": { "$ref": "#/$defs/ShortText" }, "label": { "$ref": "#/$defs/ShortText" }, "inboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "received": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "sent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inbox": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "spam": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tabs": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "spamRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "tabsRate": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] } }, "required": [ "key", "label", "inboxCount", "received", "sent", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ], "patternProperties": { "^(?!(?:key|label|inboxCount|received|sent|inbox|spam|tabs|inboxRate|spamRate|tabsRate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "label", "inboxCount", "received", "sent", "inbox", "spam", "tabs", "inboxRate", "spamRate", "tabsRate" ] } } } }, "required": [ "inboxesWarming", "summary", "daily", "groups" ], "patternProperties": { "^(?!(?:inboxesWarming|summary|daily|groups)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxesWarming", "summary", "daily", "groups" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `warmupStats.inbox`: `GET /v1/workspaces/:workspaceId/warmup/stats/inboxes/:inboxId` - `warmupStats.organization`: `GET /v1/workspaces/:workspaceId/warmup/stats/organization` ## read_workflow_connectors Read what this workspace's workflow blocks can reach: which enrichment and agent providers are connected, which Conductor projects and Clay/Floqer routines a block may name, which apps and MCP servers an agent block may call and with which tools, the MXToolbox blacklist catalog, and the reply-rate report a rotation workflow acts on. Use before proposing or explaining a graph that needs a provider — it is the only way to tell whether a block would actually run — and to ground any claim about which tools an agent block is allowed to call. The MCP probe reports everything a server advertises, which is where a tool allowlist is chosen from. A connection read answers `detailsRedacted: true` when the caller may see that a provider is connected but not which key backs it; that is authorization, not an error, and the key itself is never returned to anyone. `connected: false` on a project or routine list means nothing is connected, not that the account is empty. This never connects, retires, or re-points anything. Scopes: workflow:read, integration:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "scope": { "type": "string", "enum": [ "provider_connection" ] }, "provider": { "$ref": "#/$defs/ProviderKeyConnector" } }, "required": [ "workspaceId", "scope", "provider" ], "patternProperties": { "^(?!(?:workspaceId|scope|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "provider" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "conductor_projects" ] } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "external_connection" ] }, "externalProvider": { "$ref": "#/$defs/ExternalWorkflowProvider" } }, "required": [ "workspaceId", "scope", "externalProvider" ], "patternProperties": { "^(?!(?:workspaceId|scope|externalProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "externalProvider" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "external_routine" ] }, "externalProvider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "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" }, "targetId": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "workspaceId", "scope", "externalProvider", "connectionId", "targetId" ], "patternProperties": { "^(?!(?:workspaceId|scope|externalProvider|connectionId|targetId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "externalProvider", "connectionId", "targetId" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "app_catalog" ] }, "catalog": { "type": "object", "properties": { "search": { "type": "string", "maxLength": 100 }, "cursor": { "$ref": "#/$defs/Cursor" } }, "patternProperties": { "^(?!(?:search|cursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "search", "cursor" ] } } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope|catalog)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "catalog" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "app_tools" ] }, "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" }, "cursor": { "$ref": "#/$defs/Cursor" } }, "required": [ "workspaceId", "scope", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId|scope|connectionId|cursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "connectionId", "cursor" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "mcp_servers" ] } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "mcp_server_test" ] }, "serverId": { "$ref": "#/$defs/WorkflowMcpServerId" } }, "required": [ "workspaceId", "scope", "serverId" ], "patternProperties": { "^(?!(?:workspaceId|scope|serverId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "serverId" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "mxtoolbox_connection" ] } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope" ] } }, { "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" }, "scope": { "type": "string", "enum": [ "domain_report" ] }, "workflowId": { "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", "scope", "workflowId" ], "patternProperties": { "^(?!(?:workspaceId|scope|workflowId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "workflowId" ] } } ], "$defs": { "ProviderKeyConnector": { "type": "string", "enum": [ "apollo", "prospeo", "conductor" ] }, "ExternalWorkflowProvider": { "type": "string", "enum": [ "clay", "floqer" ] }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "WorkflowMcpServerId": { "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" } } } ``` ### 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" }, "scope": { "type": "string", "enum": [ "provider_connection" ] }, "provider": { "$ref": "#/$defs/ProviderKeyConnector" } }, "required": [ "workspaceId", "scope", "provider" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|provider)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "provider" ] }, { "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" }, "scope": { "type": "string", "enum": [ "conductor_projects" ] } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope" ] }, { "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" }, "scope": { "type": "string", "enum": [ "external_connection" ] }, "externalProvider": { "$ref": "#/$defs/ExternalWorkflowProvider" } }, "required": [ "workspaceId", "scope", "externalProvider" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|externalProvider)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "externalProvider" ] }, { "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" }, "scope": { "type": "string", "enum": [ "external_routine" ] }, "externalProvider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "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" }, "targetId": { "type": "string", "minLength": 1, "maxLength": 256 } }, "required": [ "workspaceId", "scope", "externalProvider", "connectionId", "targetId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|externalProvider|connectionId|targetId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "externalProvider", "connectionId", "targetId" ] }, { "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" }, "scope": { "type": "string", "enum": [ "app_catalog" ] }, "catalog": { "type": "object", "properties": { "search": { "type": "string", "maxLength": 100 }, "cursor": { "$ref": "#/$defs/Cursor" } }, "patternProperties": { "^(?!(?:search|cursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "search", "cursor" ] } } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|catalog)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "catalog" ] }, { "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" }, "scope": { "type": "string", "enum": [ "app_tools" ] }, "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" }, "cursor": { "$ref": "#/$defs/Cursor" } }, "required": [ "workspaceId", "scope", "connectionId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|connectionId|cursor)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "connectionId", "cursor" ] }, { "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" }, "scope": { "type": "string", "enum": [ "mcp_servers" ] } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope" ] }, { "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" }, "scope": { "type": "string", "enum": [ "mcp_server_test" ] }, "serverId": { "$ref": "#/$defs/WorkflowMcpServerId" } }, "required": [ "workspaceId", "scope", "serverId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|serverId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "serverId" ] }, { "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" }, "scope": { "type": "string", "enum": [ "mxtoolbox_connection" ] } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope" ] }, { "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" }, "scope": { "type": "string", "enum": [ "domain_report" ] }, "workflowId": { "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", "scope", "workflowId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|workflowId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "scope", "workflowId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "ProviderKeyConnector": { "type": "string", "enum": [ "apollo", "prospeo", "conductor" ] }, "ExternalWorkflowProvider": { "type": "string", "enum": [ "clay", "floqer" ] }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "WorkflowMcpServerId": { "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" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ProviderKeyConnector": { "type": "string", "enum": [ "apollo", "prospeo", "conductor" ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ConnectorMediumText": { "type": "string", "minLength": 1, "maxLength": 500 }, "ExternalWorkflowProvider": { "type": "string", "enum": [ "clay", "floqer" ] }, "ConnectorLongText": { "type": "string", "minLength": 1, "maxLength": 8192 }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "WorkflowMcpServerId": { "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" }, "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ProviderKeyConnector" }, "connected": { "type": "boolean" }, "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" }, "label": { "$ref": "#/$defs/ShortText" }, "active": { "type": "boolean" }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "label", "active", "lastValidatedAt" ], "patternProperties": { "^(?!(?:id|label|active|lastValidatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "label", "active", "lastValidatedAt" ] } }, { "type": "null" } ] }, "detailsRedacted": { "type": "boolean" } }, "required": [ "provider", "connected", "connection", "detailsRedacted" ], "patternProperties": { "^(?!(?:provider|connected|connection|detailsRedacted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connected", "connection", "detailsRedacted" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "prospeo" ] }, "connected": { "type": "boolean" }, "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" }, "label": { "$ref": "#/$defs/ShortText" }, "active": { "type": "boolean" }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "label", "active", "lastValidatedAt" ], "patternProperties": { "^(?!(?:id|label|active|lastValidatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "label", "active", "lastValidatedAt" ] } }, { "type": "null" } ] }, "detailsRedacted": { "type": "boolean" }, "account": { "anyOf": [ { "type": "object", "properties": { "currentPlan": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "currentTeamMembers": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "remainingCredits": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "usedCredits": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "nextQuotaRenewalDays": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "nextQuotaRenewalDate": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "currentPlan", "currentTeamMembers", "remainingCredits", "usedCredits", "nextQuotaRenewalDays", "nextQuotaRenewalDate" ], "patternProperties": { "^(?!(?:currentPlan|currentTeamMembers|remainingCredits|usedCredits|nextQuotaRenewalDays|nextQuotaRenewalDate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "currentPlan", "currentTeamMembers", "remainingCredits", "usedCredits", "nextQuotaRenewalDays", "nextQuotaRenewalDate" ] } }, { "type": "null" } ] }, "rateLimits": { "anyOf": [ { "type": "object", "properties": { "perSecond": { "type": "integer", "exclusiveMinimum": 0 }, "perMinute": { "type": "integer", "exclusiveMinimum": 0 }, "perDay": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "perSecond", "perMinute", "perDay" ], "patternProperties": { "^(?!(?:perSecond|perMinute|perDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "perSecond", "perMinute", "perDay" ] } }, { "type": "null" } ] }, "accountRefreshError": { "type": "boolean" } }, "required": [ "provider", "connected", "connection", "detailsRedacted", "account", "rateLimits", "accountRefreshError" ], "patternProperties": { "^(?!(?:provider|connected|connection|detailsRedacted|account|rateLimits|accountRefreshError)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connected", "connection", "detailsRedacted", "account", "rateLimits", "accountRefreshError" ] } }, { "type": "object", "properties": { "connected": { "type": "boolean" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "gitRemote": { "anyOf": [ { "$ref": "#/$defs/ConnectorMediumText" }, { "type": "null" } ] } }, "required": [ "id", "name", "gitRemote" ], "patternProperties": { "^(?!(?:id|name|gitRemote)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "gitRemote" ] } }, "maxItems": 500 } }, "required": [ "connected", "projects" ], "patternProperties": { "^(?!(?:connected|projects)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "projects" ] } }, { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "id": { "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" } ] }, "connected": { "type": "boolean" }, "catalog": { "anyOf": [ { "type": "object", "properties": { "fetchedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "workspaceRef": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "$ref": "#/$defs/ConnectorLongText" }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "function", "workflow", "shortcut" ] }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "key": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4096 }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "string", "number", "integer", "boolean", "object", "array", "unsupported" ] }, "required": { "type": "boolean" }, "defaultValue": { "anyOf": [ { "$ref": "#/$defs/ConnectorMediumText" }, { "type": "null" } ] } }, "required": [ "key", "name", "description", "type", "required", "defaultValue" ], "patternProperties": { "^(?!(?:key|name|description|type|required|defaultValue)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "name", "description", "type", "required", "defaultValue" ] } }, "maxItems": 100 }, "outputs": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 }, "available": { "type": "boolean" }, "schemaAvailable": { "type": "boolean" } }, "required": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ], "patternProperties": { "^(?!(?:id|name|description|kind|inputs|outputs|available|schemaAvailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ] } }, "maxItems": 1000 } }, "required": [ "fetchedAt", "workspaceRef", "targets" ], "patternProperties": { "^(?!(?:fetchedAt|workspaceRef|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fetchedAt", "workspaceRef", "targets" ] } }, { "type": "null" } ] } }, "required": [ "provider", "id", "connected", "catalog" ], "patternProperties": { "^(?!(?:provider|id|connected|catalog)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "connected", "catalog" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "$ref": "#/$defs/ConnectorLongText" }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "function", "workflow", "shortcut" ] }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "key": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4096 }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "string", "number", "integer", "boolean", "object", "array", "unsupported" ] }, "required": { "type": "boolean" }, "defaultValue": { "anyOf": [ { "$ref": "#/$defs/ConnectorMediumText" }, { "type": "null" } ] } }, "required": [ "key", "name", "description", "type", "required", "defaultValue" ], "patternProperties": { "^(?!(?:key|name|description|type|required|defaultValue)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "name", "description", "type", "required", "defaultValue" ] } }, "maxItems": 100 }, "outputs": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 }, "available": { "type": "boolean" }, "schemaAvailable": { "type": "boolean" } }, "required": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ], "patternProperties": { "^(?!(?:id|name|description|kind|inputs|outputs|available|schemaAvailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ] } }, { "type": "object", "properties": { "configured": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "slug": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "logoUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "noAuth": { "type": "boolean" } }, "required": [ "slug", "name", "description", "logoUrl", "noAuth" ], "patternProperties": { "^(?!(?:slug|name|description|logoUrl|noAuth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "slug", "name", "description", "logoUrl", "noAuth" ] } }, "maxItems": 50 }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "configured", "items", "nextCursor" ], "patternProperties": { "^(?!(?:configured|items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "configured", "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "slug": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "scopes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 }, "tags": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 50 } }, "required": [ "slug", "name", "description", "scopes", "tags" ], "patternProperties": { "^(?!(?:slug|name|description|scopes|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "slug", "name", "description", "scopes", "tags" ] } }, "maxItems": 500 }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "name": { "$ref": "#/$defs/ShortText" }, "url": { "$ref": "#/$defs/HttpUrl" }, "composio": { "anyOf": [ { "type": "object", "properties": { "toolkitSlug": { "$ref": "#/$defs/ShortText" }, "custom": { "type": "boolean" }, "noAuth": { "type": "boolean" }, "authorizationPending": { "type": "boolean" } }, "required": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ], "patternProperties": { "^(?!(?:toolkitSlug|custom|noAuth|authorizationPending)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ] } }, { "type": "null" } ] }, "allowedToolNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 40 }, "active": { "type": "boolean" }, "authorizationConfigured": { "type": "boolean" }, "credentialRefId": { "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" } ] }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|composio|allowedToolNames|active|authorizationConfigured|credentialRefId|lastValidatedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ] } }, "maxItems": 200 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "ok": { "type": "boolean" }, "toolNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 500 }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "ok", "toolNames", "error", "lastValidatedAt" ], "patternProperties": { "^(?!(?:id|ok|toolNames|error|lastValidatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "ok", "toolNames", "error", "lastValidatedAt" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "mxtoolbox" ] }, "id": { "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" } ] }, "connected": { "type": "boolean" }, "catalog": { "anyOf": [ { "type": "object", "properties": { "fetchedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, "minItems": 1, "maxItems": 1000 } }, "required": [ "fetchedAt", "entries" ], "patternProperties": { "^(?!(?:fetchedAt|entries)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fetchedAt", "entries" ] } }, { "type": "null" } ] }, "usage": { "anyOf": [ { "type": "object", "properties": { "dnsRequests": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "dnsMax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "networkRequests": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "networkMax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "dnsRequests", "dnsMax", "networkRequests", "networkMax" ], "patternProperties": { "^(?!(?:dnsRequests|dnsMax|networkRequests|networkMax)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsRequests", "dnsMax", "networkRequests", "networkMax" ] } }, { "type": "null" } ] }, "usageRedacted": { "type": "boolean" } }, "required": [ "provider", "id", "connected", "catalog", "usage", "usageRedacted" ], "patternProperties": { "^(?!(?:provider|id|connected|catalog|usage|usageRedacted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "connected", "catalog", "usage", "usageRedacted" ] } }, { "anyOf": [ { "type": "object", "properties": { "configured": { "type": "boolean", "enum": [ false ] }, "workflowId": { "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" }, "evaluatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "configured", "workflowId", "evaluatedAt" ], "patternProperties": { "^(?!(?:configured|workflowId|evaluatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "configured", "workflowId", "evaluatedAt" ] } }, { "type": "object", "properties": { "configured": { "type": "boolean", "enum": [ true ] }, "workflowId": { "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" }, "analysisLevel": { "type": "string", "enum": [ "domain", "inbox" ] }, "domains": { "type": "array", "items": { "type": "object", "properties": { "domain": { "$ref": "#/$defs/DomainName" }, "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" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 }, "contacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRate": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "averageReplyRate": { "type": "number", "minimum": 0 }, "belowAveragePercent": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "eligibleSamples": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "flagged": { "type": "boolean" } }, "required": [ "domain", "inboxId", "emailAddress", "inboxIds", "contacts", "replied", "replyRate", "averageReplyRate", "belowAveragePercent", "eligibleSamples", "flagged" ], "patternProperties": { "^(?!(?:domain|inboxId|emailAddress|inboxIds|contacts|replied|replyRate|averageReplyRate|belowAveragePercent|eligibleSamples|flagged)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "domain", "inboxId", "emailAddress", "inboxIds", "contacts", "replied", "replyRate", "averageReplyRate", "belowAveragePercent", "eligibleSamples", "flagged" ] } }, "maxItems": 1000 }, "reserves": { "type": "array", "items": { "type": "object", "properties": { "domain": { "$ref": "#/$defs/DomainName" }, "inboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxes": { "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" } }, "required": [ "id", "emailAddress" ], "patternProperties": { "^(?!(?:id|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress" ] } }, "maxItems": 500 } }, "required": [ "domain", "inboxCount", "inboxes" ], "patternProperties": { "^(?!(?:domain|inboxCount|inboxes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "domain", "inboxCount", "inboxes" ] } }, "maxItems": 1000 }, "evaluatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "configured", "workflowId", "analysisLevel", "domains", "reserves", "evaluatedAt" ], "patternProperties": { "^(?!(?:configured|workflowId|analysisLevel|domains|reserves|evaluatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "configured", "workflowId", "analysisLevel", "domains", "reserves", "evaluatedAt" ] } } ] } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ProviderKeyConnector" }, "connected": { "type": "boolean" }, "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" }, "label": { "$ref": "#/$defs/ShortText" }, "active": { "type": "boolean" }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "label", "active", "lastValidatedAt" ], "patternProperties": { "^(?!(?:id|label|active|lastValidatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "label", "active", "lastValidatedAt" ] } }, { "type": "null" } ] }, "detailsRedacted": { "type": "boolean" } }, "required": [ "provider", "connected", "connection", "detailsRedacted" ], "patternProperties": { "^(?!(?:provider|connected|connection|detailsRedacted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connected", "connection", "detailsRedacted" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "prospeo" ] }, "connected": { "type": "boolean" }, "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" }, "label": { "$ref": "#/$defs/ShortText" }, "active": { "type": "boolean" }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "label", "active", "lastValidatedAt" ], "patternProperties": { "^(?!(?:id|label|active|lastValidatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "label", "active", "lastValidatedAt" ] } }, { "type": "null" } ] }, "detailsRedacted": { "type": "boolean" }, "account": { "anyOf": [ { "type": "object", "properties": { "currentPlan": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "currentTeamMembers": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "remainingCredits": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "usedCredits": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "nextQuotaRenewalDays": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "nextQuotaRenewalDate": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "currentPlan", "currentTeamMembers", "remainingCredits", "usedCredits", "nextQuotaRenewalDays", "nextQuotaRenewalDate" ], "patternProperties": { "^(?!(?:currentPlan|currentTeamMembers|remainingCredits|usedCredits|nextQuotaRenewalDays|nextQuotaRenewalDate)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "currentPlan", "currentTeamMembers", "remainingCredits", "usedCredits", "nextQuotaRenewalDays", "nextQuotaRenewalDate" ] } }, { "type": "null" } ] }, "rateLimits": { "anyOf": [ { "type": "object", "properties": { "perSecond": { "type": "integer", "exclusiveMinimum": 0 }, "perMinute": { "type": "integer", "exclusiveMinimum": 0 }, "perDay": { "type": "integer", "exclusiveMinimum": 0 } }, "required": [ "perSecond", "perMinute", "perDay" ], "patternProperties": { "^(?!(?:perSecond|perMinute|perDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "perSecond", "perMinute", "perDay" ] } }, { "type": "null" } ] }, "accountRefreshError": { "type": "boolean" } }, "required": [ "provider", "connected", "connection", "detailsRedacted", "account", "rateLimits", "accountRefreshError" ], "patternProperties": { "^(?!(?:provider|connected|connection|detailsRedacted|account|rateLimits|accountRefreshError)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connected", "connection", "detailsRedacted", "account", "rateLimits", "accountRefreshError" ] } }, { "type": "object", "properties": { "connected": { "type": "boolean" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "gitRemote": { "anyOf": [ { "$ref": "#/$defs/ConnectorMediumText" }, { "type": "null" } ] } }, "required": [ "id", "name", "gitRemote" ], "patternProperties": { "^(?!(?:id|name|gitRemote)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "gitRemote" ] } }, "maxItems": 500 } }, "required": [ "connected", "projects" ], "patternProperties": { "^(?!(?:connected|projects)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "projects" ] } }, { "type": "object", "properties": { "provider": { "$ref": "#/$defs/ExternalWorkflowProvider" }, "id": { "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" } ] }, "connected": { "type": "boolean" }, "catalog": { "anyOf": [ { "type": "object", "properties": { "fetchedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "workspaceRef": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "$ref": "#/$defs/ConnectorLongText" }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "function", "workflow", "shortcut" ] }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "key": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4096 }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "string", "number", "integer", "boolean", "object", "array", "unsupported" ] }, "required": { "type": "boolean" }, "defaultValue": { "anyOf": [ { "$ref": "#/$defs/ConnectorMediumText" }, { "type": "null" } ] } }, "required": [ "key", "name", "description", "type", "required", "defaultValue" ], "patternProperties": { "^(?!(?:key|name|description|type|required|defaultValue)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "name", "description", "type", "required", "defaultValue" ] } }, "maxItems": 100 }, "outputs": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 }, "available": { "type": "boolean" }, "schemaAvailable": { "type": "boolean" } }, "required": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ], "patternProperties": { "^(?!(?:id|name|description|kind|inputs|outputs|available|schemaAvailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ] } }, "maxItems": 1000 } }, "required": [ "fetchedAt", "workspaceRef", "targets" ], "patternProperties": { "^(?!(?:fetchedAt|workspaceRef|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fetchedAt", "workspaceRef", "targets" ] } }, { "type": "null" } ] } }, "required": [ "provider", "id", "connected", "catalog" ], "patternProperties": { "^(?!(?:provider|id|connected|catalog)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "connected", "catalog" ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "$ref": "#/$defs/ConnectorLongText" }, { "type": "null" } ] }, "kind": { "type": "string", "enum": [ "function", "workflow", "shortcut" ] }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "key": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 4096 }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "string", "number", "integer", "boolean", "object", "array", "unsupported" ] }, "required": { "type": "boolean" }, "defaultValue": { "anyOf": [ { "$ref": "#/$defs/ConnectorMediumText" }, { "type": "null" } ] } }, "required": [ "key", "name", "description", "type", "required", "defaultValue" ], "patternProperties": { "^(?!(?:key|name|description|type|required|defaultValue)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "name", "description", "type", "required", "defaultValue" ] } }, "maxItems": 100 }, "outputs": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 }, "available": { "type": "boolean" }, "schemaAvailable": { "type": "boolean" } }, "required": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ], "patternProperties": { "^(?!(?:id|name|description|kind|inputs|outputs|available|schemaAvailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "description", "kind", "inputs", "outputs", "available", "schemaAvailable" ] } }, { "type": "object", "properties": { "configured": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "slug": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "logoUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "noAuth": { "type": "boolean" } }, "required": [ "slug", "name", "description", "logoUrl", "noAuth" ], "patternProperties": { "^(?!(?:slug|name|description|logoUrl|noAuth)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "slug", "name", "description", "logoUrl", "noAuth" ] } }, "maxItems": 50 }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "configured", "items", "nextCursor" ], "patternProperties": { "^(?!(?:configured|items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "configured", "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "slug": { "$ref": "#/$defs/ShortText" }, "name": { "$ref": "#/$defs/ConnectorMediumText" }, "description": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "scopes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 100 }, "tags": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 50 } }, "required": [ "slug", "name", "description", "scopes", "tags" ], "patternProperties": { "^(?!(?:slug|name|description|scopes|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "slug", "name", "description", "scopes", "tags" ] } }, "maxItems": 500 }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "name": { "$ref": "#/$defs/ShortText" }, "url": { "$ref": "#/$defs/HttpUrl" }, "composio": { "anyOf": [ { "type": "object", "properties": { "toolkitSlug": { "$ref": "#/$defs/ShortText" }, "custom": { "type": "boolean" }, "noAuth": { "type": "boolean" }, "authorizationPending": { "type": "boolean" } }, "required": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ], "patternProperties": { "^(?!(?:toolkitSlug|custom|noAuth|authorizationPending)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "toolkitSlug", "custom", "noAuth", "authorizationPending" ] } }, { "type": "null" } ] }, "allowedToolNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 40 }, "active": { "type": "boolean" }, "authorizationConfigured": { "type": "boolean" }, "credentialRefId": { "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" } ] }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|url|composio|allowedToolNames|active|authorizationConfigured|credentialRefId|lastValidatedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "url", "composio", "allowedToolNames", "active", "authorizationConfigured", "credentialRefId", "lastValidatedAt", "createdAt", "updatedAt" ] } }, "maxItems": 200 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowMcpServerId" }, "ok": { "type": "boolean" }, "toolNames": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 500 }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "lastValidatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "ok", "toolNames", "error", "lastValidatedAt" ], "patternProperties": { "^(?!(?:id|ok|toolNames|error|lastValidatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "ok", "toolNames", "error", "lastValidatedAt" ] } }, { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "mxtoolbox" ] }, "id": { "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" } ] }, "connected": { "type": "boolean" }, "catalog": { "anyOf": [ { "type": "object", "properties": { "fetchedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/OpaqueId" }, "name": { "$ref": "#/$defs/ConnectorMediumText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, "minItems": 1, "maxItems": 1000 } }, "required": [ "fetchedAt", "entries" ], "patternProperties": { "^(?!(?:fetchedAt|entries)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "fetchedAt", "entries" ] } }, { "type": "null" } ] }, "usage": { "anyOf": [ { "type": "object", "properties": { "dnsRequests": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "dnsMax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "networkRequests": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "networkMax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "dnsRequests", "dnsMax", "networkRequests", "networkMax" ], "patternProperties": { "^(?!(?:dnsRequests|dnsMax|networkRequests|networkMax)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "dnsRequests", "dnsMax", "networkRequests", "networkMax" ] } }, { "type": "null" } ] }, "usageRedacted": { "type": "boolean" } }, "required": [ "provider", "id", "connected", "catalog", "usage", "usageRedacted" ], "patternProperties": { "^(?!(?:provider|id|connected|catalog|usage|usageRedacted)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "id", "connected", "catalog", "usage", "usageRedacted" ] } }, { "anyOf": [ { "type": "object", "properties": { "configured": { "type": "boolean", "enum": [ false ] }, "workflowId": { "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" }, "evaluatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "configured", "workflowId", "evaluatedAt" ], "patternProperties": { "^(?!(?:configured|workflowId|evaluatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "configured", "workflowId", "evaluatedAt" ] } }, { "type": "object", "properties": { "configured": { "type": "boolean", "enum": [ true ] }, "workflowId": { "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" }, "analysisLevel": { "type": "string", "enum": [ "domain", "inbox" ] }, "domains": { "type": "array", "items": { "type": "object", "properties": { "domain": { "$ref": "#/$defs/DomainName" }, "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" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 }, "contacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "replyRate": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "averageReplyRate": { "type": "number", "minimum": 0 }, "belowAveragePercent": { "anyOf": [ { "type": "number", "minimum": 0 }, { "type": "null" } ] }, "eligibleSamples": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "flagged": { "type": "boolean" } }, "required": [ "domain", "inboxId", "emailAddress", "inboxIds", "contacts", "replied", "replyRate", "averageReplyRate", "belowAveragePercent", "eligibleSamples", "flagged" ], "patternProperties": { "^(?!(?:domain|inboxId|emailAddress|inboxIds|contacts|replied|replyRate|averageReplyRate|belowAveragePercent|eligibleSamples|flagged)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "domain", "inboxId", "emailAddress", "inboxIds", "contacts", "replied", "replyRate", "averageReplyRate", "belowAveragePercent", "eligibleSamples", "flagged" ] } }, "maxItems": 1000 }, "reserves": { "type": "array", "items": { "type": "object", "properties": { "domain": { "$ref": "#/$defs/DomainName" }, "inboxCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inboxes": { "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" } }, "required": [ "id", "emailAddress" ], "patternProperties": { "^(?!(?:id|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress" ] } }, "maxItems": 500 } }, "required": [ "domain", "inboxCount", "inboxes" ], "patternProperties": { "^(?!(?:domain|inboxCount|inboxes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "domain", "inboxCount", "inboxes" ] } }, "maxItems": 1000 }, "evaluatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "configured", "workflowId", "analysisLevel", "domains", "reserves", "evaluatedAt" ], "patternProperties": { "^(?!(?:configured|workflowId|analysisLevel|domains|reserves|evaluatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "configured", "workflowId", "analysisLevel", "domains", "reserves", "evaluatedAt" ] } } ] } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `workflowConnectors.apollo`: `GET /v1/workspaces/:workspaceId/workflows/integrations/apollo` - `workflowConnectors.prospeo`: `GET /v1/workspaces/:workspaceId/workflows/integrations/prospeo` - `workflowConnectors.conductor`: `GET /v1/workspaces/:workspaceId/workflows/integrations/conductor` - `workflowConnectors.conductorProjects`: `GET /v1/workspaces/:workspaceId/workflows/options/conductor-projects` - `workflowConnectors.external`: `GET /v1/workspaces/:workspaceId/workflows/integrations/external/:provider` - `workflowConnectors.describeExternalTarget`: `GET /v1/workspaces/:workspaceId/workflows/integrations/external/:provider/:connectionId/routines/:targetId` - `workflowIntegrations.catalog`: `GET /v1/workspaces/:workspaceId/workflows/integrations/apps` - `workflowIntegrations.tools`: `GET /v1/workspaces/:workspaceId/workflows/integrations/apps/:connectionId/tools` - `workflowMcpServers.list`: `GET /v1/workspaces/:workspaceId/workflows/mcp-servers` - `workflowMcpServers.test`: `POST /v1/workspaces/:workspaceId/workflows/mcp-servers/:serverId/test` - `workflowDomainHealth.mxtoolbox`: `GET /v1/workspaces/:workspaceId/workflows/integrations/mxtoolbox` - `workflowDomainHealth.domainReport`: `GET /v1/workspaces/:workspaceId/workflows/:workflowId/domain-report` ## read_workflows Read the workspace's automation: what workflows exist and what they trigger on, what their runs did step by step, which inbound webhook attempts arrived, what alerts are open, what is running on a conversation, and the option lists a graph can reference. Use to ground any claim about automation — whether a workflow is live, why a run stopped, whether a webhook ever arrived, or which call list, sequence, inbox, or destination workflow a block could name. `simulate` replays a graph against a real past reply without executing anything. Node outputs are withheld when the caller lacks the permission for the data's SOURCE, so an execution can appear with an empty result; that is authorization, not an error. An option list with `authorized: false` is a missing permission, not an empty workspace. This never changes a graph, starts a run, or answers a pending AI draft. Scopes: workflow:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "scope": { "type": "string", "enum": [ "list", "workflow", "runs", "trigger_logs", "alerts", "thread_automation", "call_list_options", "sequence_options", "inbox_scope_options", "enrollment_targets", "test_replies", "simulate" ] }, "workflowId": { "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" }, "threadId": { "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" }, "runs": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 50 }, "runId": { "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|runId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "runId" ] } }, "triggerLogs": { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 50 }, "outcome": { "type": "string", "enum": [ "received", "accepted", "rejected", "sample", "ignored", "duplicate", "error" ] } }, "patternProperties": { "^(?!(?:cursor|limit|outcome)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit", "outcome" ] } }, "testReplies": { "type": "object", "properties": { "workflowId": { "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" }, "search": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "workflowId" ], "patternProperties": { "^(?!(?:workflowId|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workflowId", "search" ] } }, "simulate": { "type": "object", "properties": { "messageId": { "$ref": "#/$defs/OpaqueId" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "graph": { "type": "object", "properties": { "schemaVersion": { "anyOf": [ { "type": "number", "enum": [ 1 ] } ] }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "patternProperties": { "^(?!(?:x|y)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y" ] } }, "data": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "id", "type", "position", "data" ], "patternProperties": { "^(?!(?:id|type|position|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "position", "data" ] } }, "maxItems": 200 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "minLength": 1, "maxLength": 128 }, "target": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceHandle": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] } }, "required": [ "id", "source", "target" ], "patternProperties": { "^(?!(?:id|source|target|sourceHandle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "source", "target", "sourceHandle" ] } }, "maxItems": 400 } }, "required": [ "schemaVersion", "nodes", "edges" ], "patternProperties": { "^(?!(?:schemaVersion|nodes|edges)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "nodes", "edges" ] } } }, "required": [ "messageId", "name", "graph" ], "patternProperties": { "^(?!(?:messageId|name|graph)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "name", "graph" ] } }, "enrollmentTargets": { "type": "object", "properties": { "excludeId": { "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": { "^(?!(?:excludeId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "excludeId" ] } ] } } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope|workflowId|threadId|runs|triggerLogs|testReplies|simulate|enrollmentTargets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "workflowId", "threadId", "runs", "triggerLogs", "testReplies", "simulate", "enrollmentTargets" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] } } } ``` ### 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" }, "scope": { "type": "string", "enum": [ "list", "workflow", "runs", "trigger_logs", "alerts", "thread_automation", "call_list_options", "sequence_options", "inbox_scope_options", "enrollment_targets", "test_replies", "simulate" ] }, "workflowId": { "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" }, "threadId": { "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" }, "runs": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 50 }, "runId": { "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|runId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "runId" ] } }, "triggerLogs": { "type": "object", "properties": { "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 50 }, "outcome": { "type": "string", "enum": [ "received", "accepted", "rejected", "sample", "ignored", "duplicate", "error" ] } }, "patternProperties": { "^(?!(?:cursor|limit|outcome)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "cursor", "limit", "outcome" ] } }, "testReplies": { "type": "object", "properties": { "workflowId": { "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" }, "search": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "workflowId" ], "patternProperties": { "^(?!(?:workflowId|search)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workflowId", "search" ] } }, "simulate": { "type": "object", "properties": { "messageId": { "$ref": "#/$defs/OpaqueId" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "graph": { "type": "object", "properties": { "schemaVersion": { "anyOf": [ { "type": "number", "enum": [ 1 ] } ] }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "patternProperties": { "^(?!(?:x|y)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y" ] } }, "data": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "id", "type", "position", "data" ], "patternProperties": { "^(?!(?:id|type|position|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "position", "data" ] } }, "maxItems": 200 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "minLength": 1, "maxLength": 128 }, "target": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceHandle": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] } }, "required": [ "id", "source", "target" ], "patternProperties": { "^(?!(?:id|source|target|sourceHandle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "source", "target", "sourceHandle" ] } }, "maxItems": 400 } }, "required": [ "schemaVersion", "nodes", "edges" ], "patternProperties": { "^(?!(?:schemaVersion|nodes|edges)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "nodes", "edges" ] } } }, "required": [ "messageId", "name", "graph" ], "patternProperties": { "^(?!(?:messageId|name|graph)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "name", "graph" ] } }, "enrollmentTargets": { "type": "object", "properties": { "excludeId": { "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": { "^(?!(?:excludeId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "excludeId" ] } ] } } }, "required": [ "workspaceId", "scope" ], "patternProperties": { "^(?!(?:workspaceId|scope|workflowId|threadId|runs|triggerLogs|testReplies|simulate|enrollmentTargets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope", "workflowId", "threadId", "runs", "triggerLogs", "testReplies", "simulate", "enrollmentTargets" ] }, "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "WorkflowVersionId": { "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" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "WorkflowNodeExecutionId": { "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" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "WorkflowFollowUpId": { "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": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "WorkflowFollowUpDraftId": { "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" }, "WorkflowTriggerLogId": { "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" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "WorkflowAlertId": { "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" }, "CallListId": { "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" }, "HexColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" }, "LeadStoredText": { "type": "string", "maxLength": 65536 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "deleting" ] }, "publishedVersionId": { "anyOf": [ { "$ref": "#/$defs/WorkflowVersionId" }, { "type": "null" } ] }, "triggerType": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, { "type": "null" } ] }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|status|publishedVersionId|triggerType|alertCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "deleting" ] }, "publishedVersionId": { "anyOf": [ { "$ref": "#/$defs/WorkflowVersionId" }, { "type": "null" } ] }, "triggerType": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, { "type": "null" } ] }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "version": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowVersionId" }, "workflowId": { "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" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "graph": { "type": "object", "properties": { "schemaVersion": { "anyOf": [ { "type": "number", "enum": [ 1 ] } ] }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "patternProperties": { "^(?!(?:x|y)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y" ] } }, "data": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "id", "type", "position", "data" ], "patternProperties": { "^(?!(?:id|type|position|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "position", "data" ] } }, "maxItems": 200 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "minLength": 1, "maxLength": 128 }, "target": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceHandle": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] } }, "required": [ "id", "source", "target" ], "patternProperties": { "^(?!(?:id|source|target|sourceHandle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "source", "target", "sourceHandle" ] } }, "maxItems": 400 } }, "required": [ "schemaVersion", "nodes", "edges" ], "patternProperties": { "^(?!(?:schemaVersion|nodes|edges)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "nodes", "edges" ] } }, "publishedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workflowId|version|graph|publishedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ] } }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt", "version" ], "patternProperties": { "^(?!(?:id|name|status|publishedVersionId|triggerType|alertCount|createdAt|updatedAt|version)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt", "version" ] } }, { "type": "object", "properties": { "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" }, "workflowId": { "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" }, "workflowVersionId": { "$ref": "#/$defs/WorkflowVersionId" }, "status": { "type": "string", "enum": [ "queued", "running", "paused", "completed", "failed" ] }, "error": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "leadId": { "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" } ] }, "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" } ] }, "threadId": { "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" } ] }, "triggerEvent": { "$ref": "#/$defs/ShortText" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "startedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "executions": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowNodeExecutionId" }, "nodeId": { "type": "string", "minLength": 1, "maxLength": 128 }, "nodeType": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "status": { "type": "string", "enum": [ "running", "paused", "completed", "failed", "skipped" ] }, "error": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "branch": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] }, "outputsRedacted": { "type": "boolean" }, "externalRunId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "externalRestartRequiresAcknowledgement": { "type": "boolean" }, "externalResult": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "workflowResult": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "healthResult": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "domainRotation": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "getleadsResult": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "agentText": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "childRunId": { "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" } ] }, "childWorkflowId": { "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" } ] }, "humanRequestTaskId": { "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" } ] }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "nodeId", "nodeType", "status", "error", "branch", "outputsRedacted", "externalRunId", "externalRestartRequiresAcknowledgement", "externalResult", "workflowResult", "healthResult", "domainRotation", "getleadsResult", "agentText", "childRunId", "childWorkflowId", "humanRequestTaskId", "startedAt", "completedAt" ], "patternProperties": { "^(?!(?:id|nodeId|nodeType|status|error|branch|outputsRedacted|externalRunId|externalRestartRequiresAcknowledgement|externalResult|workflowResult|healthResult|domainRotation|getleadsResult|agentText|childRunId|childWorkflowId|humanRequestTaskId|startedAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "nodeId", "nodeType", "status", "error", "branch", "outputsRedacted", "externalRunId", "externalRestartRequiresAcknowledgement", "externalResult", "workflowResult", "healthResult", "domainRotation", "getleadsResult", "agentText", "childRunId", "childWorkflowId", "humanRequestTaskId", "startedAt", "completedAt" ] } }, "maxItems": 200 }, "followUp": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowFollowUpId" }, "runId": { "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" }, "threadId": { "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "counterpartyEmail": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "active", "awaiting_approval", "completed", "stopped" ] }, "stopReason": { "anyOf": [ { "type": "string", "enum": [ "replied", "booked", "human_took_over", "negative_label", "unsubscribed", "thread_gone", "stopped_by_user", "agent_unauthorized", "exhausted" ] }, { "type": "null" } ] }, "maxAttempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "attemptsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAttemptAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastOutboundAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "drafts": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowFollowUpDraftId" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "pending", "approved", "edited", "rejected", "sent", "expired" ] }, "bodyText": { "type": "string", "minLength": 1, "maxLength": 4000 }, "modelReason": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "toolTrace": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "null" } ] }, "sentMessageId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "attempt", "status", "bodyText", "modelReason", "toolTrace", "sentMessageId", "createdAt" ], "patternProperties": { "^(?!(?:id|attempt|status|bodyText|modelReason|toolTrace|sentMessageId|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "attempt", "status", "bodyText", "modelReason", "toolTrace", "sentMessageId", "createdAt" ] } }, "maxItems": 100 } }, "required": [ "id", "runId", "threadId", "inboxId", "counterpartyEmail", "status", "stopReason", "maxAttempts", "attemptsSent", "nextAttemptAt", "lastOutboundAt", "completedAt", "drafts" ], "patternProperties": { "^(?!(?:id|runId|threadId|inboxId|counterpartyEmail|status|stopReason|maxAttempts|attemptsSent|nextAttemptAt|lastOutboundAt|completedAt|drafts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "runId", "threadId", "inboxId", "counterpartyEmail", "status", "stopReason", "maxAttempts", "attemptsSent", "nextAttemptAt", "lastOutboundAt", "completedAt", "drafts" ] } }, { "type": "null" } ] } }, "required": [ "id", "workflowId", "workflowVersionId", "status", "error", "leadId", "inboxId", "threadId", "triggerEvent", "createdAt", "startedAt", "completedAt", "executions", "followUp" ], "patternProperties": { "^(?!(?:id|workflowId|workflowVersionId|status|error|leadId|inboxId|threadId|triggerEvent|createdAt|startedAt|completedAt|executions|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "workflowVersionId", "status", "error", "leadId", "inboxId", "threadId", "triggerEvent", "createdAt", "startedAt", "completedAt", "executions", "followUp" ] } }, "maxItems": 50 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowTriggerLogId" }, "workflowId": { "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" }, "workflowVersionId": { "$ref": "#/$defs/WorkflowVersionId" }, "provider": { "$ref": "#/$defs/ShortText" }, "webhookId": { "$ref": "#/$defs/OpaqueId" }, "outcome": { "type": "string", "enum": [ "received", "accepted", "rejected", "sample", "ignored", "duplicate", "error" ] }, "reason": { "type": "string", "enum": [ "processing", "admitted", "invalid_signature", "invalid_payload", "workspace_mismatch", "webhook_mismatch", "event_not_selected", "campaign_not_selected", "provider_sample", "duplicate", "webhook_inactive", "effects_disabled", "workflow_inactive", "conditions_not_met", "lead_not_found", "processing_failed", "payload_too_large", "missing_payload", "body_read_failed" ] }, "httpStatus": { "anyOf": [ { "type": "integer", "minimum": 100, "maximum": 599 }, { "type": "null" } ] }, "runId": { "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" } ] }, "requestFields": { "type": "object", "additionalProperties": { "$ref": "#/$defs/ShortText" } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "workflowId", "workflowVersionId", "provider", "webhookId", "outcome", "reason", "httpStatus", "runId", "requestFields", "createdAt", "completedAt" ], "patternProperties": { "^(?!(?:id|workflowId|workflowVersionId|provider|webhookId|outcome|reason|httpStatus|runId|requestFields|createdAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "workflowVersionId", "provider", "webhookId", "outcome", "reason", "httpStatus", "runId", "requestFields", "createdAt", "completedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowAlertId" }, "workflowId": { "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" }, "workflowRunId": { "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" } ] }, "nodeId": { "type": "string", "minLength": 1, "maxLength": 128 }, "code": { "$ref": "#/$defs/ShortText" }, "message": { "$ref": "#/$defs/Description" }, "relatedWorkflowId": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workflowId", "workflowRunId", "nodeId", "code", "message", "relatedWorkflowId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workflowId|workflowRunId|nodeId|code|message|relatedWorkflowId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "workflowRunId", "nodeId", "code", "message", "relatedWorkflowId", "createdAt", "updatedAt" ] } }, "maxItems": 200 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "automation": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "follow_up" ] } ] }, "id": { "$ref": "#/$defs/WorkflowFollowUpId" }, "runId": { "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" }, "workflowId": { "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" }, "workflowName": { "type": "string", "minLength": 1, "maxLength": 120 }, "runStatus": { "type": "string", "enum": [ "queued", "running", "paused", "completed", "failed" ] }, "status": { "type": "string", "enum": [ "active", "awaiting_approval", "completed", "stopped" ] }, "attemptsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxAttempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAttemptAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "stopReason": { "anyOf": [ { "type": "string", "enum": [ "replied", "booked", "human_took_over", "negative_label", "unsubscribed", "thread_gone", "stopped_by_user", "agent_unauthorized", "exhausted" ] }, { "type": "null" } ] }, "pendingDraftId": { "anyOf": [ { "$ref": "#/$defs/WorkflowFollowUpDraftId" }, { "type": "null" } ] } }, "required": [ "kind", "id", "runId", "workflowId", "workflowName", "runStatus", "status", "attemptsSent", "maxAttempts", "nextAttemptAt", "stopReason", "pendingDraftId" ], "patternProperties": { "^(?!(?:kind|id|runId|workflowId|workflowName|runStatus|status|attemptsSent|maxAttempts|nextAttemptAt|stopReason|pendingDraftId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "id", "runId", "workflowId", "workflowName", "runStatus", "status", "attemptsSent", "maxAttempts", "nextAttemptAt", "stopReason", "pendingDraftId" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "sequence" ] } ] }, "enrollmentId": { "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" }, "sequenceId": { "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" }, "sequenceName": { "$ref": "#/$defs/ShortText" }, "childContactId": { "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" } ] }, "contactStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "currentStep": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSteps": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "kind", "enrollmentId", "sequenceId", "sequenceName", "childContactId", "contactStatus", "currentStep", "totalSteps" ], "patternProperties": { "^(?!(?:kind|enrollmentId|sequenceId|sequenceName|childContactId|contactStatus|currentStep|totalSteps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "enrollmentId", "sequenceId", "sequenceName", "childContactId", "contactStatus", "currentStep", "totalSteps" ] } } ] }, { "type": "null" } ] } }, "required": [ "automation" ], "patternProperties": { "^(?!(?:automation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "automation" ] } ] } }, { "type": "object", "properties": { "authorized": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/CallListId" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, "maxItems": 500 } }, "required": [ "authorized", "items" ], "patternProperties": { "^(?!(?:authorized|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authorized", "items" ] } }, { "type": "object", "properties": { "authorized": { "type": "boolean" }, "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, "maxItems": 500 } }, "required": [ "authorized", "items" ], "patternProperties": { "^(?!(?:authorized|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authorized", "items" ] } }, { "type": "object", "properties": { "authorized": { "type": "boolean" }, "inboxes": { "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", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] } }, "required": [ "id", "emailAddress", "provider", "status" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status" ] } }, "maxItems": 2000 }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } }, "maxItems": 500 } }, "required": [ "authorized", "inboxes", "tags" ], "patternProperties": { "^(?!(?:authorized|inboxes|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authorized", "inboxes", "tags" ] } }, { "type": "object", "properties": { "authorized": { "type": "boolean" }, "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "versionId": { "$ref": "#/$defs/WorkflowVersionId" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "type": { "type": "string", "enum": [ "string", "domain", "number", "boolean", "object", "array" ] }, "required": { "type": "boolean" }, "description": { "type": "string", "minLength": 1, "maxLength": 300 } }, "required": [ "name", "type", "required" ], "patternProperties": { "^(?!(?:name|type|required|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "required", "description" ] } }, "maxItems": 50 }, "outputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "type": { "type": "string", "enum": [ "string", "domain", "number", "boolean", "object", "array" ] }, "required": { "type": "boolean" }, "description": { "type": "string", "minLength": 1, "maxLength": 300 } }, "required": [ "name", "type", "required" ], "patternProperties": { "^(?!(?:name|type|required|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "required", "description" ] } }, "maxItems": 50 } }, "required": [ "id", "name", "versionId", "inputs", "outputs" ], "patternProperties": { "^(?!(?:id|name|versionId|inputs|outputs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "versionId", "inputs", "outputs" ] } }, "maxItems": 500 } }, "required": [ "authorized", "items" ], "patternProperties": { "^(?!(?:authorized|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authorized", "items" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "messageId": { "$ref": "#/$defs/OpaqueId" }, "threadId": { "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" }, "from": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "label": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "messageId", "threadId", "from", "subject", "snippet", "receivedAt", "label" ], "patternProperties": { "^(?!(?:messageId|threadId|from|subject|snippet|receivedAt|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "threadId", "from", "subject", "snippet", "receivedAt", "label" ] } }, "maxItems": 50 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "reply": { "type": "object", "properties": { "messageId": { "$ref": "#/$defs/OpaqueId" }, "threadId": { "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" }, "from": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "label": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "messageId", "threadId", "from", "subject", "snippet", "receivedAt", "label" ], "patternProperties": { "^(?!(?:messageId|threadId|from|subject|snippet|receivedAt|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "threadId", "from", "subject", "snippet", "receivedAt", "label" ] } }, "steps": { "type": "array", "items": { "type": "object", "properties": { "nodeId": { "type": "string", "minLength": 1, "maxLength": 128 }, "label": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "matched", "not_matched", "preview", "blocked" ] }, "detail": { "$ref": "#/$defs/Description" }, "branch": { "type": "string", "enum": [ "yes", "no" ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "value": { "$ref": "#/$defs/Description" }, "unavailable": { "$ref": "#/$defs/ShortText" } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|value|unavailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "value", "unavailable" ] } }, "maxItems": 100 } }, "required": [ "nodeId", "label", "status", "detail" ], "patternProperties": { "^(?!(?:nodeId|label|status|detail|branch|fields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "nodeId", "label", "status", "detail", "branch", "fields" ] } }, "maxItems": 200 } }, "required": [ "reply", "steps" ], "patternProperties": { "^(?!(?:reply|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reply", "steps" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "deleting" ] }, "publishedVersionId": { "anyOf": [ { "$ref": "#/$defs/WorkflowVersionId" }, { "type": "null" } ] }, "triggerType": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, { "type": "null" } ] }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|status|publishedVersionId|triggerType|alertCount|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "status": { "type": "string", "enum": [ "draft", "active", "paused", "deleting" ] }, "publishedVersionId": { "anyOf": [ { "$ref": "#/$defs/WorkflowVersionId" }, { "type": "null" } ] }, "triggerType": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, { "type": "null" } ] }, "alertCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "version": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowVersionId" }, "workflowId": { "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" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "graph": { "type": "object", "properties": { "schemaVersion": { "anyOf": [ { "type": "number", "enum": [ 1 ] } ] }, "nodes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": [ "x", "y" ], "patternProperties": { "^(?!(?:x|y)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y" ] } }, "data": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } }, "required": [ "id", "type", "position", "data" ], "patternProperties": { "^(?!(?:id|type|position|data)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "type", "position", "data" ] } }, "maxItems": 200 }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 128 }, "source": { "type": "string", "minLength": 1, "maxLength": 128 }, "target": { "type": "string", "minLength": 1, "maxLength": 128 }, "sourceHandle": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] } }, "required": [ "id", "source", "target" ], "patternProperties": { "^(?!(?:id|source|target|sourceHandle)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "source", "target", "sourceHandle" ] } }, "maxItems": 400 } }, "required": [ "schemaVersion", "nodes", "edges" ], "patternProperties": { "^(?!(?:schemaVersion|nodes|edges)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schemaVersion", "nodes", "edges" ] } }, "publishedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workflowId|version|graph|publishedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "version", "graph", "publishedAt", "createdAt", "updatedAt" ] } }, { "type": "null" } ] } }, "required": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt", "version" ], "patternProperties": { "^(?!(?:id|name|status|publishedVersionId|triggerType|alertCount|createdAt|updatedAt|version)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "status", "publishedVersionId", "triggerType", "alertCount", "createdAt", "updatedAt", "version" ] } }, { "type": "object", "properties": { "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" }, "workflowId": { "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" }, "workflowVersionId": { "$ref": "#/$defs/WorkflowVersionId" }, "status": { "type": "string", "enum": [ "queued", "running", "paused", "completed", "failed" ] }, "error": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "leadId": { "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" } ] }, "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" } ] }, "threadId": { "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" } ] }, "triggerEvent": { "$ref": "#/$defs/ShortText" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "startedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "executions": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowNodeExecutionId" }, "nodeId": { "type": "string", "minLength": 1, "maxLength": 128 }, "nodeType": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:trigger|logic|action)\\.[a-z0-9_]+$" }, "status": { "type": "string", "enum": [ "running", "paused", "completed", "failed", "skipped" ] }, "error": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "branch": { "anyOf": [ { "type": "string", "enum": [ "yes", "no" ] }, { "type": "null" } ] }, "outputsRedacted": { "type": "boolean" }, "externalRunId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "externalRestartRequiresAcknowledgement": { "type": "boolean" }, "externalResult": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "workflowResult": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "healthResult": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "domainRotation": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "getleadsResult": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "agentText": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131072 }, { "type": "null" } ] }, "childRunId": { "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" } ] }, "childWorkflowId": { "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" } ] }, "humanRequestTaskId": { "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" } ] }, "startedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "nodeId", "nodeType", "status", "error", "branch", "outputsRedacted", "externalRunId", "externalRestartRequiresAcknowledgement", "externalResult", "workflowResult", "healthResult", "domainRotation", "getleadsResult", "agentText", "childRunId", "childWorkflowId", "humanRequestTaskId", "startedAt", "completedAt" ], "patternProperties": { "^(?!(?:id|nodeId|nodeType|status|error|branch|outputsRedacted|externalRunId|externalRestartRequiresAcknowledgement|externalResult|workflowResult|healthResult|domainRotation|getleadsResult|agentText|childRunId|childWorkflowId|humanRequestTaskId|startedAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "nodeId", "nodeType", "status", "error", "branch", "outputsRedacted", "externalRunId", "externalRestartRequiresAcknowledgement", "externalResult", "workflowResult", "healthResult", "domainRotation", "getleadsResult", "agentText", "childRunId", "childWorkflowId", "humanRequestTaskId", "startedAt", "completedAt" ] } }, "maxItems": 200 }, "followUp": { "anyOf": [ { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowFollowUpId" }, "runId": { "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" }, "threadId": { "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "counterpartyEmail": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "active", "awaiting_approval", "completed", "stopped" ] }, "stopReason": { "anyOf": [ { "type": "string", "enum": [ "replied", "booked", "human_took_over", "negative_label", "unsubscribed", "thread_gone", "stopped_by_user", "agent_unauthorized", "exhausted" ] }, { "type": "null" } ] }, "maxAttempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "attemptsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAttemptAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "lastOutboundAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "drafts": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowFollowUpDraftId" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "status": { "type": "string", "enum": [ "pending", "approved", "edited", "rejected", "sent", "expired" ] }, "bodyText": { "type": "string", "minLength": 1, "maxLength": 4000 }, "modelReason": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "toolTrace": { "anyOf": [ { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "null" } ] }, "sentMessageId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "attempt", "status", "bodyText", "modelReason", "toolTrace", "sentMessageId", "createdAt" ], "patternProperties": { "^(?!(?:id|attempt|status|bodyText|modelReason|toolTrace|sentMessageId|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "attempt", "status", "bodyText", "modelReason", "toolTrace", "sentMessageId", "createdAt" ] } }, "maxItems": 100 } }, "required": [ "id", "runId", "threadId", "inboxId", "counterpartyEmail", "status", "stopReason", "maxAttempts", "attemptsSent", "nextAttemptAt", "lastOutboundAt", "completedAt", "drafts" ], "patternProperties": { "^(?!(?:id|runId|threadId|inboxId|counterpartyEmail|status|stopReason|maxAttempts|attemptsSent|nextAttemptAt|lastOutboundAt|completedAt|drafts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "runId", "threadId", "inboxId", "counterpartyEmail", "status", "stopReason", "maxAttempts", "attemptsSent", "nextAttemptAt", "lastOutboundAt", "completedAt", "drafts" ] } }, { "type": "null" } ] } }, "required": [ "id", "workflowId", "workflowVersionId", "status", "error", "leadId", "inboxId", "threadId", "triggerEvent", "createdAt", "startedAt", "completedAt", "executions", "followUp" ], "patternProperties": { "^(?!(?:id|workflowId|workflowVersionId|status|error|leadId|inboxId|threadId|triggerEvent|createdAt|startedAt|completedAt|executions|followUp)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "workflowVersionId", "status", "error", "leadId", "inboxId", "threadId", "triggerEvent", "createdAt", "startedAt", "completedAt", "executions", "followUp" ] } }, "maxItems": 50 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowTriggerLogId" }, "workflowId": { "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" }, "workflowVersionId": { "$ref": "#/$defs/WorkflowVersionId" }, "provider": { "$ref": "#/$defs/ShortText" }, "webhookId": { "$ref": "#/$defs/OpaqueId" }, "outcome": { "type": "string", "enum": [ "received", "accepted", "rejected", "sample", "ignored", "duplicate", "error" ] }, "reason": { "type": "string", "enum": [ "processing", "admitted", "invalid_signature", "invalid_payload", "workspace_mismatch", "webhook_mismatch", "event_not_selected", "campaign_not_selected", "provider_sample", "duplicate", "webhook_inactive", "effects_disabled", "workflow_inactive", "conditions_not_met", "lead_not_found", "processing_failed", "payload_too_large", "missing_payload", "body_read_failed" ] }, "httpStatus": { "anyOf": [ { "type": "integer", "minimum": 100, "maximum": 599 }, { "type": "null" } ] }, "runId": { "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" } ] }, "requestFields": { "type": "object", "additionalProperties": { "$ref": "#/$defs/ShortText" } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "workflowId", "workflowVersionId", "provider", "webhookId", "outcome", "reason", "httpStatus", "runId", "requestFields", "createdAt", "completedAt" ], "patternProperties": { "^(?!(?:id|workflowId|workflowVersionId|provider|webhookId|outcome|reason|httpStatus|runId|requestFields|createdAt|completedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "workflowVersionId", "provider", "webhookId", "outcome", "reason", "httpStatus", "runId", "requestFields", "createdAt", "completedAt" ] } } }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] } }, "required": [ "items", "nextCursor" ], "patternProperties": { "^(?!(?:items|nextCursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "nextCursor" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/WorkflowAlertId" }, "workflowId": { "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" }, "workflowRunId": { "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" } ] }, "nodeId": { "type": "string", "minLength": 1, "maxLength": 128 }, "code": { "$ref": "#/$defs/ShortText" }, "message": { "$ref": "#/$defs/Description" }, "relatedWorkflowId": { "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" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workflowId", "workflowRunId", "nodeId", "code", "message", "relatedWorkflowId", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workflowId|workflowRunId|nodeId|code|message|relatedWorkflowId|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workflowId", "workflowRunId", "nodeId", "code", "message", "relatedWorkflowId", "createdAt", "updatedAt" ] } }, "maxItems": 200 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "automation": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "follow_up" ] } ] }, "id": { "$ref": "#/$defs/WorkflowFollowUpId" }, "runId": { "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" }, "workflowId": { "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" }, "workflowName": { "type": "string", "minLength": 1, "maxLength": 120 }, "runStatus": { "type": "string", "enum": [ "queued", "running", "paused", "completed", "failed" ] }, "status": { "type": "string", "enum": [ "active", "awaiting_approval", "completed", "stopped" ] }, "attemptsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxAttempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nextAttemptAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "stopReason": { "anyOf": [ { "type": "string", "enum": [ "replied", "booked", "human_took_over", "negative_label", "unsubscribed", "thread_gone", "stopped_by_user", "agent_unauthorized", "exhausted" ] }, { "type": "null" } ] }, "pendingDraftId": { "anyOf": [ { "$ref": "#/$defs/WorkflowFollowUpDraftId" }, { "type": "null" } ] } }, "required": [ "kind", "id", "runId", "workflowId", "workflowName", "runStatus", "status", "attemptsSent", "maxAttempts", "nextAttemptAt", "stopReason", "pendingDraftId" ], "patternProperties": { "^(?!(?:kind|id|runId|workflowId|workflowName|runStatus|status|attemptsSent|maxAttempts|nextAttemptAt|stopReason|pendingDraftId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "id", "runId", "workflowId", "workflowName", "runStatus", "status", "attemptsSent", "maxAttempts", "nextAttemptAt", "stopReason", "pendingDraftId" ] } }, { "type": "object", "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "sequence" ] } ] }, "enrollmentId": { "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" }, "sequenceId": { "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" }, "sequenceName": { "$ref": "#/$defs/ShortText" }, "childContactId": { "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" } ] }, "contactStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "currentStep": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalSteps": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "kind", "enrollmentId", "sequenceId", "sequenceName", "childContactId", "contactStatus", "currentStep", "totalSteps" ], "patternProperties": { "^(?!(?:kind|enrollmentId|sequenceId|sequenceName|childContactId|contactStatus|currentStep|totalSteps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "enrollmentId", "sequenceId", "sequenceName", "childContactId", "contactStatus", "currentStep", "totalSteps" ] } } ] }, { "type": "null" } ] } }, "required": [ "automation" ], "patternProperties": { "^(?!(?:automation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "automation" ] } ] } }, { "type": "object", "properties": { "authorized": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/CallListId" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, "maxItems": 500 } }, "required": [ "authorized", "items" ], "patternProperties": { "^(?!(?:authorized|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authorized", "items" ] } }, { "type": "object", "properties": { "authorized": { "type": "boolean" }, "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, "maxItems": 500 } }, "required": [ "authorized", "items" ], "patternProperties": { "^(?!(?:authorized|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authorized", "items" ] } }, { "type": "object", "properties": { "authorized": { "type": "boolean" }, "inboxes": { "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", "other" ] }, "status": { "type": "string", "enum": [ "active", "inactive", "error", "alert" ] } }, "required": [ "id", "emailAddress", "provider", "status" ], "patternProperties": { "^(?!(?:id|emailAddress|provider|status)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "provider", "status" ] } }, "maxItems": 2000 }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } }, "maxItems": 500 } }, "required": [ "authorized", "inboxes", "tags" ], "patternProperties": { "^(?!(?:authorized|inboxes|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authorized", "inboxes", "tags" ] } }, { "type": "object", "properties": { "authorized": { "type": "boolean" }, "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" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "versionId": { "$ref": "#/$defs/WorkflowVersionId" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "type": { "type": "string", "enum": [ "string", "domain", "number", "boolean", "object", "array" ] }, "required": { "type": "boolean" }, "description": { "type": "string", "minLength": 1, "maxLength": 300 } }, "required": [ "name", "type", "required" ], "patternProperties": { "^(?!(?:name|type|required|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "required", "description" ] } }, "maxItems": 50 }, "outputs": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "type": { "type": "string", "enum": [ "string", "domain", "number", "boolean", "object", "array" ] }, "required": { "type": "boolean" }, "description": { "type": "string", "minLength": 1, "maxLength": 300 } }, "required": [ "name", "type", "required" ], "patternProperties": { "^(?!(?:name|type|required|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "required", "description" ] } }, "maxItems": 50 } }, "required": [ "id", "name", "versionId", "inputs", "outputs" ], "patternProperties": { "^(?!(?:id|name|versionId|inputs|outputs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "versionId", "inputs", "outputs" ] } }, "maxItems": 500 } }, "required": [ "authorized", "items" ], "patternProperties": { "^(?!(?:authorized|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "authorized", "items" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "messageId": { "$ref": "#/$defs/OpaqueId" }, "threadId": { "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" }, "from": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "label": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "messageId", "threadId", "from", "subject", "snippet", "receivedAt", "label" ], "patternProperties": { "^(?!(?:messageId|threadId|from|subject|snippet|receivedAt|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "threadId", "from", "subject", "snippet", "receivedAt", "label" ] } }, "maxItems": 50 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "reply": { "type": "object", "properties": { "messageId": { "$ref": "#/$defs/OpaqueId" }, "threadId": { "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" }, "from": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "label": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] } }, "required": [ "messageId", "threadId", "from", "subject", "snippet", "receivedAt", "label" ], "patternProperties": { "^(?!(?:messageId|threadId|from|subject|snippet|receivedAt|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "messageId", "threadId", "from", "subject", "snippet", "receivedAt", "label" ] } }, "steps": { "type": "array", "items": { "type": "object", "properties": { "nodeId": { "type": "string", "minLength": 1, "maxLength": 128 }, "label": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "matched", "not_matched", "preview", "blocked" ] }, "detail": { "$ref": "#/$defs/Description" }, "branch": { "type": "string", "enum": [ "yes", "no" ] }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "value": { "$ref": "#/$defs/Description" }, "unavailable": { "$ref": "#/$defs/ShortText" } }, "required": [ "name" ], "patternProperties": { "^(?!(?:name|value|unavailable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "value", "unavailable" ] } }, "maxItems": 100 } }, "required": [ "nodeId", "label", "status", "detail" ], "patternProperties": { "^(?!(?:nodeId|label|status|detail|branch|fields)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "nodeId", "label", "status", "detail", "branch", "fields" ] } }, "maxItems": 200 } }, "required": [ "reply", "steps" ], "patternProperties": { "^(?!(?:reply|steps)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "reply", "steps" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `workflows.list`: `GET /v1/workspaces/:workspaceId/workflows` - `workflows.get`: `GET /v1/workspaces/:workspaceId/workflows/:workflowId` - `workflows.runs`: `GET /v1/workspaces/:workspaceId/workflows/:workflowId/runs` - `workflows.triggerLogs`: `GET /v1/workspaces/:workspaceId/workflows/:workflowId/trigger-logs` - `workflows.alerts`: `GET /v1/workspaces/:workspaceId/workflows/:workflowId/alerts` - `workflows.threadAutomation`: `GET /v1/workspaces/:workspaceId/workflows/threads/:threadId` - `workflows.simulate`: `POST /v1/workspaces/:workspaceId/workflows/:workflowId/simulate` - `workflows.testReplies`: `GET /v1/workspaces/:workspaceId/workflows/test-replies` - `workflowOptions.callLists`: `GET /v1/workspaces/:workspaceId/workflows/options/call-lists` - `workflowOptions.sequences`: `GET /v1/workspaces/:workspaceId/workflows/options/sequences` - `workflowOptions.inboxScopes`: `GET /v1/workspaces/:workspaceId/workflows/options/inbox-scopes` - `workflowOptions.enrollmentTargets`: `GET /v1/workspaces/:workspaceId/workflows/options/enrollment-targets` ## read_workspace_settings Read a workspace's organization settings or AI-label settings, returning documented defaults when no row exists yet. Use before mutating settings to see the effective configuration a workspace currently runs with. Does not expose credentials, blocked addresses, or catalog rows; use the dedicated catalog tools for those. Scopes: workspace:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "scope": { "type": "string", "enum": [ "workspace_settings", "ai_labels" ] } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope" ] } } ``` ### 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" }, "scope": { "type": "string", "enum": [ "workspace_settings", "ai_labels" ] } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|scope)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "scope" ] } } ``` ### 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$" }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "E164PhoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } }, "type": "object", "anyOf": [ { "allOf": [ { "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" }, "contactSuggestionsAutoConfirm": { "type": "boolean" }, "contactSuggestionsAutoConfirmSince": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "replyDetectionAiPrompt": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "googleEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "microsoftEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "otherEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "timezone": { "$ref": "#/$defs/IanaTimeZone" }, "dailySendingLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "textMessageSenderNumber": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "autoReminderEnabled": { "type": "boolean" }, "autoReminderDays": { "type": "integer", "minimum": 1, "maximum": 365 }, "autoReminderBusinessDaysOnly": { "type": "boolean" }, "verificationSharingMode": { "type": "string", "enum": [ "contribute_and_consume", "consume_only", "private" ] }, "createdAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "workspaceId", "contactSuggestionsAutoConfirm", "contactSuggestionsAutoConfirmSince", "replyDetectionAiPrompt", "googleEspMatch", "microsoftEspMatch", "otherEspMatch", "timezone", "dailySendingLimit", "textMessageSenderNumber", "dailyCapPerRecipientDomain", "autoReminderEnabled", "autoReminderDays", "autoReminderBusinessDaysOnly", "verificationSharingMode", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:workspaceId|contactSuggestionsAutoConfirm|contactSuggestionsAutoConfirmSince|replyDetectionAiPrompt|googleEspMatch|microsoftEspMatch|otherEspMatch|timezone|dailySendingLimit|textMessageSenderNumber|dailyCapPerRecipientDomain|autoReminderEnabled|autoReminderDays|autoReminderBusinessDaysOnly|verificationSharingMode|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "contactSuggestionsAutoConfirm", "contactSuggestionsAutoConfirmSince", "replyDetectionAiPrompt", "googleEspMatch", "microsoftEspMatch", "otherEspMatch", "timezone", "dailySendingLimit", "textMessageSenderNumber", "dailyCapPerRecipientDomain", "autoReminderEnabled", "autoReminderDays", "autoReminderBusinessDaysOnly", "verificationSharingMode", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "aiLabelDetection": { "type": "boolean" }, "labelCategorizationPrompt": { "type": "string", "maxLength": 2000 }, "emailNotificationForPositiveReplies": { "type": "boolean" }, "emailNotificationForAiFollowUpApprovals": { "type": "boolean" }, "notificationEmails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 100 } }, "required": [ "aiLabelDetection", "labelCategorizationPrompt", "emailNotificationForPositiveReplies", "emailNotificationForAiFollowUpApprovals", "notificationEmails" ], "patternProperties": { "^(?!(?:aiLabelDetection|labelCategorizationPrompt|emailNotificationForPositiveReplies|emailNotificationForAiFollowUpApprovals|notificationEmails)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "aiLabelDetection", "labelCategorizationPrompt", "emailNotificationForPositiveReplies", "emailNotificationForAiFollowUpApprovals", "notificationEmails" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "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" }, "contactSuggestionsAutoConfirm": { "type": "boolean" }, "contactSuggestionsAutoConfirmSince": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "replyDetectionAiPrompt": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "googleEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "microsoftEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "otherEspMatch": { "type": "string", "enum": [ "google", "microsoft", "other", "all", "tags", "skip" ] }, "timezone": { "$ref": "#/$defs/IanaTimeZone" }, "dailySendingLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "textMessageSenderNumber": { "anyOf": [ { "$ref": "#/$defs/E164PhoneNumber" }, { "type": "null" } ] }, "dailyCapPerRecipientDomain": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "null" } ] }, "autoReminderEnabled": { "type": "boolean" }, "autoReminderDays": { "type": "integer", "minimum": 1, "maximum": 365 }, "autoReminderBusinessDaysOnly": { "type": "boolean" }, "verificationSharingMode": { "type": "string", "enum": [ "contribute_and_consume", "consume_only", "private" ] }, "createdAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "workspaceId", "contactSuggestionsAutoConfirm", "contactSuggestionsAutoConfirmSince", "replyDetectionAiPrompt", "googleEspMatch", "microsoftEspMatch", "otherEspMatch", "timezone", "dailySendingLimit", "textMessageSenderNumber", "dailyCapPerRecipientDomain", "autoReminderEnabled", "autoReminderDays", "autoReminderBusinessDaysOnly", "verificationSharingMode", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:workspaceId|contactSuggestionsAutoConfirm|contactSuggestionsAutoConfirmSince|replyDetectionAiPrompt|googleEspMatch|microsoftEspMatch|otherEspMatch|timezone|dailySendingLimit|textMessageSenderNumber|dailyCapPerRecipientDomain|autoReminderEnabled|autoReminderDays|autoReminderBusinessDaysOnly|verificationSharingMode|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "contactSuggestionsAutoConfirm", "contactSuggestionsAutoConfirmSince", "replyDetectionAiPrompt", "googleEspMatch", "microsoftEspMatch", "otherEspMatch", "timezone", "dailySendingLimit", "textMessageSenderNumber", "dailyCapPerRecipientDomain", "autoReminderEnabled", "autoReminderDays", "autoReminderBusinessDaysOnly", "verificationSharingMode", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "aiLabelDetection": { "type": "boolean" }, "labelCategorizationPrompt": { "type": "string", "maxLength": 2000 }, "emailNotificationForPositiveReplies": { "type": "boolean" }, "emailNotificationForAiFollowUpApprovals": { "type": "boolean" }, "notificationEmails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 100 } }, "required": [ "aiLabelDetection", "labelCategorizationPrompt", "emailNotificationForPositiveReplies", "emailNotificationForAiFollowUpApprovals", "notificationEmails" ], "patternProperties": { "^(?!(?:aiLabelDetection|labelCategorizationPrompt|emailNotificationForPositiveReplies|emailNotificationForAiFollowUpApprovals|notificationEmails)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "aiLabelDetection", "labelCategorizationPrompt", "emailNotificationForPositiveReplies", "emailNotificationForAiFollowUpApprovals", "notificationEmails" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `workspaceSettings.get`: `GET /v1/workspaces/:workspaceId/settings` - `aiLabels.get`: `GET /v1/workspaces/:workspaceId/settings/ai-labels` ## read_workspace_usage Read a workspace's billing-period-aligned usage counters and subscription limits. Use to report how much of each quota the current workspace has consumed. Read-only; it never mutates counters or manages the subscription itself. Scopes: usage:read Risk: read; confirmation: none; idempotency: none. ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "usage": { "type": "object", "properties": { "emailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectedInboxes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "activeCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalContacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "emailsSent", "connectedInboxes", "activeCampaigns", "totalContacts" ], "patternProperties": { "^(?!(?:emailsSent|connectedInboxes|activeCampaigns|totalContacts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailsSent", "connectedInboxes", "activeCampaigns", "totalContacts" ] } }, "workspaceUsage": { "type": "object", "properties": { "emailsSent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "connectedInboxes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "activeCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalContacts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "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" } }, "required": [ "emailsSent", "connectedInboxes", "activeCampaigns", "totalContacts", "workspaceId" ], "patternProperties": { "^(?!(?:emailsSent|connectedInboxes|activeCampaigns|totalContacts|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailsSent", "connectedInboxes", "activeCampaigns", "totalContacts", "workspaceId" ] } }, "limits": { "type": "object", "properties": { "maxEmailsPerMonth": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxInboxes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxContactsPerCampaign": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "maxEmailsPerMonth", "maxInboxes", "maxCampaigns", "maxContactsPerCampaign" ], "patternProperties": { "^(?!(?:maxEmailsPerMonth|maxInboxes|maxCampaigns|maxContactsPerCampaign)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "maxEmailsPerMonth", "maxInboxes", "maxCampaigns", "maxContactsPerCampaign" ] } }, "period": { "type": "object", "properties": { "start": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "end": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "subscription": { "anyOf": [ { "type": "object", "properties": { "plan": { "$ref": "#/$defs/ShortText" }, "status": { "$ref": "#/$defs/ShortText" }, "billingCycle": { "$ref": "#/$defs/ShortText" }, "periodEnd": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "trialEnd": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "plan", "status", "billingCycle", "periodEnd", "trialEnd" ], "patternProperties": { "^(?!(?:plan|status|billingCycle|periodEnd|trialEnd)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "plan", "status", "billingCycle", "periodEnd", "trialEnd" ] } }, { "type": "null" } ] } }, "required": [ "usage", "workspaceUsage", "limits", "period", "subscription" ], "patternProperties": { "^(?!(?:usage|workspaceUsage|limits|period|subscription)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "usage", "workspaceUsage", "limits", "period", "subscription" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `workspaces.usage`: `GET /v1/workspaces/:workspaceId/usage` ## reattach_integration_share Re-attach a shared connection this workspace previously detached. Use when a detached workspace should use the shared connection again. Paused workflows stay paused until resumed. Fails when the share was revoked or this workspace now has its own connection of the provider. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:create Risk: write; confirmation: explicit; 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" }, "shareId": { "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", "shareId" ], "patternProperties": { "^(?!(?:workspaceId|shareId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "shareId" ] } } ``` ### 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" }, "shareId": { "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", "shareId" ], "patternProperties": { "^(?!(?:workspaceId|shareId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "shareId" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "adapter": { "$ref": "#/$defs/IntegrationShareAdapter" }, "provider": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,63}$" }, "displayName": { "$ref": "#/$defs/ShortText" }, "role": { "type": "string", "enum": [ "source", "target" ] }, "sourceWorkspaceId": { "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" }, "sourceWorkspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "sourceConnectionId": { "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" }, "sourceConnected": { "type": "boolean" }, "includeFutureWorkspaces": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "attaching", "attached", "detached", "failed" ] }, "connectionId": { "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" } ] }, "failureReason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "attachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "detachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|state|connectionId|failureReason|attachedAt|detachedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ] } }, "maxItems": 500 } }, "required": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ], "patternProperties": { "^(?!(?:id|adapter|provider|displayName|role|sourceWorkspaceId|sourceWorkspaceName|sourceConnectionId|sourceConnected|includeFutureWorkspaces|createdAt|revokedAt|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ] }, "$defs": { "IntegrationShareAdapter": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer", "heyreach", "getleads", "plusvibe", "calendly", "cal_com", "attio", "email_verifier", "phone_verifier", "warmup_provider", "mcp_server", "app_connection" ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `integrationShares.reattach`: `POST /v1/workspaces/:workspaceId/integration-shares/:shareId/reattach` ## reconcile_plusvibe Repair every PlusVibe workflow webhook in the workspace in the background. Use when get_plusvibe_status shows a hook in error or pending; poll the returned operation for per-hook outcomes. Reconciling does not reconnect a disconnected key; it only repairs or removes remote hooks. Scopes: integration:update 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### 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" } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "hookCount": { "type": "integer", "minimum": 0 }, "operation": { "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" ] } } }, "required": [ "hookCount", "operation" ], "patternProperties": { "^(?!(?:hookCount|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "hookCount", "operation" ] }, "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Underlying API operations - `plusvibe.reconcile`: `POST /v1/workspaces/:workspaceId/integrations/plusvibe/reconcile` ## reconnect_google_inbox Mints a reconnect consent URL pinned to one existing Google inbox. When asked to re-authorize a specific Google inbox. For a first-time connect — use connect_google_inbox. Return the authorization or checkout handoff to the person. The agent may initiate and inspect status, but must not complete the human approval. Scopes: inbox:connect, inbox:read Risk: write; confirmation: human_completion; 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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxId" ] } } ``` ### 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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxId" ] } } ``` ### Output schema (structuredContent) ```json { "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" ] }, "$defs": { "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 } } } ``` ### Underlying API operations - `inboxConnections.startGoogleReconnect`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/google-reconnect` - `inboxes.list`: `GET /v1/workspaces/:workspaceId/inboxes` ## report_onboarding Read or advance a workspace's onboarding and getting-started activation state. Use to read activation progress or merge a single onboarding step's answers. Step saves merge per-step; they are not a full-state overwrite. Scopes: workspace:read, workspace:update Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "getState" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "gettingStarted" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "saveStep" ] } ] }, "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" }, "step": { "type": "string", "enum": [ "website", "company", "tools", "heardFrom", "role", "mailboxes" ] }, "answers": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "syncFavicon": { "type": "boolean" } }, "required": [ "action", "workspaceId", "step", "answers" ], "patternProperties": { "^(?!(?:action|workspaceId|step|answers|syncFavicon)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "step", "answers", "syncFavicon" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "skip" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "complete" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } } ], "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "ReportOnboardingInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "getState" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "gettingStarted" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "saveStep" ] } ] }, "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" }, "step": { "type": "string", "enum": [ "website", "company", "tools", "heardFrom", "role", "mailboxes" ] }, "answers": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "syncFavicon": { "type": "boolean" } }, "required": [ "action", "workspaceId", "step", "answers" ], "patternProperties": { "^(?!(?:action|workspaceId|step|answers|syncFavicon)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "step", "answers", "syncFavicon" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "skip" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "complete" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } } ] } } } ``` ### 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": { "anyOf": [ { "type": "string", "enum": [ "getState" ] } ] } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "gettingStarted" ] } ] } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "saveStep" ] } ] }, "step": { "type": "string", "enum": [ "website", "company", "tools", "heardFrom", "role", "mailboxes" ] }, "answers": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "syncFavicon": { "type": "boolean" } }, "required": [ "action", "workspaceId", "step", "answers" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|step|answers|syncFavicon)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "step", "answers", "syncFavicon" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "skip" ] } ] } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId" ] }, { "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": { "anyOf": [ { "type": "string", "enum": [ "complete" ] } ] } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "ReportOnboardingInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "getState" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "gettingStarted" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "saveStep" ] } ] }, "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" }, "step": { "type": "string", "enum": [ "website", "company", "tools", "heardFrom", "role", "mailboxes" ] }, "answers": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "syncFavicon": { "type": "boolean" } }, "required": [ "action", "workspaceId", "step", "answers" ], "patternProperties": { "^(?!(?:action|workspaceId|step|answers|syncFavicon)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "step", "answers", "syncFavicon" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "skip" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "complete" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ReportOnboardingOutput": { "anyOf": [ { "type": "object", "properties": { "connectInbox": { "type": "boolean" }, "importLeads": { "type": "boolean" }, "createCampaign": { "type": "boolean" }, "launchCampaign": { "type": "boolean" }, "verifyLeads": { "type": "boolean" }, "inviteTeam": { "type": "boolean" } }, "required": [ "connectInbox", "importLeads", "createCampaign", "launchCampaign", "verifyLeads", "inviteTeam" ], "patternProperties": { "^(?!(?:connectInbox|importLeads|createCampaign|launchCampaign|verifyLeads|inviteTeam)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connectInbox", "importLeads", "createCampaign", "launchCampaign", "verifyLeads", "inviteTeam" ] } }, { "type": "object", "properties": { "organizationId": { "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" }, "companySize": { "anyOf": [ { "type": "string", "enum": [ "solo", "2_5", "6_10", "11_25", "26_50", "51_200", "200_plus" ] }, { "type": "null" } ] }, "answers": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "completedSteps": { "type": "array", "items": { "type": "string", "enum": [ "website", "company", "tools", "heardFrom", "role", "mailboxes" ] } }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "skippedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "organizationId", "companySize", "answers", "completedSteps", "completedAt", "skippedAt", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:organizationId|companySize|answers|completedSteps|completedAt|skippedAt|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "companySize", "answers", "completedSteps", "completedAt", "skippedAt", "createdAt", "updatedAt" ] } } ] } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/ReportOnboardingOutput" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/ReportOnboardingOutput" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `workspaces.gettingStarted`: `GET /v1/workspaces/:workspaceId/getting-started` - `workspaces.onboarding.get`: `GET /v1/workspaces/:workspaceId/onboarding` - `workspaces.onboarding.saveStep`: `POST /v1/workspaces/:workspaceId/onboarding/steps` - `workspaces.onboarding.skip`: `POST /v1/workspaces/:workspaceId/onboarding/skip` - `workspaces.onboarding.complete`: `POST /v1/workspaces/:workspaceId/onboarding/complete` ## request_gmail_connect_links Mints a capacity-clamped batch of Google connect links to hand to workspace members. When asked for shareable Gmail connect links for team members. For a single self-serve connect — use connect_google_inbox. Scopes: inbox:connect 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": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 1, "maximum": 15 } }, "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } } }, "required": [ "workspaceId", "request" ], "patternProperties": { "^(?!(?:workspaceId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "request" ] } } ``` ### 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": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 1, "maximum": 15 } }, "patternProperties": { "^(?!(?:count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "count" ] } ] } } }, "required": [ "workspaceId", "request" ], "patternProperties": { "^(?!(?:workspaceId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "request" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "links": { "type": "array", "items": { "type": "object", "properties": { "url": { "$ref": "#/$defs/HttpUrl" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "url", "expiresAt" ], "patternProperties": { "^(?!(?:url|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "url", "expiresAt" ] } }, "maxItems": 15 }, "googleClientId": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "requested": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "issued": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remaining": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "planLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "instructions": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "links", "googleClientId", "requested", "issued", "remaining", "planLimit", "instructions" ], "patternProperties": { "^(?!(?:links|googleClientId|requested|issued|remaining|planLimit|instructions)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "links", "googleClientId", "requested", "issued", "remaining", "planLimit", "instructions" ] }, "$defs": { "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 } } } ``` ### Underlying API operations - `inboxConnections.createGoogleConnectLinks`: `POST /v1/workspaces/:workspaceId/inbox-connections/google/connect-links` ## request_integration Ask the Scheduler Zero team to support a CRM, email-verification, or phone-verification provider. Use when the workspace needs a provider the catalog does not offer. `delivered: false` still means the request was recorded. Never include credentials or customer data in the request; it is forwarded to an issue tracker. Scopes: support:create 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": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "crm_integration", "verification_provider", "phone_verification_provider" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "website": { "anyOf": [ { "type": "string", "minLength": 0, "maxLength": 300 }, { "type": "null" } ] }, "useCase": { "anyOf": [ { "type": "string", "minLength": 0, "maxLength": 2000 }, { "type": "null" } ] }, "importance": { "type": "string", "enum": [ "nice_to_have", "important", "blocking" ] } }, "required": [ "category", "name" ], "patternProperties": { "^(?!(?:category|name|website|useCase|importance)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "category", "name", "website", "useCase", "importance" ] } } }, "required": [ "workspaceId", "request" ], "patternProperties": { "^(?!(?:workspaceId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "request" ] } } ``` ### 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": { "type": "object", "properties": { "category": { "type": "string", "enum": [ "crm_integration", "verification_provider", "phone_verification_provider" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "website": { "anyOf": [ { "type": "string", "minLength": 0, "maxLength": 300 }, { "type": "null" } ] }, "useCase": { "anyOf": [ { "type": "string", "minLength": 0, "maxLength": 2000 }, { "type": "null" } ] }, "importance": { "type": "string", "enum": [ "nice_to_have", "important", "blocking" ] } }, "required": [ "category", "name" ], "patternProperties": { "^(?!(?:category|name|website|useCase|importance)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "category", "name", "website", "useCase", "importance" ] } } }, "required": [ "workspaceId", "request" ], "patternProperties": { "^(?!(?:workspaceId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "request" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "delivered": { "type": "boolean" } }, "required": [ "ok", "delivered" ], "patternProperties": { "^(?!(?:ok|delivered)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "ok", "delivered" ] } } ``` ### Underlying API operations - `integrationRequests.create`: `POST /v1/workspaces/:workspaceId/integration-requests` ## request_permissions Ask the workspace's admins to grant the person additional workspace permissions. Admins are emailed and can approve with one click. Use after a tool call fails with a permission error that names requiredPermission, or when the person asks for access. First ask the person whether they want you to file the request; then pass the missing permissions, their reason if they gave one, and context describing what you were trying to do (attemptedTool, attemptedOperation, explanation). Never file without the person's agreement. Do not use for an AgentScopeDenied error (the person must reconnect the agent with broader consent instead) or with an API key (edit the key's scopes). Fails when the workspace's admins turned requests off. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspace:read Risk: write; confirmation: explicit; 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" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "minItems": 1, "maxItems": 100 }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "context": { "$ref": "#/$defs/PermissionRequestContext" } }, "required": [ "workspaceId", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|permissions|reason|context)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "permissions", "reason", "context" ] }, "$defs": { "PermissionRequestContext": { "type": "object", "properties": { "attemptedOperation": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "attemptedTool": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "explanation": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:attemptedOperation|attemptedTool|explanation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attemptedOperation", "attemptedTool", "explanation" ] } } } } ``` ### 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" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] }, "minItems": 1, "maxItems": 100 }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "context": { "$ref": "#/$defs/PermissionRequestContext" } }, "required": [ "workspaceId", "permissions" ], "patternProperties": { "^(?!(?:workspaceId|permissions|reason|context)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "permissions", "reason", "context" ] }, "$defs": { "PermissionRequestContext": { "type": "object", "properties": { "attemptedOperation": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "attemptedTool": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "explanation": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:attemptedOperation|attemptedTool|explanation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attemptedOperation", "attemptedTool", "explanation" ] } } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "PermissionRequestId": { "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" }, "PermissionRequestStatus": { "type": "string", "enum": [ "pending", "approved", "denied", "canceled", "expired" ] }, "PermissionRequestPerson": { "type": "object", "properties": { "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "userId", "name", "email" ], "patternProperties": { "^(?!(?:userId|name|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email" ] } }, "PermissionRequestContext": { "type": "object", "properties": { "attemptedOperation": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "attemptedTool": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "explanation": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:attemptedOperation|attemptedTool|explanation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "attemptedOperation", "attemptedTool", "explanation" ] } }, "PermissionRequestSource": { "type": "string", "enum": [ "web", "api", "agent" ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "PermissionRequest": { "type": "object", "properties": { "id": { "$ref": "#/$defs/PermissionRequestId" }, "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" }, "status": { "$ref": "#/$defs/PermissionRequestStatus" }, "requester": { "$ref": "#/$defs/PermissionRequestPerson" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "grantedPermissions": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "context": { "$ref": "#/$defs/PermissionRequestContext" }, "source": { "$ref": "#/$defs/PermissionRequestSource" }, "agentName": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "decidedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "decidedBy": { "anyOf": [ { "$ref": "#/$defs/PermissionRequestPerson" }, { "type": "null" } ] }, "decisionNote": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "reviewable": { "type": "boolean" } }, "required": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ], "patternProperties": { "^(?!(?:id|workspaceId|status|requester|permissions|grantedPermissions|reason|context|source|agentName|createdAt|expiresAt|decidedAt|decidedBy|decisionNote|reviewable)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "status", "requester", "permissions", "grantedPermissions", "reason", "context", "source", "agentName", "createdAt", "expiresAt", "decidedAt", "decidedBy", "decisionNote", "reviewable" ] } }, "CreatePermissionRequestResult": { "type": "object", "properties": { "request": { "$ref": "#/$defs/PermissionRequest" }, "created": { "type": "boolean" }, "alreadyHeld": { "type": "array", "items": { "type": "string", "enum": [ "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:read", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } } }, "required": [ "request", "created", "alreadyHeld" ], "patternProperties": { "^(?!(?:request|created|alreadyHeld)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "request", "created", "alreadyHeld" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/CreatePermissionRequestResult" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/CreatePermissionRequestResult" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `permissionRequests.create`: `POST /v1/workspaces/:workspaceId/permission-requests` ## resolve_external_steps Work the manual and external step queues: list failed or unknown external executions (HTTP POST / HeyReach) and resolve them by completing or retrying, and complete or fail manual-review step executions for a contact. Use to unblock contacts waiting on manual review or stuck external steps. Retry is the paid path and enforces the subscription gate. Resolutions are tri-state (resolved / already_resolved / contact_inactive) — report the state instead of retrying an already-resolved execution. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: sequence:read, sequence:update, campaign:update Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "complete" ] }, "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" }, "campaignId": { "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": { "contactId": { "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" }, "campaignStepId": { "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" }, "pass": { "type": "integer", "minimum": 1 } }, "required": [ "contactId", "campaignStepId", "pass" ], "patternProperties": { "^(?!(?:contactId|campaignStepId|pass)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "campaignStepId", "pass" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "fail" ] }, "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" }, "campaignId": { "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": { "contactId": { "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" }, "campaignStepId": { "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" }, "pass": { "type": "integer", "minimum": 1 } }, "required": [ "contactId", "campaignStepId", "pass" ], "patternProperties": { "^(?!(?:contactId|campaignStepId|pass)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "campaignStepId", "pass" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "payload" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "external_executions" ] }, "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" }, "campaignId": { "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" }, "campaignStepId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|campaignStepId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "campaignStepId" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "resolve_external_execution" ] }, "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" }, "campaignId": { "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" }, "executionId": { "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": { "action": { "type": "string", "enum": [ "complete", "retry" ] } }, "required": [ "action" ], "patternProperties": { "^(?!(?:action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "executionId", "payload" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|executionId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "executionId", "payload" ] } } ] } ``` ### 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": [ "complete" ] }, "campaignId": { "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": { "contactId": { "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" }, "campaignStepId": { "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" }, "pass": { "type": "integer", "minimum": 1 } }, "required": [ "contactId", "campaignStepId", "pass" ], "patternProperties": { "^(?!(?:contactId|campaignStepId|pass)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "campaignStepId", "pass" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "fail" ] }, "campaignId": { "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": { "contactId": { "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" }, "campaignStepId": { "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" }, "pass": { "type": "integer", "minimum": 1 } }, "required": [ "contactId", "campaignStepId", "pass" ], "patternProperties": { "^(?!(?:contactId|campaignStepId|pass)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "campaignStepId", "pass" ] } } }, "required": [ "action", "workspaceId", "campaignId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "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": [ "external_executions" ] }, "campaignId": { "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" }, "campaignStepId": { "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", "workspaceId", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|campaignStepId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "campaignStepId" ] }, { "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": [ "resolve_external_execution" ] }, "campaignId": { "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" }, "executionId": { "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": { "action": { "type": "string", "enum": [ "complete", "retry" ] } }, "required": [ "action" ], "patternProperties": { "^(?!(?:action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action" ] } ] } } }, "required": [ "action", "workspaceId", "campaignId", "executionId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|executionId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "executionId", "payload" ] }, { "enum": [ "workspaceId" ] } ] } } ] } ``` ### 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$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "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" }, "campaignContactId": { "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" }, "campaignStepId": { "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" }, "pass": { "type": "integer", "minimum": 1 }, "type": { "type": "string", "enum": [ "http_post_request", "heyreach_campaign" ] }, "state": { "type": "string", "enum": [ "ready", "sending", "succeeded", "failed", "unknown" ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactName": { "type": "string" } }, "required": [ "id", "campaignContactId", "campaignStepId", "pass", "type", "state", "error", "statusCode", "createdAt", "attempt", "contactName" ], "patternProperties": { "^(?!(?:id|campaignContactId|campaignStepId|pass|type|state|error|statusCode|createdAt|attempt|contactName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "campaignContactId", "campaignStepId", "pass", "type", "state", "error", "statusCode", "createdAt", "attempt", "contactName" ] } } }, { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "resolved" ] }, "success": { "type": "boolean", "enum": [ true ] }, "alreadyResolved": { "type": "boolean", "enum": [ false ] } }, "required": [ "status", "success", "alreadyResolved" ], "patternProperties": { "^(?!(?:status|success|alreadyResolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "success", "alreadyResolved" ] } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "already_resolved" ] }, "success": { "type": "boolean", "enum": [ true ] }, "alreadyResolved": { "type": "boolean", "enum": [ true ] } }, "required": [ "status", "success", "alreadyResolved" ], "patternProperties": { "^(?!(?:status|success|alreadyResolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "success", "alreadyResolved" ] } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "contact_inactive" ] }, "success": { "type": "boolean", "enum": [ false ] }, "alreadyResolved": { "type": "boolean", "enum": [ false ] } }, "required": [ "status", "success", "alreadyResolved" ], "patternProperties": { "^(?!(?:status|success|alreadyResolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "success", "alreadyResolved" ] } } ] }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "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" }, "campaignContactId": { "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" }, "campaignStepId": { "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" }, "pass": { "type": "integer", "minimum": 1 }, "type": { "type": "string", "enum": [ "http_post_request", "heyreach_campaign" ] }, "state": { "type": "string", "enum": [ "ready", "sending", "succeeded", "failed", "unknown" ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "statusCode": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "contactName": { "type": "string" } }, "required": [ "id", "campaignContactId", "campaignStepId", "pass", "type", "state", "error", "statusCode", "createdAt", "attempt", "contactName" ], "patternProperties": { "^(?!(?:id|campaignContactId|campaignStepId|pass|type|state|error|statusCode|createdAt|attempt|contactName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "campaignContactId", "campaignStepId", "pass", "type", "state", "error", "statusCode", "createdAt", "attempt", "contactName" ] } } }, { "anyOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "resolved" ] }, "success": { "type": "boolean", "enum": [ true ] }, "alreadyResolved": { "type": "boolean", "enum": [ false ] } }, "required": [ "status", "success", "alreadyResolved" ], "patternProperties": { "^(?!(?:status|success|alreadyResolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "success", "alreadyResolved" ] } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "already_resolved" ] }, "success": { "type": "boolean", "enum": [ true ] }, "alreadyResolved": { "type": "boolean", "enum": [ true ] } }, "required": [ "status", "success", "alreadyResolved" ], "patternProperties": { "^(?!(?:status|success|alreadyResolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "success", "alreadyResolved" ] } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "contact_inactive" ] }, "success": { "type": "boolean", "enum": [ false ] }, "alreadyResolved": { "type": "boolean", "enum": [ false ] } }, "required": [ "status", "success", "alreadyResolved" ], "patternProperties": { "^(?!(?:status|success|alreadyResolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "success", "alreadyResolved" ] } } ] }, { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaignSteps.complete`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/steps/complete` - `campaignSteps.fail`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/steps/fail` - `campaignSteps.externalExecutions`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/external-executions` - `campaignSteps.resolveExternalExecution`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/external-executions/:executionId/resolve` ## resolve_workspace Resolve an explicit workspace handle to its stable summary and available bundles. Use to turn a workspace id or slug into the handle every other capability call requires. This only resolves a handle; it mutates nothing and stores no ambient workspace state. Scopes: agent:identity, workspace:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "slug": { "$ref": "#/$defs/ShortText" } }, "patternProperties": { "^(?!(?:workspaceId|slug)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "slug" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### 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" }, "slug": { "$ref": "#/$defs/ShortText" } }, "patternProperties": { "^(?!(?:workspaceId|slug)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "slug" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "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" }, "name": { "$ref": "#/$defs/ShortText" }, "slug": { "$ref": "#/$defs/ShortText" }, "effectiveRoleLabel": { "$ref": "#/$defs/ShortText" }, "capabilityBundles": { "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,63}$" } }, "accessSource": { "type": "string", "enum": [ "membership", "organization", "credential" ] } }, "required": [ "id", "name", "slug", "effectiveRoleLabel", "capabilityBundles", "accessSource" ], "patternProperties": { "^(?!(?:id|name|slug|effectiveRoleLabel|capabilityBundles|accessSource)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "slug", "effectiveRoleLabel", "capabilityBundles", "accessSource" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `agent.resolveWorkspace`: `POST /agent/workspaces/resolve` ## review_contact_suggestions List contact suggestions from a conversation, save one to its lead, create a separate lead, or dismiss it. Select the action explicitly. Use when an automatic reply names another way to reach someone. Each suggestion states whether it can be saved and, if not, exactly why. Saving someone else's contact detail onto a lead is a judgement about whose it is, so blocked suggestions cannot be forced through. Confirming ownership answers uncertainty; it does not override a classification that says the detail belongs to a coworker or to the company. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: unibox:read, lead:update, lead:create Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "threadId": { "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", "threadId" ], "patternProperties": { "^(?!(?:workspaceId|action|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "apply" ] } ] }, "suggestionId": { "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" }, "confirmOwnership": { "type": "boolean" } }, "required": [ "workspaceId", "action", "suggestionId" ], "patternProperties": { "^(?!(?:workspaceId|action|suggestionId|confirmOwnership)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "suggestionId", "confirmOwnership" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "create_lead" ] } ] }, "suggestionId": { "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" }, "firstName": { "type": "string", "minLength": 1, "maxLength": 100 }, "lastName": { "type": "string", "maxLength": 100 } }, "required": [ "workspaceId", "action", "suggestionId", "firstName" ], "patternProperties": { "^(?!(?:workspaceId|action|suggestionId|firstName|lastName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "suggestionId", "firstName", "lastName" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "dismiss" ] } ] }, "suggestionId": { "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", "suggestionId" ], "patternProperties": { "^(?!(?:workspaceId|action|suggestionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "suggestionId" ] } } ] } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "list" ] } ] }, "threadId": { "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", "threadId" ], "patternProperties": { "^(?!(?:workspaceId|action|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "apply" ] } ] }, "suggestionId": { "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" }, "confirmOwnership": { "type": "boolean" } }, "required": [ "workspaceId", "action", "suggestionId" ], "patternProperties": { "^(?!(?:workspaceId|action|suggestionId|confirmOwnership)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "suggestionId", "confirmOwnership" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "create_lead" ] } ] }, "suggestionId": { "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" }, "firstName": { "type": "string", "minLength": 1, "maxLength": 100 }, "lastName": { "type": "string", "maxLength": 100 } }, "required": [ "workspaceId", "action", "suggestionId", "firstName" ], "patternProperties": { "^(?!(?:workspaceId|action|suggestionId|firstName|lastName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "suggestionId", "firstName", "lastName" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "dismiss" ] } ] }, "suggestionId": { "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", "suggestionId" ], "patternProperties": { "^(?!(?:workspaceId|action|suggestionId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "suggestionId" ] } } ] } ``` ### Output schema (structuredContent) ```json { "$defs": { "ContactSuggestionId": { "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" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "threadId": { "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" }, "leadId": { "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" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ContactSuggestionId" }, "threadId": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "normalizedValue": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "contactName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "ownership": { "type": "string", "enum": [ "self", "coworker", "company", "unknown" ] }, "contactType": { "$ref": "#/$defs/ShortText" }, "groupKey": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "evidence": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "reviewReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "relationship": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "messageId": { "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" } ] }, "canApply": { "type": "boolean" }, "canCreateLead": { "type": "boolean" }, "blockReason": { "anyOf": [ { "type": "string", "enum": [ "different_person", "company_contact", "ownership_review", "no_lead", "invalid_phone", "already_on_other_lead", "terminal_bad_contact" ] }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "threadId", "kind", "value", "normalizedValue", "contactName", "firstName", "lastName", "ownership", "contactType", "groupKey", "evidence", "reviewReason", "relationship", "confidence", "messageId", "canApply", "canCreateLead", "blockReason", "createdAt" ], "patternProperties": { "^(?!(?:id|threadId|kind|value|normalizedValue|contactName|firstName|lastName|ownership|contactType|groupKey|evidence|reviewReason|relationship|confidence|messageId|canApply|canCreateLead|blockReason|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "threadId", "kind", "value", "normalizedValue", "contactName", "firstName", "lastName", "ownership", "contactType", "groupKey", "evidence", "reviewReason", "relationship", "confidence", "messageId", "canApply", "canCreateLead", "blockReason", "createdAt" ] } }, "maxItems": 100 } }, "required": [ "threadId", "leadId", "items" ], "patternProperties": { "^(?!(?:threadId|leadId|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "leadId", "items" ] } }, { "type": "object", "properties": { "suggestionId": { "$ref": "#/$defs/ContactSuggestionId" }, "status": { "type": "string", "enum": [ "pending", "applied", "dismissed" ] }, "leadId": { "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" } ] }, "leadCreated": { "type": "boolean" }, "kind": { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ] }, { "type": "null" } ] }, "appliedValue": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "appliedContactPointId": { "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" } ] }, "appliedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "resolvedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "suggestionId", "status", "leadId", "leadCreated", "kind", "appliedValue", "appliedContactPointId", "appliedCount", "resolvedAt" ], "patternProperties": { "^(?!(?:suggestionId|status|leadId|leadCreated|kind|appliedValue|appliedContactPointId|appliedCount|resolvedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "suggestionId", "status", "leadId", "leadCreated", "kind", "appliedValue", "appliedContactPointId", "appliedCount", "resolvedAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "threadId": { "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" }, "leadId": { "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" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ContactSuggestionId" }, "threadId": { "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" }, "kind": { "type": "string", "enum": [ "email", "phone" ] }, "value": { "$ref": "#/$defs/NonEmptyString" }, "normalizedValue": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "contactName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "ownership": { "type": "string", "enum": [ "self", "coworker", "company", "unknown" ] }, "contactType": { "$ref": "#/$defs/ShortText" }, "groupKey": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "evidence": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "reviewReason": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "relationship": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 1 }, { "type": "null" } ] }, "messageId": { "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" } ] }, "canApply": { "type": "boolean" }, "canCreateLead": { "type": "boolean" }, "blockReason": { "anyOf": [ { "type": "string", "enum": [ "different_person", "company_contact", "ownership_review", "no_lead", "invalid_phone", "already_on_other_lead", "terminal_bad_contact" ] }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "threadId", "kind", "value", "normalizedValue", "contactName", "firstName", "lastName", "ownership", "contactType", "groupKey", "evidence", "reviewReason", "relationship", "confidence", "messageId", "canApply", "canCreateLead", "blockReason", "createdAt" ], "patternProperties": { "^(?!(?:id|threadId|kind|value|normalizedValue|contactName|firstName|lastName|ownership|contactType|groupKey|evidence|reviewReason|relationship|confidence|messageId|canApply|canCreateLead|blockReason|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "threadId", "kind", "value", "normalizedValue", "contactName", "firstName", "lastName", "ownership", "contactType", "groupKey", "evidence", "reviewReason", "relationship", "confidence", "messageId", "canApply", "canCreateLead", "blockReason", "createdAt" ] } }, "maxItems": 100 } }, "required": [ "threadId", "leadId", "items" ], "patternProperties": { "^(?!(?:threadId|leadId|items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "leadId", "items" ] } }, { "type": "object", "properties": { "suggestionId": { "$ref": "#/$defs/ContactSuggestionId" }, "status": { "type": "string", "enum": [ "pending", "applied", "dismissed" ] }, "leadId": { "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" } ] }, "leadCreated": { "type": "boolean" }, "kind": { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ] }, { "type": "null" } ] }, "appliedValue": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "appliedContactPointId": { "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" } ] }, "appliedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "resolvedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "suggestionId", "status", "leadId", "leadCreated", "kind", "appliedValue", "appliedContactPointId", "appliedCount", "resolvedAt" ], "patternProperties": { "^(?!(?:suggestionId|status|leadId|leadCreated|kind|appliedValue|appliedContactPointId|appliedCount|resolvedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "suggestionId", "status", "leadId", "leadCreated", "kind", "appliedValue", "appliedContactPointId", "appliedCount", "resolvedAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `uniboxThreads.listContactSuggestions`: `GET /v1/workspaces/:workspaceId/unibox/threads/:threadId/contact-suggestions` - `uniboxSuggestions.apply`: `POST /v1/workspaces/:workspaceId/unibox/contact-suggestions/:suggestionId/apply` - `uniboxSuggestions.createLead`: `POST /v1/workspaces/:workspaceId/unibox/contact-suggestions/:suggestionId/create-lead` - `uniboxSuggestions.dismiss`: `POST /v1/workspaces/:workspaceId/unibox/contact-suggestions/:suggestionId/dismiss` ## revoke_api_key Revoke one of the caller's personal API keys: preview first, then commit with the returned confirmation token. Use when the person asks to shut off one of their keys. Revocation is immediate and cannot be undone; every integration using the key stops authenticating. To stop a member's key in one Organization only, use block_organization_api_key. Use the native preview first and pass its confirmation token unchanged to commit. A token does not bypass current permissions or Workspace checks. Scopes: apiKey:delete Risk: destructive; confirmation: preview_token; idempotency: required. ### Input schema (personal API key) ```json { "type": "object", "properties": { "apiKeyId": { "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" }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "apiKeyId" ], "patternProperties": { "^(?!(?:apiKeyId|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "apiKeyId", "confirmationToken" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "apiKeyId": { "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" }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "apiKeyId" ], "patternProperties": { "^(?!(?:apiKeyId|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "apiKeyId", "confirmationToken" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "Money": { "type": "object", "properties": { "amountMinor": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLE", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAD", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XCG", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWG" ] } }, "required": [ "amountMinor", "currency" ], "patternProperties": { "^(?!(?:amountMinor|currency)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "amountMinor", "currency" ] } }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "preview", "confirmationToken" ] } }, { "type": "object", "properties": { "revoked": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "revoked" ], "patternProperties": { "^(?!(?:revoked)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "revoked" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "preview": { "type": "object", "properties": { "summary": { "$ref": "#/$defs/Description" }, "affected": { "type": "object", "properties": { "resourceCounts": { "type": "array", "items": { "type": "object", "properties": { "type": { "$ref": "#/$defs/NonEmptyString" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "type", "count" ], "patternProperties": { "^(?!(?:type|count)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "count" ] } }, "maxItems": 64 }, "resourceIds": { "type": "array", "items": { "$ref": "#/$defs/OpaqueId" }, "maxItems": 256 } }, "required": [ "resourceCounts", "resourceIds" ], "patternProperties": { "^(?!(?:resourceCounts|resourceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "resourceCounts", "resourceIds" ] } }, "costEstimate": { "type": "object", "properties": { "min": { "$ref": "#/$defs/Money" }, "max": { "$ref": "#/$defs/Money" } }, "required": [ "min", "max" ], "patternProperties": { "^(?!(?:min|max)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "min", "max" ] } }, "warnings": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "irreversibleFacts": { "type": "array", "items": { "$ref": "#/$defs/ShortText" }, "maxItems": 32 }, "inputHash": { "$ref": "#/$defs/OpaqueId" }, "previewVersion": { "$ref": "#/$defs/NonEmptyString" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "summary", "affected", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ], "patternProperties": { "^(?!(?:summary|affected|costEstimate|warnings|irreversibleFacts|inputHash|previewVersion|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "summary", "affected", "costEstimate", "warnings", "irreversibleFacts", "inputHash", "previewVersion", "expiresAt" ] } }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "preview", "confirmationToken" ], "patternProperties": { "^(?!(?:preview|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "preview", "confirmationToken" ] } }, { "type": "object", "properties": { "revoked": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "revoked" ], "patternProperties": { "^(?!(?:revoked)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "revoked" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `personalApiKeys.previewRevoke`: `POST /v1/me/api-keys/:apiKeyId/revocation-preview` - `personalApiKeys.revoke`: `DELETE /v1/me/api-keys/:apiKeyId` ## revoke_integration_share Stop sharing a connection: every target workspace's copy is detached and the source keeps working. Use on the source workspace to take a shared connection back from every sibling workspace. To remove one workspace only, that workspace detaches. Disconnecting the source connection itself is the provider's own disconnect. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:delete Risk: destructive; confirmation: explicit; 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" }, "shareId": { "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", "shareId" ], "patternProperties": { "^(?!(?:workspaceId|shareId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "shareId" ] } } ``` ### 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" }, "shareId": { "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", "shareId" ], "patternProperties": { "^(?!(?:workspaceId|shareId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "shareId" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "adapter": { "$ref": "#/$defs/IntegrationShareAdapter" }, "provider": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,63}$" }, "displayName": { "$ref": "#/$defs/ShortText" }, "role": { "type": "string", "enum": [ "source", "target" ] }, "sourceWorkspaceId": { "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" }, "sourceWorkspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "sourceConnectionId": { "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" }, "sourceConnected": { "type": "boolean" }, "includeFutureWorkspaces": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "attaching", "attached", "detached", "failed" ] }, "connectionId": { "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" } ] }, "failureReason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "attachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "detachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|state|connectionId|failureReason|attachedAt|detachedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ] } }, "maxItems": 500 } }, "required": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ], "patternProperties": { "^(?!(?:id|adapter|provider|displayName|role|sourceWorkspaceId|sourceWorkspaceName|sourceConnectionId|sourceConnected|includeFutureWorkspaces|createdAt|revokedAt|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ] }, "$defs": { "IntegrationShareAdapter": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer", "heyreach", "getleads", "plusvibe", "calendly", "cal_com", "attio", "email_verifier", "phone_verifier", "warmup_provider", "mcp_server", "app_connection" ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `integrationShares.revoke`: `DELETE /v1/workspaces/:workspaceId/integration-shares/:shareId` ## revoke_support_access End a Scheduler Zero support-access grant in a workspace immediately. Use when support no longer needs access, or the person asks to remove it. Revoking an already-ended grant is a no-op. It does not remove workspace members or API keys; use their own tools. Scopes: workspaceMember:remove 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" }, "grantId": { "$ref": "#/$defs/SupportAccessGrantId" } }, "required": [ "workspaceId", "grantId" ], "patternProperties": { "^(?!(?:workspaceId|grantId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "grantId" ] }, "$defs": { "SupportAccessGrantId": { "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" } } } ``` ### 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" }, "grantId": { "$ref": "#/$defs/SupportAccessGrantId" } }, "required": [ "workspaceId", "grantId" ], "patternProperties": { "^(?!(?:workspaceId|grantId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "grantId" ] }, "$defs": { "SupportAccessGrantId": { "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" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "SupportAccessGrantId": { "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" }, "SupportAccessStatus": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "SupportAccessDurationHours": { "type": "number", "enum": [ 24, 72, 168 ] }, "SupportAccessPerson": { "type": "object", "properties": { "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "userId", "email" ], "patternProperties": { "^(?!(?:userId|email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "email" ] } }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "SupportAccessGrant": { "type": "object", "properties": { "id": { "$ref": "#/$defs/SupportAccessGrantId" }, "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" }, "status": { "$ref": "#/$defs/SupportAccessStatus" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "agent:capabilities", "agent:identity", "agent:operations:cancel", "agent:operations:read", "analytics:export", "analytics:read", "apiKey:create", "apiKey:delete", "apiKey:read", "apiKey:update", "audit:read", "billing:manage", "billing:read", "blocklist:create", "blocklist:delete", "blocklist:read", "campaign:archive", "campaign:create", "campaign:delete", "campaign:launch", "campaign:pause", "campaign:read", "campaign:update", "dialer:assign_numbers", "dialer:assign_seats", "dialer:create", "dialer:delete", "dialer:dial", "dialer:manage_billing", "dialer:manage_number_health", "dialer:manage_numbers", "dialer:manage_numbers_self", "dialer:manage_voicemails", "dialer:read", "dialer:read_analytics", "dialer:read_numbers_all", "dialer:release_numbers", "dialer:update", "domain:manage_dns", "domain:purchase", "domain:read", "domain:transfer", "emailVerification:manage_credits", "emailVerification:manage_keys", "emailVerification:manage_sharing", "emailVerification:read", "emailVerification:verify", "inbox:connect", "inbox:create", "inbox:delete", "inbox:read", "inbox:update", "inbox:warmup_manage", "integration:create", "integration:delete", "integration:read", "integration:update", "lead:create", "lead:delete", "lead:export", "lead:import", "lead:read", "lead:update", "leadList:create", "leadList:delete", "leadList:read", "leadList:update", "org:delete", "orgAnalytics:read", "orgAnalytics:manage", "org:read", "org:update", "orgApiKey:manage", "orgMember:invite", "orgMember:read", "orgMember:remove", "orgMember:update", "phoneVerification:manage_keys", "phoneVerification:read", "phoneVerification:verify", "platform:operate", "replyLabel:create", "replyLabel:delete", "replyLabel:read", "replyLabel:update", "role:manage", "role:read", "sequence:create", "sequence:delete", "sequence:read", "sequence:update", "sql:manage_dashboards", "sql:query", "support:create", "support:read", "support:update", "tag:create", "tag:delete", "tag:read", "tag:update", "task:create", "task:delete", "task:read", "task:update", "template:create", "template:delete", "template:read", "template:update", "unibox:archive", "unibox:label", "unibox:read", "unibox:reply", "usage:read", "webhook:create", "webhook:delete", "webhook:read", "webhook:update", "whiteLabel:read", "whiteLabel:update", "workflow:create", "workflow:delete", "workflow:publish", "workflow:read", "workflow:run", "workflow:update", "workspace:create", "workspace:delete", "workspace:read", "workspace:transfer", "workspace:update", "workspaceMember:invite", "workspaceMember:read", "workspaceMember:remove", "workspaceMember:update" ] } }, "durationHours": { "$ref": "#/$defs/SupportAccessDurationHours" }, "reason": { "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "grantedBy": { "$ref": "#/$defs/SupportAccessPerson" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "expiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "revokedBy": { "anyOf": [ { "$ref": "#/$defs/SupportAccessPerson" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "id", "workspaceId", "status", "permissions", "durationHours", "reason", "grantedBy", "createdAt", "expiresAt", "revokedAt", "revokedBy", "lastUsedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|status|permissions|durationHours|reason|grantedBy|createdAt|expiresAt|revokedAt|revokedBy|lastUsedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "status", "permissions", "durationHours", "reason", "grantedBy", "createdAt", "expiresAt", "revokedAt", "revokedBy", "lastUsedAt" ] } }, "RevokeSupportAccessResult": { "type": "object", "properties": { "grant": { "$ref": "#/$defs/SupportAccessGrant" }, "changed": { "type": "boolean" } }, "required": [ "grant", "changed" ], "patternProperties": { "^(?!(?:grant|changed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "grant", "changed" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/RevokeSupportAccessResult" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/RevokeSupportAccessResult" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `supportAccess.revoke`: `POST /v1/workspaces/:workspaceId/support-access/:grantId/revoke` ## rotate_webhook_secret Rotate an owned webhook signing secret and return its replacement once. Rotate when the receiver is ready to install the replacement; requires explicit confirmation. Never place the returned secret in logs or saved conversation artifacts. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: webhook:update Risk: security_admin; confirmation: explicit; 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" }, "webhookId": { "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", "webhookId" ], "patternProperties": { "^(?!(?:workspaceId|webhookId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "webhookId" ] } } ``` ### 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" }, "webhookId": { "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", "webhookId" ], "patternProperties": { "^(?!(?:workspaceId|webhookId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "webhookId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "webhookId": { "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" }, "signingSecret": { "$ref": "#/$defs/NonEmptyString" }, "fingerprint": { "$ref": "#/$defs/NonEmptyString" }, "rotatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "webhookId", "signingSecret", "fingerprint", "rotatedAt" ], "patternProperties": { "^(?!(?:webhookId|signingSecret|fingerprint|rotatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "webhookId", "signingSecret", "fingerprint", "rotatedAt" ] }, "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `webhooks.rotateSecret`: `POST /v1/workspaces/:workspaceId/webhooks/:webhookId/secret-rotation` ## run_getleads_request Run a GetLeads request — enrichment, phone lookup, search, count, export, or profile management — in the background. Call with action=preview first to see the item count and credit estimate. After approval, call with action=execute, pass the exact confirmationToken returned by that preview when the request is billable. The server derives the replay key from the request. Poll the operation for per-item results. Billable requests spend the customer's GetLeads credits. An execution whose outcome is unknown is never retried automatically — check before re-running. Use the native preview first and pass its confirmation token unchanged to commit. A token does not bypass current permissions or Workspace checks. Scopes: integration:read, integration:update Risk: costly; confirmation: preview_token; idempotency: required. ### 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" }, "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" }, "request": { "anyOf": [ { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "usage" ] }, "input": { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "enrich_email" ] }, "input": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "email" ], "patternProperties": { "^(?!(?:email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "email" ] } ] } }, "minItems": 1, "maxItems": 100 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "enrich_linkedin" ] }, "input": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "linkedin_url": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "linkedin_url" ], "patternProperties": { "^(?!(?:linkedin_url)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "linkedin_url" ] } ] } }, "minItems": 1, "maxItems": 100 }, "limit_per_item": { "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items|limit_per_item)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "limit_per_item" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "enrich_person" ] }, "input": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "minLength": 1, "maxLength": 1000 }, "last_name": { "type": "string", "minLength": 1, "maxLength": 1000 }, "company_name": { "type": "string", "minLength": 1, "maxLength": 1000 }, "email_domain": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "first_name", "last_name" ], "patternProperties": { "^(?!(?:first_name|last_name|company_name|email_domain)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "first_name", "last_name", "company_name", "email_domain" ] } }, "minItems": 1, "maxItems": 100 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "lookup_phone" ] }, "input": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "phone" ], "patternProperties": { "^(?!(?:phone)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "phone" ] } ] } }, "minItems": 1, "maxItems": 100 }, "limit_per_item": { "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items|limit_per_item)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "limit_per_item" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "search" ] }, "input": { "type": "object", "properties": { "filters": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" }, "minProperties": 1, "maxProperties": 100 }, "limit": { "type": "integer", "minimum": 1, "maximum": 5000 }, "offset": { "type": "integer", "minimum": 0, "maximum": 49999 }, "max_per_company": { "type": "integer", "minimum": 1, "maximum": 50 } }, "required": [ "filters" ], "patternProperties": { "^(?!(?:filters|limit|offset|max_per_company)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "filters", "limit", "offset", "max_per_company" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "count" ] }, "input": { "type": "object", "properties": { "filters": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" }, "minProperties": 1, "maxProperties": 100 } }, "required": [ "filters" ], "patternProperties": { "^(?!(?:filters)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "filters" ] } ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "export" ] }, "input": { "type": "object", "properties": { "filters": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" }, "minProperties": 1, "maxProperties": 100 }, "max_rows": { "type": "integer", "minimum": 1, "maximum": 50000 }, "max_per_company": { "type": "integer", "minimum": 1, "maximum": 50 }, "confirmed": { "type": "boolean", "enum": [ true ] } }, "required": [ "filters", "max_rows", "confirmed" ], "patternProperties": { "^(?!(?:filters|max_rows|max_per_company|confirmed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "filters", "max_rows", "max_per_company", "confirmed" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "export_status" ] }, "input": { "type": "object", "properties": { "export_id": { "type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[A-Za-z0-9_-]+$" } }, "required": [ "export_id" ], "patternProperties": { "^(?!(?:export_id)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "export_id" ] } ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "profiles" ] }, "input": { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "profile_leads" ] }, "input": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "patternProperties": { "^(?!(?:limit|cursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "cursor" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "set_profile_active" ] }, "input": { "type": "object", "properties": { "profile_id": { "type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[A-Za-z0-9_-]+$" }, "active": { "type": "boolean" } }, "required": [ "profile_id", "active" ], "patternProperties": { "^(?!(?:profile_id|active)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profile_id", "active" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } } ] }, "action": { "type": "string", "enum": [ "preview", "execute" ] }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "workspaceId", "connectionId", "request", "action" ], "patternProperties": { "^(?!(?:workspaceId|connectionId|request|action|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId", "request", "action", "confirmationToken" ] }, "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### 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" }, "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" }, "request": { "anyOf": [ { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "usage" ] }, "input": { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "enrich_email" ] }, "input": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "email" ], "patternProperties": { "^(?!(?:email)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "email" ] } ] } }, "minItems": 1, "maxItems": 100 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "enrich_linkedin" ] }, "input": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "linkedin_url": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "linkedin_url" ], "patternProperties": { "^(?!(?:linkedin_url)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "linkedin_url" ] } ] } }, "minItems": 1, "maxItems": 100 }, "limit_per_item": { "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items|limit_per_item)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "limit_per_item" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "enrich_person" ] }, "input": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "first_name": { "type": "string", "minLength": 1, "maxLength": 1000 }, "last_name": { "type": "string", "minLength": 1, "maxLength": 1000 }, "company_name": { "type": "string", "minLength": 1, "maxLength": 1000 }, "email_domain": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "first_name", "last_name" ], "patternProperties": { "^(?!(?:first_name|last_name|company_name|email_domain)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "first_name", "last_name", "company_name", "email_domain" ] } }, "minItems": 1, "maxItems": 100 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "lookup_phone" ] }, "input": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "phone": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": [ "phone" ], "patternProperties": { "^(?!(?:phone)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "phone" ] } ] } }, "minItems": 1, "maxItems": 100 }, "limit_per_item": { "type": "integer", "minimum": 1, "maximum": 10 } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items|limit_per_item)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "limit_per_item" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "search" ] }, "input": { "type": "object", "properties": { "filters": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" }, "minProperties": 1, "maxProperties": 100 }, "limit": { "type": "integer", "minimum": 1, "maximum": 5000 }, "offset": { "type": "integer", "minimum": 0, "maximum": 49999 }, "max_per_company": { "type": "integer", "minimum": 1, "maximum": 50 } }, "required": [ "filters" ], "patternProperties": { "^(?!(?:filters|limit|offset|max_per_company)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "filters", "limit", "offset", "max_per_company" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "count" ] }, "input": { "type": "object", "properties": { "filters": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" }, "minProperties": 1, "maxProperties": 100 } }, "required": [ "filters" ], "patternProperties": { "^(?!(?:filters)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "filters" ] } ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "export" ] }, "input": { "type": "object", "properties": { "filters": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" }, "minProperties": 1, "maxProperties": 100 }, "max_rows": { "type": "integer", "minimum": 1, "maximum": 50000 }, "max_per_company": { "type": "integer", "minimum": 1, "maximum": 50 }, "confirmed": { "type": "boolean", "enum": [ true ] } }, "required": [ "filters", "max_rows", "confirmed" ], "patternProperties": { "^(?!(?:filters|max_rows|max_per_company|confirmed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "filters", "max_rows", "max_per_company", "confirmed" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "export_status" ] }, "input": { "type": "object", "properties": { "export_id": { "type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[A-Za-z0-9_-]+$" } }, "required": [ "export_id" ], "patternProperties": { "^(?!(?:export_id)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "export_id" ] } ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "profiles" ] }, "input": { "type": "object", "patternProperties": { "^[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "not": {} } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "profile_leads" ] }, "input": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "patternProperties": { "^(?!(?:limit|cursor)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "limit", "cursor" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } }, { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "set_profile_active" ] }, "input": { "type": "object", "properties": { "profile_id": { "type": "string", "minLength": 1, "maxLength": 1000, "pattern": "^[A-Za-z0-9_-]+$" }, "active": { "type": "boolean" } }, "required": [ "profile_id", "active" ], "patternProperties": { "^(?!(?:profile_id|active)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profile_id", "active" ] } } }, "required": [ "operation", "input" ], "patternProperties": { "^(?!(?:operation|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "input" ] } } ] }, "action": { "type": "string", "enum": [ "preview", "execute" ] }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "workspaceId", "connectionId", "request", "action" ], "patternProperties": { "^(?!(?:workspaceId|connectionId|request|action|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "connectionId", "request", "action", "confirmationToken" ] }, "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "usage", "enrich_email", "enrich_linkedin", "enrich_person", "lookup_phone", "search", "count", "export", "export_status", "profiles", "profile_leads", "set_profile_active" ] }, "itemCount": { "type": "integer", "minimum": 0 }, "billable": { "type": "boolean" }, "estimatedCredits": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "confirmationToken": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "operation", "itemCount", "billable", "estimatedCredits", "confirmationToken", "expiresAt" ], "patternProperties": { "^(?!(?:operation|itemCount|billable|estimatedCredits|confirmationToken|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "itemCount", "billable", "estimatedCredits", "confirmationToken", "expiresAt" ] } }, { "type": "object", "properties": { "providerOperation": { "type": "string", "enum": [ "usage", "enrich_email", "enrich_linkedin", "enrich_person", "lookup_phone", "search", "count", "export", "export_status", "profiles", "profile_leads", "set_profile_active" ] }, "itemCount": { "type": "integer", "minimum": 0 }, "operation": { "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" ] } } }, "required": [ "providerOperation", "itemCount", "operation" ], "patternProperties": { "^(?!(?:providerOperation|itemCount|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerOperation", "itemCount", "operation" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "usage", "enrich_email", "enrich_linkedin", "enrich_person", "lookup_phone", "search", "count", "export", "export_status", "profiles", "profile_leads", "set_profile_active" ] }, "itemCount": { "type": "integer", "minimum": 0 }, "billable": { "type": "boolean" }, "estimatedCredits": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "confirmationToken": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "operation", "itemCount", "billable", "estimatedCredits", "confirmationToken", "expiresAt" ], "patternProperties": { "^(?!(?:operation|itemCount|billable|estimatedCredits|confirmationToken|expiresAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "operation", "itemCount", "billable", "estimatedCredits", "confirmationToken", "expiresAt" ] } }, { "type": "object", "properties": { "providerOperation": { "type": "string", "enum": [ "usage", "enrich_email", "enrich_linkedin", "enrich_person", "lookup_phone", "search", "count", "export", "export_status", "profiles", "profile_leads", "set_profile_active" ] }, "itemCount": { "type": "integer", "minimum": 0 }, "operation": { "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" ] } } }, "required": [ "providerOperation", "itemCount", "operation" ], "patternProperties": { "^(?!(?:providerOperation|itemCount|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerOperation", "itemCount", "operation" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `getleads.previewExecution`: `POST /v1/workspaces/:workspaceId/integrations/getleads/:connectionId/execute/preview` - `getleads.execute`: `POST /v1/workspaces/:workspaceId/integrations/getleads/:connectionId/execute` ## run_inbox_diagnostics Dispatches DNS checks, attachment repair, blacklist checks, placement diagnostics, and bulk reconnect/recheck runs; returns native dispatch receipts or per-inbox bulk outcomes. When asked to check DNS, repair attachments, run blacklist or placement diagnostics, or reconnect errored inboxes. For reads — use read_inbox_health. Scopes: inbox:update Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "check_dns" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "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": [ "repair_attachments" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "payload": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 500 } }, "patternProperties": { "^(?!(?:limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "limit" ] } ] } } }, "required": [ "workspaceId", "action", "inboxId", "payload" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "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": [ "check_blacklists" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] } }, { "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_placement" ] }, "payload": { "type": "object", "properties": { "senderInboxId": { "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" }, "recipientInboxId": { "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" }, "subject": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^\\r\\n]+$" }, "body": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "senderInboxId", "recipientInboxId", "subject", "body" ], "patternProperties": { "^(?!(?:senderInboxId|recipientInboxId|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderInboxId", "recipientInboxId", "subject", "body" ] } } }, "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": [ "recheck_dns" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 } }, "required": [ "inboxIds" ], "patternProperties": { "^(?!(?:inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "inboxIds" ] } ] } } }, "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": [ "reconnect_errors" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 } }, "required": [ "inboxIds" ], "patternProperties": { "^(?!(?:inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "inboxIds" ] } ] } } }, "required": [ "workspaceId", "action", "payload" ], "patternProperties": { "^(?!(?:workspaceId|action|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "payload" ] } } ] } ``` ### 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": [ "check_dns" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "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": [ "repair_attachments" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "payload": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": 1, "maximum": 500 } }, "patternProperties": { "^(?!(?:limit)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "limit" ] } ] } } }, "required": [ "workspaceId", "action", "inboxId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "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": [ "check_blacklists" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "inboxId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId" ] }, { "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_placement" ] }, "payload": { "type": "object", "properties": { "senderInboxId": { "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" }, "recipientInboxId": { "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" }, "subject": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[^\\r\\n]+$" }, "body": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "senderInboxId", "recipientInboxId", "subject", "body" ], "patternProperties": { "^(?!(?:senderInboxId|recipientInboxId|subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderInboxId", "recipientInboxId", "subject", "body" ] } } }, "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": [ "recheck_dns" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 } }, "required": [ "inboxIds" ], "patternProperties": { "^(?!(?:inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "inboxIds" ] } ] } } }, "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": [ "reconnect_errors" ] }, "payload": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 } }, "required": [ "inboxIds" ], "patternProperties": { "^(?!(?:inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "inboxIds" ] } ] } } }, "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" ] } ] } } ] } ``` ### Output schema (structuredContent) ```json { "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "runId": { "$ref": "#/$defs/OpaqueId" }, "operation": { "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" ] } } }, "required": [ "runId", "operation" ], "patternProperties": { "^(?!(?:runId|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "operation" ] } }, { "type": "object", "properties": { "testId": { "$ref": "#/$defs/OpaqueId" }, "runId": { "$ref": "#/$defs/OpaqueId" }, "operation": { "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" ] } } }, "required": [ "testId", "runId", "operation" ], "patternProperties": { "^(?!(?:testId|runId|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "testId", "runId", "operation" ] } }, { "type": "object", "properties": { "outcomes": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "status": { "type": "string", "enum": [ "updated", "skipped", "failed" ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "inboxId", "status", "reason" ], "patternProperties": { "^(?!(?:inboxId|status|reason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "status", "reason" ] } } } }, "required": [ "outcomes" ], "patternProperties": { "^(?!(?:outcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "outcomes" ] } ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "runId": { "$ref": "#/$defs/OpaqueId" }, "operation": { "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" ] } } }, "required": [ "runId", "operation" ], "patternProperties": { "^(?!(?:runId|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "operation" ] } }, { "type": "object", "properties": { "testId": { "$ref": "#/$defs/OpaqueId" }, "runId": { "$ref": "#/$defs/OpaqueId" }, "operation": { "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" ] } } }, "required": [ "testId", "runId", "operation" ], "patternProperties": { "^(?!(?:testId|runId|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "testId", "runId", "operation" ] } }, { "type": "object", "properties": { "outcomes": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "status": { "type": "string", "enum": [ "updated", "skipped", "failed" ] }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "inboxId", "status", "reason" ], "patternProperties": { "^(?!(?:inboxId|status|reason)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "status", "reason" ] } } } }, "required": [ "outcomes" ], "patternProperties": { "^(?!(?:outcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "outcomes" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `inboxes.checkDns`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/check-dns` - `inboxes.repairAttachments`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/repair-attachments` - `inboxDeliverability.checkBlacklists`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/deliverability/check-blacklists` - `inboxPlacementDiagnostics.start`: `POST /v1/workspaces/:workspaceId/placement-diagnostics/start` - `inboxBulk.recheckDns`: `POST /v1/workspaces/:workspaceId/inboxes/bulk/recheck-dns` - `inboxBulk.reconnectErrors`: `POST /v1/workspaces/:workspaceId/inboxes/bulk/reconnect-errors` ## run_organization_sql Run one read-only SELECT against the Organization's curated SQL views, or list those views, their columns, and the query limits. Use for ad-hoc reporting across campaigns, leads, inboxes, threads, and sends when no dedicated tool answers the question. Call without a query first to discover the views and columns, including current-address SEG detection/vendor/provenance on leads and frozen send-time attribution. Filter campaigns and SEG vendors with SQL; unknown detection is not confirmed no-SEG. Never for writes, catalog introspection, or children of another Organization: all selected children must independently grant sql:query and enable SQL; omitted workspaceIds selects all eligible children (maximum 100). Explicit IDs are all validated. Only a single SELECT over the curated views is accepted, results are capped at 10,000 rows and 8 MiB. Scopes: orgAnalytics:read, sql:query Risk: read; confirmation: none; idempotency: none. ### Input schema (personal API key) ```json { "type": "object", "properties": { "organizationId": { "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" }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "minLength": 0, "maxLength": 4096 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "maxItems": 32 }, "query": { "type": "string", "minLength": 1, "maxLength": 20000 } }, "required": [ "organizationId" ], "patternProperties": { "^(?!(?:organizationId|workspaceIds|parameters|query)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "workspaceIds", "parameters", "query" ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "organizationId": { "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" }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "minLength": 0, "maxLength": 4096 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "maxItems": 32 }, "query": { "type": "string", "minLength": 1, "maxLength": 20000 } }, "required": [ "organizationId" ], "patternProperties": { "^(?!(?:organizationId|workspaceIds|parameters|query)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "workspaceIds", "parameters", "query" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "SqlQueryResult": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "required": [ "name", "type" ], "patternProperties": { "^(?!(?:name|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type" ] } } }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "maxItems": 10000 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" }, "executionMs": { "type": "number", "minimum": 0 } }, "required": [ "columns", "rows", "rowCount", "truncated", "executionMs" ], "patternProperties": { "^(?!(?:columns|rows|rowCount|truncated|executionMs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "columns", "rows", "rowCount", "truncated", "executionMs" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "tables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": { "type": "string", "minLength": 0, "maxLength": 4096 }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": { "type": "string", "minLength": 0, "maxLength": 4096 } }, "required": [ "name", "type", "description" ], "patternProperties": { "^(?!(?:name|type|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "description" ] } } } }, "required": [ "name", "description", "columns" ], "patternProperties": { "^(?!(?:name|description|columns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "description", "columns" ] } } }, "limits": { "type": "object", "properties": { "statementTimeoutSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tempFileLimitMb": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxRows": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rateLimitPerSecond": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxConcurrentQueries": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "statementTimeoutSeconds", "tempFileLimitMb", "maxRows", "rateLimitPerSecond", "maxConcurrentQueries" ], "patternProperties": { "^(?!(?:statementTimeoutSeconds|tempFileLimitMb|maxRows|rateLimitPerSecond|maxConcurrentQueries)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "statementTimeoutSeconds", "tempFileLimitMb", "maxRows", "rateLimitPerSecond", "maxConcurrentQueries" ] } }, "workspaces": { "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" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } } } }, "required": [ "tables", "limits", "workspaces" ], "patternProperties": { "^(?!(?:tables|limits|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "tables", "limits", "workspaces" ] } }, { "$ref": "#/$defs/SqlQueryResult" } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "tables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": { "type": "string", "minLength": 0, "maxLength": 4096 }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": { "type": "string", "minLength": 0, "maxLength": 4096 } }, "required": [ "name", "type", "description" ], "patternProperties": { "^(?!(?:name|type|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "description" ] } } } }, "required": [ "name", "description", "columns" ], "patternProperties": { "^(?!(?:name|description|columns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "description", "columns" ] } } }, "limits": { "type": "object", "properties": { "statementTimeoutSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tempFileLimitMb": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxRows": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rateLimitPerSecond": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxConcurrentQueries": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "statementTimeoutSeconds", "tempFileLimitMb", "maxRows", "rateLimitPerSecond", "maxConcurrentQueries" ], "patternProperties": { "^(?!(?:statementTimeoutSeconds|tempFileLimitMb|maxRows|rateLimitPerSecond|maxConcurrentQueries)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "statementTimeoutSeconds", "tempFileLimitMb", "maxRows", "rateLimitPerSecond", "maxConcurrentQueries" ] } }, "workspaces": { "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" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } } } }, "required": [ "tables", "limits", "workspaces" ], "patternProperties": { "^(?!(?:tables|limits|workspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "tables", "limits", "workspaces" ] } }, { "$ref": "#/$defs/SqlQueryResult" } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `organizationSql.query`: `POST /v1/organizations/:organizationId/sql/query` - `organizationSql.schema`: `GET /v1/organizations/:organizationId/sql/schema` ## run_workflows Start and control individual runs: enrol a conversation into a published thread workflow, test-run a saved draft against a chosen subject, stop a run, and re-queue a paused one. Use to put a specific conversation through automation, to try a draft end to end before publishing it, or to halt or repair a run. Enrolling and test-running run in the background; poll the returned handle. A test run is a REAL run — its actions send, enrich, and charge exactly as a live run would. Enrolling a thread that already has an active automation is refused rather than doubled up. Resuming a paused provider lookup can spend another credit, so it needs an explicit cost acknowledgement, and only a paused run may resume at all. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workflow:run, workflow:publish Risk: costly; confirmation: explicit; 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": [ "enroll_thread" ] }, "workflowId": { "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" }, "enroll": { "type": "object", "properties": { "threadId": { "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "threadId" ], "patternProperties": { "^(?!(?:threadId|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "inboxId" ] } } }, "required": [ "workspaceId", "action", "workflowId", "enroll" ], "patternProperties": { "^(?!(?:workspaceId|action|workflowId|enroll)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "workflowId", "enroll" ] } }, { "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": [ "test_run" ] }, "workflowId": { "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" }, "test": { "type": "object", "properties": { "leadId": { "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "threadId": { "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": { "^(?!(?:leadId|inboxId|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadId", "inboxId", "threadId" ] } } }, "required": [ "workspaceId", "action", "workflowId", "test" ], "patternProperties": { "^(?!(?:workspaceId|action|workflowId|test)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "workflowId", "test" ] } }, { "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": [ "stop" ] }, "runId": { "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", "runId" ], "patternProperties": { "^(?!(?:workspaceId|action|runId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "runId" ] } }, { "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": [ "resume" ] }, "workflowId": { "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" }, "runId": { "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" }, "resume": { "type": "object", "properties": { "acknowledgeLookupCost": { "type": "boolean" } }, "patternProperties": { "^(?!(?:acknowledgeLookupCost)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "acknowledgeLookupCost" ] } ] } } }, "required": [ "workspaceId", "action", "workflowId", "runId", "resume" ], "patternProperties": { "^(?!(?:workspaceId|action|workflowId|runId|resume)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "workflowId", "runId", "resume" ] } } ] } ``` ### 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": [ "enroll_thread" ] }, "workflowId": { "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" }, "enroll": { "type": "object", "properties": { "threadId": { "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "threadId" ], "patternProperties": { "^(?!(?:threadId|inboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "inboxId" ] } } }, "required": [ "workspaceId", "action", "workflowId", "enroll" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|workflowId|enroll)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "workflowId", "enroll" ] }, { "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": [ "test_run" ] }, "workflowId": { "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" }, "test": { "type": "object", "properties": { "leadId": { "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "threadId": { "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": { "^(?!(?:leadId|inboxId|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadId", "inboxId", "threadId" ] } } }, "required": [ "workspaceId", "action", "workflowId", "test" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|workflowId|test)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "workflowId", "test" ] }, { "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": [ "stop" ] }, "runId": { "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", "runId" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|runId)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "runId" ] }, { "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": [ "resume" ] }, "workflowId": { "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" }, "runId": { "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" }, "resume": { "type": "object", "properties": { "acknowledgeLookupCost": { "type": "boolean" } }, "patternProperties": { "^(?!(?:acknowledgeLookupCost)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "acknowledgeLookupCost" ] } ] } } }, "required": [ "workspaceId", "action", "workflowId", "runId", "resume" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|workflowId|runId|resume)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "workflowId", "runId", "resume" ] }, { "enum": [ "workspaceId" ] } ] } } ] } ``` ### Output schema (structuredContent) ```json { "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "runId": { "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" }, "workflowId": { "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" }, "replayed": { "type": "boolean" }, "operation": { "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" ] } } }, "required": [ "runId", "workflowId", "replayed", "operation" ], "patternProperties": { "^(?!(?:runId|workflowId|replayed|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "workflowId", "replayed", "operation" ] } }, { "type": "object", "properties": { "runId": { "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" }, "status": { "type": "string", "enum": [ "queued", "running", "paused", "completed", "failed" ] }, "changed": { "type": "boolean" } }, "required": [ "runId", "status", "changed" ], "patternProperties": { "^(?!(?:runId|status|changed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "status", "changed" ] } }, { "type": "object", "properties": { "runId": { "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" }, "status": { "type": "string", "enum": [ "queued", "running", "paused", "completed", "failed" ] }, "resumedNodeIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 200 } }, "required": [ "runId", "status", "resumedNodeIds" ], "patternProperties": { "^(?!(?:runId|status|resumedNodeIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "status", "resumedNodeIds" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "runId": { "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" }, "workflowId": { "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" }, "replayed": { "type": "boolean" }, "operation": { "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" ] } } }, "required": [ "runId", "workflowId", "replayed", "operation" ], "patternProperties": { "^(?!(?:runId|workflowId|replayed|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "workflowId", "replayed", "operation" ] } }, { "type": "object", "properties": { "runId": { "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" }, "status": { "type": "string", "enum": [ "queued", "running", "paused", "completed", "failed" ] }, "changed": { "type": "boolean" } }, "required": [ "runId", "status", "changed" ], "patternProperties": { "^(?!(?:runId|status|changed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "status", "changed" ] } }, { "type": "object", "properties": { "runId": { "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" }, "status": { "type": "string", "enum": [ "queued", "running", "paused", "completed", "failed" ] }, "resumedNodeIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 128 }, "maxItems": 200 } }, "required": [ "runId", "status", "resumedNodeIds" ], "patternProperties": { "^(?!(?:runId|status|resumedNodeIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "status", "resumedNodeIds" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `workflows.enrollThread`: `POST /v1/workspaces/:workspaceId/workflows/:workflowId/enroll-thread` - `workflows.testRun`: `POST /v1/workspaces/:workspaceId/workflows/:workflowId/test` - `workflows.stopThreadRun`: `POST /v1/workspaces/:workspaceId/workflows/runs/:runId/stop` - `workflows.resumeRun`: `POST /v1/workspaces/:workspaceId/workflows/:workflowId/runs/:runId/resume` ## run_workspace_sql Run one read-only SELECT against the workspace's curated SQL views, or list those views, their columns, and the query limits. Use for ad-hoc reporting across campaigns, leads, inboxes, threads, and sends when no dedicated tool answers the question. Call without a query first to discover the views and columns, including current-address SEG detection/vendor/provenance on leads and frozen send-time attribution. Filter campaigns and SEG vendors with SQL; unknown detection is not confirmed no-SEG. Never for writes, catalog introspection, or other workspaces: only a single SELECT over the curated views is accepted, results are capped at 10,000 rows and 8 MiB, and the workspace must have the SQL feature enabled. Scopes: sql:query Risk: read; confirmation: none; idempotency: none. ### 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" }, "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "minLength": 0, "maxLength": 4096 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "maxItems": 32 }, "query": { "type": "string", "minLength": 1, "maxLength": 20000 } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|parameters|query)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "parameters", "query" ] } } ``` ### 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" }, "parameters": { "type": "array", "items": { "anyOf": [ { "type": "string", "minLength": 0, "maxLength": 4096 }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "maxItems": 32 }, "query": { "type": "string", "minLength": 1, "maxLength": 20000 } }, "required": [ "workspaceId" ], "patternProperties": { "^(?!(?:workspaceId|parameters|query)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "parameters", "query" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "SqlSchemaResult": { "type": "object", "properties": { "tables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": { "type": "string", "minLength": 0, "maxLength": 4096 }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": { "type": "string", "minLength": 0, "maxLength": 4096 } }, "required": [ "name", "type", "description" ], "patternProperties": { "^(?!(?:name|type|description)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type", "description" ] } } } }, "required": [ "name", "description", "columns" ], "patternProperties": { "^(?!(?:name|description|columns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "description", "columns" ] } } }, "limits": { "type": "object", "properties": { "statementTimeoutSeconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tempFileLimitMb": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxRows": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rateLimitPerSecond": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxConcurrentQueries": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "statementTimeoutSeconds", "tempFileLimitMb", "maxRows", "rateLimitPerSecond", "maxConcurrentQueries" ], "patternProperties": { "^(?!(?:statementTimeoutSeconds|tempFileLimitMb|maxRows|rateLimitPerSecond|maxConcurrentQueries)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "statementTimeoutSeconds", "tempFileLimitMb", "maxRows", "rateLimitPerSecond", "maxConcurrentQueries" ] } } }, "required": [ "tables", "limits" ], "patternProperties": { "^(?!(?:tables|limits)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "tables", "limits" ] } }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "SqlQueryResult": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128 }, "type": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 128 }, { "type": "null" } ] } }, "required": [ "name", "type" ], "patternProperties": { "^(?!(?:name|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "type" ] } } }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } }, "maxItems": 10000 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" }, "executionMs": { "type": "number", "minimum": 0 } }, "required": [ "columns", "rows", "rowCount", "truncated", "executionMs" ], "patternProperties": { "^(?!(?:columns|rows|rowCount|truncated|executionMs)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "columns", "rows", "rowCount", "truncated", "executionMs" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/SqlSchemaResult" }, { "$ref": "#/$defs/SqlQueryResult" } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "$ref": "#/$defs/SqlSchemaResult" }, { "$ref": "#/$defs/SqlQueryResult" } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `sql.query`: `POST /v1/workspaces/:workspaceId/sql/query` - `sql.schema`: `GET /v1/workspaces/:workspaceId/sql/schema` ## save_dashboard Create or replace a dashboard or saved query, including every widget, SQL, bound filter, chart mapping/format and grid layout. Create with a fresh dashboardId UUID and expectedRevision 0. Update with the last read revision; retry a lost response with the exact same dashboard ID and payload. The server derives mutation identities. Duplicate using a fresh dashboardId. Set document.kind to query for saved queries. On conflict reload and reconcile. Discover SQL columns and validate chart queries with run_workspace_sql before saving. Requires the Workspace SQL feature and the stated permission. This does not grant access to another Workspace or execute stored SQL automatically. Scopes: sql:manage_dashboards 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" }, "dashboardId": { "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" }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "document": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "kind": { "type": "string", "enum": [ "dashboard", "query" ] }, "name": { "type": "string", "maxLength": 160, "minLength": 1 }, "description": { "type": "string", "maxLength": 2000 }, "filters": { "type": "object", "properties": { "from": { "type": "string", "maxLength": 40 }, "to": { "type": "string", "maxLength": 40 }, "domain": { "type": "string", "maxLength": 253 }, "ip": { "type": "string", "maxLength": 64 }, "source": { "type": "string", "maxLength": 256 } }, "required": [ "from", "to", "domain", "ip", "source" ], "patternProperties": { "^(?!(?:from|to|domain|ip|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] } }, "widgets": { "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" }, "kind": { "type": "string", "enum": [ "chart", "text" ] }, "title": { "type": "string", "maxLength": 160 }, "text": { "type": "string", "maxLength": 4000 }, "query": { "type": "string", "maxLength": 20000 }, "bindings": { "type": "array", "items": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] }, "maxItems": 32 }, "chart": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "table", "number", "line", "area", "bar" ] }, "dimension": { "type": "string", "maxLength": 128 }, "measures": { "type": "array", "items": { "type": "string", "maxLength": 128 }, "maxItems": 8 }, "format": { "type": "string", "enum": [ "number", "percent", "currency", "duration", "bytes" ] }, "decimals": { "type": "integer", "minimum": 0, "maximum": 6 }, "label": { "type": "string", "maxLength": 128 } }, "required": [ "type", "dimension", "measures", "format", "decimals", "label" ], "patternProperties": { "^(?!(?:type|dimension|measures|format|decimals|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "dimension", "measures", "format", "decimals", "label" ] } }, "layout": { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 500 }, "w": { "type": "integer", "minimum": 2, "maximum": 12 }, "h": { "type": "integer", "minimum": 2, "maximum": 12 } }, "required": [ "x", "y", "w", "h" ], "patternProperties": { "^(?!(?:x|y|w|h)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y", "w", "h" ] } } }, "required": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ], "patternProperties": { "^(?!(?:id|kind|title|text|query|bindings|chart|layout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ] } }, "maxItems": 30 } }, "required": [ "version", "kind", "name", "description", "filters", "widgets" ], "patternProperties": { "^(?!(?:version|kind|name|description|filters|widgets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "kind", "name", "description", "filters", "widgets" ] } } }, "required": [ "workspaceId", "dashboardId", "expectedRevision", "document" ], "patternProperties": { "^(?!(?:workspaceId|dashboardId|expectedRevision|document)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "dashboardId", "expectedRevision", "document" ] } } ``` ### 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" }, "dashboardId": { "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" }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "document": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "kind": { "type": "string", "enum": [ "dashboard", "query" ] }, "name": { "type": "string", "maxLength": 160, "minLength": 1 }, "description": { "type": "string", "maxLength": 2000 }, "filters": { "type": "object", "properties": { "from": { "type": "string", "maxLength": 40 }, "to": { "type": "string", "maxLength": 40 }, "domain": { "type": "string", "maxLength": 253 }, "ip": { "type": "string", "maxLength": 64 }, "source": { "type": "string", "maxLength": 256 } }, "required": [ "from", "to", "domain", "ip", "source" ], "patternProperties": { "^(?!(?:from|to|domain|ip|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] } }, "widgets": { "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" }, "kind": { "type": "string", "enum": [ "chart", "text" ] }, "title": { "type": "string", "maxLength": 160 }, "text": { "type": "string", "maxLength": 4000 }, "query": { "type": "string", "maxLength": 20000 }, "bindings": { "type": "array", "items": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] }, "maxItems": 32 }, "chart": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "table", "number", "line", "area", "bar" ] }, "dimension": { "type": "string", "maxLength": 128 }, "measures": { "type": "array", "items": { "type": "string", "maxLength": 128 }, "maxItems": 8 }, "format": { "type": "string", "enum": [ "number", "percent", "currency", "duration", "bytes" ] }, "decimals": { "type": "integer", "minimum": 0, "maximum": 6 }, "label": { "type": "string", "maxLength": 128 } }, "required": [ "type", "dimension", "measures", "format", "decimals", "label" ], "patternProperties": { "^(?!(?:type|dimension|measures|format|decimals|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "dimension", "measures", "format", "decimals", "label" ] } }, "layout": { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 500 }, "w": { "type": "integer", "minimum": 2, "maximum": 12 }, "h": { "type": "integer", "minimum": 2, "maximum": 12 } }, "required": [ "x", "y", "w", "h" ], "patternProperties": { "^(?!(?:x|y|w|h)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y", "w", "h" ] } } }, "required": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ], "patternProperties": { "^(?!(?:id|kind|title|text|query|bindings|chart|layout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ] } }, "maxItems": 30 } }, "required": [ "version", "kind", "name", "description", "filters", "widgets" ], "patternProperties": { "^(?!(?:version|kind|name|description|filters|widgets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "kind", "name", "description", "filters", "widgets" ] } } }, "required": [ "workspaceId", "dashboardId", "expectedRevision", "document" ], "patternProperties": { "^(?!(?:workspaceId|dashboardId|expectedRevision|document)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "dashboardId", "expectedRevision", "document" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "ownerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedAt": { "type": "string" }, "document": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "kind": { "type": "string", "enum": [ "dashboard", "query" ] }, "name": { "type": "string", "maxLength": 160, "minLength": 1 }, "description": { "type": "string", "maxLength": 2000 }, "filters": { "type": "object", "properties": { "from": { "type": "string", "maxLength": 40 }, "to": { "type": "string", "maxLength": 40 }, "domain": { "type": "string", "maxLength": 253 }, "ip": { "type": "string", "maxLength": 64 }, "source": { "type": "string", "maxLength": 256 } }, "required": [ "from", "to", "domain", "ip", "source" ], "patternProperties": { "^(?!(?:from|to|domain|ip|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] } }, "widgets": { "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" }, "kind": { "type": "string", "enum": [ "chart", "text" ] }, "title": { "type": "string", "maxLength": 160 }, "text": { "type": "string", "maxLength": 4000 }, "query": { "type": "string", "maxLength": 20000 }, "bindings": { "type": "array", "items": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] }, "maxItems": 32 }, "chart": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "table", "number", "line", "area", "bar" ] }, "dimension": { "type": "string", "maxLength": 128 }, "measures": { "type": "array", "items": { "type": "string", "maxLength": 128 }, "maxItems": 8 }, "format": { "type": "string", "enum": [ "number", "percent", "currency", "duration", "bytes" ] }, "decimals": { "type": "integer", "minimum": 0, "maximum": 6 }, "label": { "type": "string", "maxLength": 128 } }, "required": [ "type", "dimension", "measures", "format", "decimals", "label" ], "patternProperties": { "^(?!(?:type|dimension|measures|format|decimals|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "dimension", "measures", "format", "decimals", "label" ] } }, "layout": { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 500 }, "w": { "type": "integer", "minimum": 2, "maximum": 12 }, "h": { "type": "integer", "minimum": 2, "maximum": 12 } }, "required": [ "x", "y", "w", "h" ], "patternProperties": { "^(?!(?:x|y|w|h)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y", "w", "h" ] } } }, "required": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ], "patternProperties": { "^(?!(?:id|kind|title|text|query|bindings|chart|layout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ] } }, "maxItems": 30 } }, "required": [ "version", "kind", "name", "description", "filters", "widgets" ], "patternProperties": { "^(?!(?:version|kind|name|description|filters|widgets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "kind", "name", "description", "filters", "widgets" ] } } }, "required": [ "id", "workspaceId", "ownerId", "revision", "updatedAt", "document" ], "patternProperties": { "^(?!(?:id|workspaceId|ownerId|revision|updatedAt|document)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "ownerId", "revision", "updatedAt", "document" ] } } ``` ### Underlying API operations - `dashboards.save`: `PUT /v1/workspaces/:workspaceId/dashboards/:dashboardId` ## save_organization_dashboard Create or replace a dashboard or saved query, including every widget, SQL, bound filter, chart mapping/format and grid layout. Create with a fresh dashboardId UUID and expectedRevision 0. Update with the last read revision; retry a lost response with the exact same dashboard ID and payload. The server derives mutation identities. Duplicate using a fresh dashboardId. Set document.kind to query for saved queries. On conflict reload and reconcile. Discover SQL columns and validate chart queries with run_organization_sql before saving. Requires the stated Organization analytics permission. Reading a document never executes its SQL; saving validates every selected child, and execution always requires live child SQL access and feature eligibility. Scopes: orgAnalytics:manage Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "organizationId": { "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" }, "dashboardId": { "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" }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "document": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "kind": { "type": "string", "enum": [ "dashboard", "query" ] }, "name": { "type": "string", "maxLength": 160, "minLength": 1 }, "description": { "type": "string", "maxLength": 2000 }, "filters": { "type": "object", "properties": { "from": { "type": "string", "maxLength": 40 }, "to": { "type": "string", "maxLength": 40 }, "domain": { "type": "string", "maxLength": 253 }, "ip": { "type": "string", "maxLength": 64 }, "source": { "type": "string", "maxLength": 256 } }, "required": [ "from", "to", "domain", "ip", "source" ], "patternProperties": { "^(?!(?:from|to|domain|ip|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] } }, "widgets": { "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" }, "kind": { "type": "string", "enum": [ "chart", "text" ] }, "title": { "type": "string", "maxLength": 160 }, "text": { "type": "string", "maxLength": 4000 }, "query": { "type": "string", "maxLength": 20000 }, "bindings": { "type": "array", "items": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] }, "maxItems": 32 }, "chart": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "table", "number", "line", "area", "bar" ] }, "dimension": { "type": "string", "maxLength": 128 }, "measures": { "type": "array", "items": { "type": "string", "maxLength": 128 }, "maxItems": 8 }, "format": { "type": "string", "enum": [ "number", "percent", "currency", "duration", "bytes" ] }, "decimals": { "type": "integer", "minimum": 0, "maximum": 6 }, "label": { "type": "string", "maxLength": 128 } }, "required": [ "type", "dimension", "measures", "format", "decimals", "label" ], "patternProperties": { "^(?!(?:type|dimension|measures|format|decimals|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "dimension", "measures", "format", "decimals", "label" ] } }, "layout": { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 500 }, "w": { "type": "integer", "minimum": 2, "maximum": 12 }, "h": { "type": "integer", "minimum": 2, "maximum": 12 } }, "required": [ "x", "y", "w", "h" ], "patternProperties": { "^(?!(?:x|y|w|h)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y", "w", "h" ] } } }, "required": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ], "patternProperties": { "^(?!(?:id|kind|title|text|query|bindings|chart|layout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ] } }, "maxItems": 30 } }, "required": [ "version", "kind", "name", "description", "filters", "widgets" ], "patternProperties": { "^(?!(?:version|kind|name|description|filters|widgets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "kind", "name", "description", "filters", "widgets" ] } }, "workspaceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, { "type": "null" } ] } }, "required": [ "organizationId", "dashboardId", "expectedRevision", "document", "workspaceIds" ], "patternProperties": { "^(?!(?:organizationId|dashboardId|expectedRevision|document|workspaceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "dashboardId", "expectedRevision", "document", "workspaceIds" ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "organizationId": { "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" }, "dashboardId": { "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" }, "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "document": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "kind": { "type": "string", "enum": [ "dashboard", "query" ] }, "name": { "type": "string", "maxLength": 160, "minLength": 1 }, "description": { "type": "string", "maxLength": 2000 }, "filters": { "type": "object", "properties": { "from": { "type": "string", "maxLength": 40 }, "to": { "type": "string", "maxLength": 40 }, "domain": { "type": "string", "maxLength": 253 }, "ip": { "type": "string", "maxLength": 64 }, "source": { "type": "string", "maxLength": 256 } }, "required": [ "from", "to", "domain", "ip", "source" ], "patternProperties": { "^(?!(?:from|to|domain|ip|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] } }, "widgets": { "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" }, "kind": { "type": "string", "enum": [ "chart", "text" ] }, "title": { "type": "string", "maxLength": 160 }, "text": { "type": "string", "maxLength": 4000 }, "query": { "type": "string", "maxLength": 20000 }, "bindings": { "type": "array", "items": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] }, "maxItems": 32 }, "chart": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "table", "number", "line", "area", "bar" ] }, "dimension": { "type": "string", "maxLength": 128 }, "measures": { "type": "array", "items": { "type": "string", "maxLength": 128 }, "maxItems": 8 }, "format": { "type": "string", "enum": [ "number", "percent", "currency", "duration", "bytes" ] }, "decimals": { "type": "integer", "minimum": 0, "maximum": 6 }, "label": { "type": "string", "maxLength": 128 } }, "required": [ "type", "dimension", "measures", "format", "decimals", "label" ], "patternProperties": { "^(?!(?:type|dimension|measures|format|decimals|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "dimension", "measures", "format", "decimals", "label" ] } }, "layout": { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 500 }, "w": { "type": "integer", "minimum": 2, "maximum": 12 }, "h": { "type": "integer", "minimum": 2, "maximum": 12 } }, "required": [ "x", "y", "w", "h" ], "patternProperties": { "^(?!(?:x|y|w|h)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y", "w", "h" ] } } }, "required": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ], "patternProperties": { "^(?!(?:id|kind|title|text|query|bindings|chart|layout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ] } }, "maxItems": 30 } }, "required": [ "version", "kind", "name", "description", "filters", "widgets" ], "patternProperties": { "^(?!(?:version|kind|name|description|filters|widgets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "kind", "name", "description", "filters", "widgets" ] } }, "workspaceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, { "type": "null" } ] } }, "required": [ "organizationId", "dashboardId", "expectedRevision", "document", "workspaceIds" ], "patternProperties": { "^(?!(?:organizationId|dashboardId|expectedRevision|document|workspaceIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "dashboardId", "expectedRevision", "document", "workspaceIds" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "organizationId": { "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" }, "workspaceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, { "type": "null" } ] }, "ownerId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "updatedAt": { "type": "string" }, "document": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "kind": { "type": "string", "enum": [ "dashboard", "query" ] }, "name": { "type": "string", "maxLength": 160, "minLength": 1 }, "description": { "type": "string", "maxLength": 2000 }, "filters": { "type": "object", "properties": { "from": { "type": "string", "maxLength": 40 }, "to": { "type": "string", "maxLength": 40 }, "domain": { "type": "string", "maxLength": 253 }, "ip": { "type": "string", "maxLength": 64 }, "source": { "type": "string", "maxLength": 256 } }, "required": [ "from", "to", "domain", "ip", "source" ], "patternProperties": { "^(?!(?:from|to|domain|ip|source)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] } }, "widgets": { "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" }, "kind": { "type": "string", "enum": [ "chart", "text" ] }, "title": { "type": "string", "maxLength": 160 }, "text": { "type": "string", "maxLength": 4000 }, "query": { "type": "string", "maxLength": 20000 }, "bindings": { "type": "array", "items": { "type": "string", "enum": [ "from", "to", "domain", "ip", "source" ] }, "maxItems": 32 }, "chart": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "table", "number", "line", "area", "bar" ] }, "dimension": { "type": "string", "maxLength": 128 }, "measures": { "type": "array", "items": { "type": "string", "maxLength": 128 }, "maxItems": 8 }, "format": { "type": "string", "enum": [ "number", "percent", "currency", "duration", "bytes" ] }, "decimals": { "type": "integer", "minimum": 0, "maximum": 6 }, "label": { "type": "string", "maxLength": 128 } }, "required": [ "type", "dimension", "measures", "format", "decimals", "label" ], "patternProperties": { "^(?!(?:type|dimension|measures|format|decimals|label)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "dimension", "measures", "format", "decimals", "label" ] } }, "layout": { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 500 }, "w": { "type": "integer", "minimum": 2, "maximum": 12 }, "h": { "type": "integer", "minimum": 2, "maximum": 12 } }, "required": [ "x", "y", "w", "h" ], "patternProperties": { "^(?!(?:x|y|w|h)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "x", "y", "w", "h" ] } } }, "required": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ], "patternProperties": { "^(?!(?:id|kind|title|text|query|bindings|chart|layout)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "kind", "title", "text", "query", "bindings", "chart", "layout" ] } }, "maxItems": 30 } }, "required": [ "version", "kind", "name", "description", "filters", "widgets" ], "patternProperties": { "^(?!(?:version|kind|name|description|filters|widgets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "version", "kind", "name", "description", "filters", "widgets" ] } } }, "required": [ "id", "organizationId", "workspaceIds", "ownerId", "revision", "updatedAt", "document" ], "patternProperties": { "^(?!(?:id|organizationId|workspaceIds|ownerId|revision|updatedAt|document)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "organizationId", "workspaceIds", "ownerId", "revision", "updatedAt", "document" ] } } ``` ### Underlying API operations - `organizationDashboards.save`: `PUT /v1/organizations/:organizationId/dashboards/:dashboardId` ## select_workspace Persist or resolve the caller's selected workspace (a navigation preference, not a grant). Use to activate, restore, or resolve the workspace a member is working in. Selection never grants membership; it only persists the caller's own preference. Scopes: workspace:read Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "activate" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "ensure" ] } ] } }, "required": [ "action" ], "patternProperties": { "^(?!(?:action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action" ] } ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "restore" ] } ] }, "expectedCurrentWorkspaceId": { "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" }, "previousWorkspaceId": { "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" } ] } }, "required": [ "action", "expectedCurrentWorkspaceId", "previousWorkspaceId" ], "patternProperties": { "^(?!(?:action|expectedCurrentWorkspaceId|previousWorkspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "expectedCurrentWorkspaceId", "previousWorkspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resolveLegacyRoute" ] } ] }, "path": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "action", "path" ], "patternProperties": { "^(?!(?:action|path)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "path" ] } } ], "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "SelectWorkspaceInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "activate" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "ensure" ] } ] } }, "required": [ "action" ], "patternProperties": { "^(?!(?:action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action" ] } ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "restore" ] } ] }, "expectedCurrentWorkspaceId": { "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" }, "previousWorkspaceId": { "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" } ] } }, "required": [ "action", "expectedCurrentWorkspaceId", "previousWorkspaceId" ], "patternProperties": { "^(?!(?:action|expectedCurrentWorkspaceId|previousWorkspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "expectedCurrentWorkspaceId", "previousWorkspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resolveLegacyRoute" ] } ] }, "path": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "action", "path" ], "patternProperties": { "^(?!(?:action|path)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "path" ] } } ] } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "activate" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "ensure" ] } ] } }, "required": [ "action" ], "patternProperties": { "^(?!(?:action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action" ] } ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "restore" ] } ] }, "expectedCurrentWorkspaceId": { "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" }, "previousWorkspaceId": { "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" } ] } }, "required": [ "action", "expectedCurrentWorkspaceId", "previousWorkspaceId" ], "patternProperties": { "^(?!(?:action|expectedCurrentWorkspaceId|previousWorkspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "expectedCurrentWorkspaceId", "previousWorkspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resolveLegacyRoute" ] } ] }, "path": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "action", "path" ], "patternProperties": { "^(?!(?:action|path)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "path" ] } } ], "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "SelectWorkspaceInput": { "anyOf": [ { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "activate" ] } ] }, "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" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "ensure" ] } ] } }, "required": [ "action" ], "patternProperties": { "^(?!(?:action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action" ] } ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "restore" ] } ] }, "expectedCurrentWorkspaceId": { "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" }, "previousWorkspaceId": { "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" } ] } }, "required": [ "action", "expectedCurrentWorkspaceId", "previousWorkspaceId" ], "patternProperties": { "^(?!(?:action|expectedCurrentWorkspaceId|previousWorkspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "expectedCurrentWorkspaceId", "previousWorkspaceId" ] } }, { "type": "object", "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "resolveLegacyRoute" ] } ] }, "path": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "action", "path" ], "patternProperties": { "^(?!(?:action|path)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "path" ] } } ] } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "SelectWorkspaceOutput": { "anyOf": [ { "type": "object", "properties": { "organizationId": { "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" }, "previousOrganizationId": { "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" } ] } }, "required": [ "organizationId", "previousOrganizationId" ], "patternProperties": { "^(?!(?:organizationId|previousOrganizationId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "organizationId", "previousOrganizationId" ] } }, { "type": "object", "properties": { "restored": { "type": "boolean" } }, "required": [ "restored" ], "patternProperties": { "^(?!(?:restored)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "restored" ] } ] } }, { "type": "object", "properties": { "slug": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "slug" ], "patternProperties": { "^(?!(?:slug)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "slug" ] } ] } } ] } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/SelectWorkspaceOutput" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/SelectWorkspaceOutput" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `me.activateWorkspace`: `POST /v1/me/active-workspace` - `me.ensureActiveWorkspace`: `POST /v1/me/active-workspace/ensure` - `me.restoreActiveWorkspace`: `POST /v1/me/active-workspace/restore` - `me.resolveLegacyRoute`: `POST /v1/me/legacy-route` ## send_test_email Sends a real test email from an inbox, optionally through a campaign, or a warmup test send. When asked to send a test email to verify inbox configuration or warmup. For campaign sends to leads — that is a campaign launch. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: inbox:update, inbox:warmup_manage Risk: costly; confirmation: explicit; 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": [ "send" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "payload": { "type": "object", "properties": { "to": { "$ref": "#/$defs/EmailAddress" }, "campaignId": { "$ref": "#/$defs/ShortText" }, "subject": { "type": "string", "maxLength": 10000 }, "body": { "type": "string", "maxLength": 1000000 }, "bodyContentType": { "type": "string", "enum": [ "html", "plain" ] } }, "required": [ "to" ], "patternProperties": { "^(?!(?:to|campaignId|subject|body|bodyContentType)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "to", "campaignId", "subject", "body", "bodyContentType" ] } } }, "required": [ "workspaceId", "action", "inboxId", "payload" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "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": [ "warmup_send" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "payload": { "type": "object", "properties": { "to": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "to" ], "patternProperties": { "^(?!(?:to)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "to" ] } ] } } }, "required": [ "workspaceId", "action", "inboxId", "payload" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "payload" ] } } ], "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "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": [ "send" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "payload": { "type": "object", "properties": { "to": { "$ref": "#/$defs/EmailAddress" }, "campaignId": { "$ref": "#/$defs/ShortText" }, "subject": { "type": "string", "maxLength": 10000 }, "body": { "type": "string", "maxLength": 1000000 }, "bodyContentType": { "type": "string", "enum": [ "html", "plain" ] } }, "required": [ "to" ], "patternProperties": { "^(?!(?:to|campaignId|subject|body|bodyContentType)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "to", "campaignId", "subject", "body", "bodyContentType" ] } } }, "required": [ "workspaceId", "action", "inboxId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "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": [ "warmup_send" ] }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "payload": { "type": "object", "properties": { "to": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "to" ], "patternProperties": { "^(?!(?:to)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "to" ] } ] } } }, "required": [ "workspaceId", "action", "inboxId", "payload" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "payload" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "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]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "messageId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "threadId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "success", "messageId", "threadId" ], "patternProperties": { "^(?!(?:success|messageId|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "messageId", "threadId" ] } }, { "type": "object", "properties": { "runId": { "$ref": "#/$defs/OpaqueId" }, "requestId": { "$ref": "#/$defs/OpaqueId" }, "operation": { "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" ] } } }, "required": [ "runId", "requestId", "operation" ], "patternProperties": { "^(?!(?:runId|requestId|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "requestId", "operation" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "enum": [ true ] }, "messageId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "threadId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "success", "messageId", "threadId" ], "patternProperties": { "^(?!(?:success|messageId|threadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "success", "messageId", "threadId" ] } }, { "type": "object", "properties": { "runId": { "$ref": "#/$defs/OpaqueId" }, "requestId": { "$ref": "#/$defs/OpaqueId" }, "operation": { "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" ] } } }, "required": [ "runId", "requestId", "operation" ], "patternProperties": { "^(?!(?:runId|requestId|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "requestId", "operation" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `inboxes.sendTestEmail`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/test-email` - `inboxWarmupSettings.sendTest`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/warmup-settings/test` ## send_unibox_reply Commit a reply from a connected mailbox into an existing conversation using a preview confirmation token. The server derives the send replay key. Use only after previewing. The preview names the exact addresses the message will reach, and the token binds them — the commit cannot widen that set. This is real mail to a real person and cannot be recalled. It is a paid action, it is refused on a frozen subscription, and the server deduplicates retries of the same confirmed send. Use the native preview first and pass its confirmation token unchanged to commit. A token does not bypass current permissions or Workspace checks. Scopes: unibox:reply Risk: costly; confirmation: preview_token; idempotency: required. ### 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" }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "workspaceId", "messageId", "confirmationToken" ], "patternProperties": { "^(?!(?:workspaceId|messageId|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "messageId", "confirmationToken" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### 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" }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "confirmationToken": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "workspaceId", "messageId", "confirmationToken" ], "patternProperties": { "^(?!(?:workspaceId|messageId|confirmationToken)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "messageId", "confirmationToken" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "threadId": { "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" }, "messageId": { "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" } ] }, "providerMessageId": { "$ref": "#/$defs/OpaqueId" }, "providerThreadId": { "$ref": "#/$defs/OpaqueId" }, "sentAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "threadId", "messageId", "providerMessageId", "providerThreadId", "sentAt" ], "patternProperties": { "^(?!(?:threadId|messageId|providerMessageId|providerThreadId|sentAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "messageId", "providerMessageId", "providerThreadId", "sentAt" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `uniboxMessages.previewReply`: `POST /v1/workspaces/:workspaceId/unibox/messages/:messageId/reply-preview` - `uniboxMessages.commitReply`: `POST /v1/workspaces/:workspaceId/unibox/messages/:messageId/reply` ## set_booking_default_event_type Choose which event type the availability helper draws free slots from. Use after list_booking_event_types, passing that call's `connectionId` so a replaced connection conflicts. Do not reuse a stale connection id from an earlier session; refresh the event types first. Scopes: integration:update Risk: write; confirmation: none; idempotency: required. ### 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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "input": { "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" }, "eventTypeRef": { "$ref": "#/$defs/OpaqueId" }, "eventTypeName": { "$ref": "#/$defs/ShortText" }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0 }, "schedulingUrl": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "connectionId", "eventTypeRef", "eventTypeName" ], "patternProperties": { "^(?!(?:connectionId|eventTypeRef|eventTypeName|durationMinutes|schedulingUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connectionId", "eventTypeRef", "eventTypeName", "durationMinutes", "schedulingUrl" ] } } }, "required": [ "workspaceId", "provider", "input" ], "patternProperties": { "^(?!(?:workspaceId|provider|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider", "input" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "input": { "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" }, "eventTypeRef": { "$ref": "#/$defs/OpaqueId" }, "eventTypeName": { "$ref": "#/$defs/ShortText" }, "durationMinutes": { "type": "integer", "exclusiveMinimum": 0 }, "schedulingUrl": { "$ref": "#/$defs/HttpUrl" } }, "required": [ "connectionId", "eventTypeRef", "eventTypeName" ], "patternProperties": { "^(?!(?:connectionId|eventTypeRef|eventTypeName|durationMinutes|schedulingUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connectionId", "eventTypeRef", "eventTypeName", "durationMinutes", "schedulingUrl" ] } } }, "required": [ "workspaceId", "provider", "input" ], "patternProperties": { "^(?!(?:workspaceId|provider|input)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider", "input" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] }, "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" }, "eventTypeRef": { "$ref": "#/$defs/OpaqueId" }, "eventTypeName": { "$ref": "#/$defs/ShortText" }, "durationMinutes": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "schedulingUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "provider", "connectionId", "eventTypeRef", "eventTypeName", "durationMinutes", "schedulingUrl", "updatedAt" ], "patternProperties": { "^(?!(?:provider|connectionId|eventTypeRef|eventTypeName|durationMinutes|schedulingUrl|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "provider", "connectionId", "eventTypeRef", "eventTypeName", "durationMinutes", "schedulingUrl", "updatedAt" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "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$" } } } ``` ### Underlying API operations - `booking.eventTypes.setDefaultEventType`: `PUT /v1/workspaces/:workspaceId/booking/:provider/default-event-type` ## set_domain_auto_renew Turn Scheduler Zero's yearly renewal of a domain on or off. Use when a person asks to keep or let go of a domain at its next expiry; confirm first, because turning renewal on commits a future charge. Turning renewal off lets the domain lapse at expiry; it does not transfer or cancel anything now. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: domain:purchase Risk: costly; confirmation: explicit; 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" }, "domainId": { "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": { "type": "object", "properties": { "autoRenew": { "type": "boolean" } }, "required": [ "autoRenew" ], "patternProperties": { "^(?!(?:autoRenew)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "autoRenew" ] } ] } } }, "required": [ "workspaceId", "domainId", "request" ], "patternProperties": { "^(?!(?:workspaceId|domainId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "domainId", "request" ] } } ``` ### 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" }, "domainId": { "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": { "type": "object", "properties": { "autoRenew": { "type": "boolean" } }, "required": [ "autoRenew" ], "patternProperties": { "^(?!(?:autoRenew)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "autoRenew" ] } ] } } }, "required": [ "workspaceId", "domainId", "request" ], "patternProperties": { "^(?!(?:workspaceId|domainId|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "domainId", "request" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "autoRenew": { "type": "boolean" } }, "required": [ "autoRenew" ], "patternProperties": { "^(?!(?:autoRenew)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "autoRenew" ] } ] } } ``` ### Underlying API operations - `domains.setAutoRenew`: `POST /v1/workspaces/:workspaceId/domains/:domainId/auto-renew` ## set_my_developer_mode Set account-wide Developer mode to show or hide realtime connection diagnostics. Use your own human session, full-account personal API key or consented interactive MCP connection. The setting persists across devices and sign-ins. Cannot target another user, use restricted keys or non-interactive agents, or enable/disable realtime transport. Scopes: workspace:read Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "developerModeEnabled": { "type": "boolean" } }, "required": [ "developerModeEnabled" ], "patternProperties": { "^(?!(?:developerModeEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "developerModeEnabled" ] } ] } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "developerModeEnabled": { "type": "boolean" } }, "required": [ "developerModeEnabled" ], "patternProperties": { "^(?!(?:developerModeEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "developerModeEnabled" ] } ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "developerModeEnabled": { "type": "boolean" } }, "required": [ "developerModeEnabled" ], "patternProperties": { "^(?!(?:developerModeEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "developerModeEnabled" ] } ] } } ``` ### Underlying API operations - `developerMode.update`: `PATCH /v1/me/developer-mode` ## set_permission_request_policy Turn permission requests on or off for a workspace. Off stops new requests; pending ones stay reviewable. Use when a workspace admin asks to stop (or allow again) members requesting more permissions. It does not change anyone's permissions or decide pending requests. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: workspaceMember:update Risk: write; confirmation: explicit; 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" }, "requestsEnabled": { "type": "boolean" } }, "required": [ "workspaceId", "requestsEnabled" ], "patternProperties": { "^(?!(?:workspaceId|requestsEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "requestsEnabled" ] } } ``` ### 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" }, "requestsEnabled": { "type": "boolean" } }, "required": [ "workspaceId", "requestsEnabled" ], "patternProperties": { "^(?!(?:workspaceId|requestsEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "requestsEnabled" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "PermissionRequestPolicy": { "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" }, "requestsEnabled": { "type": "boolean" } }, "required": [ "workspaceId", "requestsEnabled" ], "patternProperties": { "^(?!(?:workspaceId|requestsEnabled)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "requestsEnabled" ] } } }, "type": "object", "anyOf": [ { "allOf": [ { "$ref": "#/$defs/PermissionRequestPolicy" }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/$defs/PermissionRequestPolicy" }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `permissionRequests.updatePolicy`: `PUT /v1/workspaces/:workspaceId/permission-requests/policy` ## share_call_recordings Publish a recorded call outside the workspace under a capability link, read whether one is already published, and revoke it. Use when a specific recorded conversation has to reach someone who cannot sign in — a coach, a customer, a reviewer — and the person asking has decided that is appropriate. A share link is a standing grant to listen to a real customer conversation, and revoking it cannot un-hear it. Masking the prospect's voice reduces casual recognition; it is not anonymization, and the transcript still carries every word. Never create one speculatively, never create one to work around a missing permission, and always confirm with a person first. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: dialer:update Risk: destructive; confirmation: explicit; 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" }, "callId": { "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": [ "read", "create", "revoke" ] }, "create": { "type": "object", "properties": { "access": { "type": "string", "enum": [ "workspace", "anyone_with_link" ] }, "privacy": { "type": "string", "enum": [ "show_all", "hide_lead", "hide_rep", "hide_both" ] }, "audioPrivacy": { "type": "string", "enum": [ "original", "mask_prospect" ] } }, "required": [ "access", "privacy", "audioPrivacy" ], "patternProperties": { "^(?!(?:access|privacy|audioPrivacy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "access", "privacy", "audioPrivacy" ] } } }, "required": [ "workspaceId", "callId", "action" ], "patternProperties": { "^(?!(?:workspaceId|callId|action|create)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "callId", "action", "create" ] } } ``` ### 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" }, "callId": { "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": [ "read", "create", "revoke" ] }, "create": { "type": "object", "properties": { "access": { "type": "string", "enum": [ "workspace", "anyone_with_link" ] }, "privacy": { "type": "string", "enum": [ "show_all", "hide_lead", "hide_rep", "hide_both" ] }, "audioPrivacy": { "type": "string", "enum": [ "original", "mask_prospect" ] } }, "required": [ "access", "privacy", "audioPrivacy" ], "patternProperties": { "^(?!(?:access|privacy|audioPrivacy)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "access", "privacy", "audioPrivacy" ] } } }, "required": [ "workspaceId", "callId", "action" ], "patternProperties": { "^(?!(?:workspaceId|callId|action|create)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "callId", "action", "create" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "RecordingShareToken": { "type": "string", "pattern": "^[A-Za-z0-9_-]{32}$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "share": { "anyOf": [ { "type": "object", "properties": { "token": { "$ref": "#/$defs/RecordingShareToken" }, "callId": { "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" }, "access": { "type": "string", "enum": [ "workspace", "anyone_with_link" ] }, "privacy": { "type": "string", "enum": [ "show_all", "hide_lead", "hide_rep", "hide_both" ] }, "audioPrivacy": { "type": "string", "enum": [ "original", "mask_prospect" ] }, "audioStatus": { "type": "string", "enum": [ "ready", "processing", "failed" ] } }, "required": [ "token", "callId", "access", "privacy", "audioPrivacy", "audioStatus" ], "patternProperties": { "^(?!(?:token|callId|access|privacy|audioPrivacy|audioStatus)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "token", "callId", "access", "privacy", "audioPrivacy", "audioStatus" ] } }, { "type": "null" } ] } }, "required": [ "share" ], "patternProperties": { "^(?!(?:share)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "share" ] } ] } }, { "type": "object", "properties": { "token": { "$ref": "#/$defs/RecordingShareToken" }, "callId": { "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" }, "access": { "type": "string", "enum": [ "workspace", "anyone_with_link" ] }, "privacy": { "type": "string", "enum": [ "show_all", "hide_lead", "hide_rep", "hide_both" ] }, "audioPrivacy": { "type": "string", "enum": [ "original", "mask_prospect" ] }, "audioStatus": { "type": "string", "enum": [ "ready", "processing", "failed" ] } }, "required": [ "token", "callId", "access", "privacy", "audioPrivacy", "audioStatus" ], "patternProperties": { "^(?!(?:token|callId|access|privacy|audioPrivacy|audioStatus)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "token", "callId", "access", "privacy", "audioPrivacy", "audioStatus" ] } }, { "type": "object", "properties": { "callId": { "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" }, "revokedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "callId", "revokedAt" ], "patternProperties": { "^(?!(?:callId|revokedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "callId", "revokedAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "share": { "anyOf": [ { "type": "object", "properties": { "token": { "$ref": "#/$defs/RecordingShareToken" }, "callId": { "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" }, "access": { "type": "string", "enum": [ "workspace", "anyone_with_link" ] }, "privacy": { "type": "string", "enum": [ "show_all", "hide_lead", "hide_rep", "hide_both" ] }, "audioPrivacy": { "type": "string", "enum": [ "original", "mask_prospect" ] }, "audioStatus": { "type": "string", "enum": [ "ready", "processing", "failed" ] } }, "required": [ "token", "callId", "access", "privacy", "audioPrivacy", "audioStatus" ], "patternProperties": { "^(?!(?:token|callId|access|privacy|audioPrivacy|audioStatus)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "token", "callId", "access", "privacy", "audioPrivacy", "audioStatus" ] } }, { "type": "null" } ] } }, "required": [ "share" ], "patternProperties": { "^(?!(?:share)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "share" ] } ] } }, { "type": "object", "properties": { "token": { "$ref": "#/$defs/RecordingShareToken" }, "callId": { "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" }, "access": { "type": "string", "enum": [ "workspace", "anyone_with_link" ] }, "privacy": { "type": "string", "enum": [ "show_all", "hide_lead", "hide_rep", "hide_both" ] }, "audioPrivacy": { "type": "string", "enum": [ "original", "mask_prospect" ] }, "audioStatus": { "type": "string", "enum": [ "ready", "processing", "failed" ] } }, "required": [ "token", "callId", "access", "privacy", "audioPrivacy", "audioStatus" ], "patternProperties": { "^(?!(?:token|callId|access|privacy|audioPrivacy|audioStatus)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "token", "callId", "access", "privacy", "audioPrivacy", "audioStatus" ] } }, { "type": "object", "properties": { "callId": { "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" }, "revokedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "callId", "revokedAt" ], "patternProperties": { "^(?!(?:callId|revokedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "callId", "revokedAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `dialerRecordings.shareState`: `GET /v1/workspaces/:workspaceId/dialer/calls/:callId/recording-share` - `dialerRecordings.createShare`: `POST /v1/workspaces/:workspaceId/dialer/calls/:callId/recording-share` - `dialerRecordings.revokeShare`: `DELETE /v1/workspaces/:workspaceId/dialer/calls/:callId/recording-share` ## share_integration_connection Share one of this workspace's connections with selected sibling workspaces; each gets a native connection using the same secret. Use when other workspaces in the organization should use this connection. Set includeFutureWorkspaces only when workspaces created later should join automatically. Never use to move a connection between organizations. Workspaces that already have their own connection of this provider are reported as failed, not overwritten. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:create Risk: write; confirmation: explicit; 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" }, "adapter": { "$ref": "#/$defs/IntegrationShareAdapter" }, "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" }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 }, "includeFutureWorkspaces": { "type": "boolean" } }, "required": [ "workspaceId", "adapter", "connectionId", "workspaceIds" ], "patternProperties": { "^(?!(?:workspaceId|adapter|connectionId|workspaceIds|includeFutureWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "adapter", "connectionId", "workspaceIds", "includeFutureWorkspaces" ] }, "$defs": { "IntegrationShareAdapter": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer", "heyreach", "getleads", "plusvibe", "calendly", "cal_com", "attio", "email_verifier", "phone_verifier", "warmup_provider", "mcp_server", "app_connection" ] } } } ``` ### 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" }, "adapter": { "$ref": "#/$defs/IntegrationShareAdapter" }, "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" }, "workspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 }, "includeFutureWorkspaces": { "type": "boolean" } }, "required": [ "workspaceId", "adapter", "connectionId", "workspaceIds" ], "patternProperties": { "^(?!(?:workspaceId|adapter|connectionId|workspaceIds|includeFutureWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "adapter", "connectionId", "workspaceIds", "includeFutureWorkspaces" ] }, "$defs": { "IntegrationShareAdapter": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer", "heyreach", "getleads", "plusvibe", "calendly", "cal_com", "attio", "email_verifier", "phone_verifier", "warmup_provider", "mcp_server", "app_connection" ] } } } ``` ### Output schema (structuredContent) ```json { "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" }, "adapter": { "$ref": "#/$defs/IntegrationShareAdapter" }, "provider": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,63}$" }, "displayName": { "$ref": "#/$defs/ShortText" }, "role": { "type": "string", "enum": [ "source", "target" ] }, "sourceWorkspaceId": { "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" }, "sourceWorkspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "sourceConnectionId": { "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" }, "sourceConnected": { "type": "boolean" }, "includeFutureWorkspaces": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "attaching", "attached", "detached", "failed" ] }, "connectionId": { "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" } ] }, "failureReason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "attachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "detachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|state|connectionId|failureReason|attachedAt|detachedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ] } }, "maxItems": 500 } }, "required": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ], "patternProperties": { "^(?!(?:id|adapter|provider|displayName|role|sourceWorkspaceId|sourceWorkspaceName|sourceConnectionId|sourceConnected|includeFutureWorkspaces|createdAt|revokedAt|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ] }, "$defs": { "IntegrationShareAdapter": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer", "heyreach", "getleads", "plusvibe", "calendly", "cal_com", "attio", "email_verifier", "phone_verifier", "warmup_provider", "mcp_server", "app_connection" ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `integrationShares.create`: `POST /v1/workspaces/:workspaceId/integration-shares` ## submit_support_feedback Submit a bounded support case with optional finalized attachment references. Use for defects, questions, or requests needing human support follow-up. Attachments must be finalized download capabilities — the case stores references, never bytes. Scopes: support:create 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" }, "type": { "type": "string", "enum": [ "feature_request", "bug", "feedback" ] }, "summary": { "type": "string", "minLength": 1, "maxLength": 300 }, "details": { "type": "string", "minLength": 1, "maxLength": 3500 }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "downloadToken": { "$ref": "#/$defs/SupportCapabilityToken" }, "fileName": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "downloadToken", "fileName" ], "patternProperties": { "^(?!(?:downloadToken|fileName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "downloadToken", "fileName" ] } }, "maxItems": 5 } }, "required": [ "workspaceId", "type", "summary", "details" ], "patternProperties": { "^(?!(?:workspaceId|type|summary|details|attachments)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "type", "summary", "details", "attachments" ] }, "$defs": { "SupportCapabilityToken": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### 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" }, "type": { "type": "string", "enum": [ "feature_request", "bug", "feedback" ] }, "summary": { "type": "string", "minLength": 1, "maxLength": 300 }, "details": { "type": "string", "minLength": 1, "maxLength": 3500 }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "downloadToken": { "$ref": "#/$defs/SupportCapabilityToken" }, "fileName": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "downloadToken", "fileName" ], "patternProperties": { "^(?!(?:downloadToken|fileName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "downloadToken", "fileName" ] } }, "maxItems": 5 } }, "required": [ "workspaceId", "type", "summary", "details" ], "patternProperties": { "^(?!(?:workspaceId|type|summary|details|attachments)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "type", "summary", "details", "attachments" ] }, "$defs": { "SupportCapabilityToken": { "type": "string", "minLength": 1, "maxLength": 4096 } } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "ticketId": { "$ref": "#/$defs/OpaqueId" }, "messageId": { "$ref": "#/$defs/OpaqueId" }, "ticketStatus": { "type": "string", "enum": [ "new", "open", "pending", "on_hold", "resolved" ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "ticketId", "messageId", "ticketStatus", "createdAt" ], "patternProperties": { "^(?!(?:ticketId|messageId|ticketStatus|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "ticketId", "messageId", "ticketStatus", "createdAt" ] }, "$defs": { "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `support.submitFeedback`: `POST /v1/workspaces/:workspaceId/support/feedback` ## sync_inboxes Triggers mailbox sync for one, several, or all workspace inboxes. When asked to refresh or resync mailbox state. For one-off DNS checks — use run_inbox_diagnostics. Scopes: inbox:update 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" }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "workspaceId", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxIds" ] } } ``` ### 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" }, "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "workspaceId", "inboxIds" ], "patternProperties": { "^(?!(?:workspaceId|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxIds" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "triggered": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "errors": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "triggered", "errors" ], "patternProperties": { "^(?!(?:triggered|errors)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "triggered", "errors" ] }, "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `inboxes.sync`: `POST /v1/workspaces/:workspaceId/inboxes/sync` ## sync_unibox_history Check sync status, pull older mail from the provider, inspect history import options, or copy one conversation's history into a second connected mailbox. Select the action explicitly. Use when a conversation the customer expects is genuinely not in the product yet. Check the status first: a mailbox that reports its history complete has nothing older to fetch. It is not a search. Both actions are durable work returning an operation handle, and repeatedly asking at the same position dispatches nothing new. Scopes: unibox:read, inbox:update Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "status" ] } ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "inboxIds": { "type": "string" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|cursor|limit|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "cursor", "limit", "inboxIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "sync_older" ] } ] }, "older": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "batchSize": { "type": "integer", "minimum": 10, "maximum": 100 } }, "patternProperties": { "^(?!(?:inboxIds|batchSize)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "batchSize" ] } } }, "required": [ "workspaceId", "action", "older" ], "patternProperties": { "^(?!(?:workspaceId|action|older)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "older" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "import_options" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "start_import" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "destinationInboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId", "destinationInboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId|destinationInboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId", "destinationInboxId" ] } } ], "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "status" ] } ] }, "cursor": { "$ref": "#/$defs/Cursor" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "inboxIds": { "type": "string" } }, "required": [ "workspaceId", "action" ], "patternProperties": { "^(?!(?:workspaceId|action|cursor|limit|inboxIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "cursor", "limit", "inboxIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "sync_older" ] } ] }, "older": { "type": "object", "properties": { "inboxIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 100 }, "batchSize": { "type": "integer", "minimum": 10, "maximum": 100 } }, "patternProperties": { "^(?!(?:inboxIds|batchSize)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "batchSize" ] } } }, "required": [ "workspaceId", "action", "older" ], "patternProperties": { "^(?!(?:workspaceId|action|older)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "older" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "import_options" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "start_import" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "destinationInboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "workspaceId", "action", "messageId", "destinationInboxId" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId|destinationInboxId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId", "destinationInboxId" ] } } ], "$defs": { "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "Cursor": { "type": "string", "minLength": 1, "maxLength": 2048 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "statusUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] }, "acceptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "message": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "completed" ], "patternProperties": { "^(?!(?:completed|total|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "completed", "total", "message" ] } }, "canCancel": { "type": "boolean" } }, "required": [ "id", "statusUrl", "state", "acceptedAt", "canCancel" ], "patternProperties": { "^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "statusUrl", "state", "acceptedAt", "progress", "canCancel" ] } }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "statusUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] }, "acceptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "message": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "completed" ], "patternProperties": { "^(?!(?:completed|total|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "completed", "total", "message" ] } }, "canCancel": { "type": "boolean" }, "counts": { "type": "object", "properties": { "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "existing": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unresolved": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "separateThreads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "imported", "existing", "remaining", "unresolved", "separateThreads", "total" ], "patternProperties": { "^(?!(?:imported|existing|remaining|unresolved|separateThreads|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "imported", "existing", "remaining", "unresolved", "separateThreads", "total" ] } } }, "required": [ "id", "statusUrl", "state", "acceptedAt", "canCancel" ], "patternProperties": { "^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel|counts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "statusUrl", "state", "acceptedAt", "progress", "canCancel", "counts" ] } }, { "type": "object", "properties": { "inboxes": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "historyComplete": { "type": "boolean" }, "syncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "estimatedTotal": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "oldestSyncedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "newestSyncedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "progress": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] } }, "required": [ "inboxId", "emailAddress", "historyComplete", "syncedCount", "estimatedTotal", "oldestSyncedAt", "newestSyncedAt", "progress" ], "patternProperties": { "^(?!(?:inboxId|emailAddress|historyComplete|syncedCount|estimatedTotal|oldestSyncedAt|newestSyncedAt|progress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "emailAddress", "historyComplete", "syncedCount", "estimatedTotal", "oldestSyncedAt", "newestSyncedAt", "progress" ] } }, "maxItems": 100 }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] }, "allHistoryComplete": { "type": "boolean" }, "totalSynced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalEstimated": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "canLoadMore": { "type": "boolean" } }, "required": [ "inboxes", "allHistoryComplete", "totalSynced", "totalEstimated", "canLoadMore" ], "patternProperties": { "^(?!(?:inboxes|nextCursor|allHistoryComplete|totalSynced|totalEstimated|canLoadMore)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxes", "nextCursor", "allHistoryComplete", "totalSynced", "totalEstimated", "canLoadMore" ] } }, { "type": "object", "properties": { "eligible": { "type": "boolean" }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "destinations": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "inboxId", "emailAddress" ], "patternProperties": { "^(?!(?:inboxId|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "emailAddress" ] } }, "maxItems": 200 } }, "required": [ "eligible", "reason", "destinations" ], "patternProperties": { "^(?!(?:eligible|reason|destinations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "eligible", "reason", "destinations" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "statusUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] }, "acceptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "message": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "completed" ], "patternProperties": { "^(?!(?:completed|total|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "completed", "total", "message" ] } }, "canCancel": { "type": "boolean" } }, "required": [ "id", "statusUrl", "state", "acceptedAt", "canCancel" ], "patternProperties": { "^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "statusUrl", "state", "acceptedAt", "progress", "canCancel" ] } }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "statusUrl": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "$ref": "#/$defs/HttpResourcePath" } ] }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_user", "succeeded", "partially_succeeded", "failed", "canceled", "canceling" ] }, "acceptedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "message": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "completed" ], "patternProperties": { "^(?!(?:completed|total|message)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "completed", "total", "message" ] } }, "canCancel": { "type": "boolean" }, "counts": { "type": "object", "properties": { "imported": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "existing": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "remaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unresolved": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "separateThreads": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "imported", "existing", "remaining", "unresolved", "separateThreads", "total" ], "patternProperties": { "^(?!(?:imported|existing|remaining|unresolved|separateThreads|total)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "imported", "existing", "remaining", "unresolved", "separateThreads", "total" ] } } }, "required": [ "id", "statusUrl", "state", "acceptedAt", "canCancel" ], "patternProperties": { "^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel|counts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "statusUrl", "state", "acceptedAt", "progress", "canCancel", "counts" ] } }, { "type": "object", "properties": { "inboxes": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "historyComplete": { "type": "boolean" }, "syncedCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "estimatedTotal": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "oldestSyncedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "newestSyncedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "progress": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] } }, "required": [ "inboxId", "emailAddress", "historyComplete", "syncedCount", "estimatedTotal", "oldestSyncedAt", "newestSyncedAt", "progress" ], "patternProperties": { "^(?!(?:inboxId|emailAddress|historyComplete|syncedCount|estimatedTotal|oldestSyncedAt|newestSyncedAt|progress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "emailAddress", "historyComplete", "syncedCount", "estimatedTotal", "oldestSyncedAt", "newestSyncedAt", "progress" ] } }, "maxItems": 100 }, "nextCursor": { "anyOf": [ { "$ref": "#/$defs/Cursor" }, { "type": "null" } ] }, "allHistoryComplete": { "type": "boolean" }, "totalSynced": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalEstimated": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "canLoadMore": { "type": "boolean" } }, "required": [ "inboxes", "allHistoryComplete", "totalSynced", "totalEstimated", "canLoadMore" ], "patternProperties": { "^(?!(?:inboxes|nextCursor|allHistoryComplete|totalSynced|totalEstimated|canLoadMore)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxes", "nextCursor", "allHistoryComplete", "totalSynced", "totalEstimated", "canLoadMore" ] } }, { "type": "object", "properties": { "eligible": { "type": "boolean" }, "reason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "destinations": { "type": "array", "items": { "type": "object", "properties": { "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "emailAddress": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "inboxId", "emailAddress" ], "patternProperties": { "^(?!(?:inboxId|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxId", "emailAddress" ] } }, "maxItems": 200 } }, "required": [ "eligible", "reason", "destinations" ], "patternProperties": { "^(?!(?:eligible|reason|destinations)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "eligible", "reason", "destinations" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `uniboxSync.getStatus`: `GET /v1/workspaces/:workspaceId/unibox/sync/status` - `uniboxSync.syncOlder`: `POST /v1/workspaces/:workspaceId/unibox/sync/older` - `uniboxSync.getHistoryImportOptions`: `GET /v1/workspaces/:workspaceId/unibox/messages/:messageId/history-import/options` - `uniboxSync.startHistoryImport`: `POST /v1/workspaces/:workspaceId/unibox/messages/:messageId/history-import` ## test_booking_connection Probe a booking connection by fetching the connected account's profile. Use to distinguish a revoked grant from a provider outage before telling a human to reconnect. A `connected: false` result is a normal outcome, not an error to retry. Scopes: integration:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] } }, "required": [ "workspaceId", "provider" ], "patternProperties": { "^(?!(?:workspaceId|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider" ] } } ``` ### 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" }, "provider": { "type": "string", "enum": [ "calendly", "cal_com" ] } }, "required": [ "workspaceId", "provider" ], "patternProperties": { "^(?!(?:workspaceId|provider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "provider" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "connected": { "type": "boolean", "enum": [ true ] }, "owner": { "type": "object", "properties": { "email": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "email", "name" ], "patternProperties": { "^(?!(?:email|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "name" ] } } }, "required": [ "connected", "owner" ], "patternProperties": { "^(?!(?:connected|owner)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "owner" ] } }, { "type": "object", "properties": { "connected": { "type": "boolean", "enum": [ false ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "connected", "error" ], "patternProperties": { "^(?!(?:connected|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "error" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "connected": { "type": "boolean", "enum": [ true ] }, "owner": { "type": "object", "properties": { "email": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "name": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "email", "name" ], "patternProperties": { "^(?!(?:email|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "name" ] } } }, "required": [ "connected", "owner" ], "patternProperties": { "^(?!(?:connected|owner)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "owner" ] } }, { "type": "object", "properties": { "connected": { "type": "boolean", "enum": [ false ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "connected", "error" ], "patternProperties": { "^(?!(?:connected|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connected", "error" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `booking.calendly.testConnection`: `POST /v1/workspaces/:workspaceId/booking/calendly/test` - `booking.calCom.testConnection`: `POST /v1/workspaces/:workspaceId/booking/cal-com/test` ## test_campaign Preview a draft's rendered subject and body against a real sending inbox, and send one real test email to a chosen address. Render first — it dispatches nothing — and only send a test once the rendered copy looks right. The send is real outbound mail billed to the workspace and is refused on a frozen subscription; never use it to reach a prospect. Scopes: campaign:read, campaign:update, inbox:read Risk: costly; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "render" ] }, "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" }, "campaignId": { "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "test": { "type": "object", "properties": { "subject": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "sampleRecipient": { "type": "object", "properties": { "firstName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/IanaTimeZone" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:firstName|lastName|companyName|emailAddress|timezone)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "firstName", "lastName", "companyName", "emailAddress", "timezone" ] } }, "sampleSender": { "type": "object", "properties": { "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:senderFirstName|senderLastName|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderFirstName", "senderLastName", "emailAddress" ] } }, "previewSeed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "subject", "body", "bodyFormat" ], "patternProperties": { "^(?!(?:subject|body|bodyFormat|sampleRecipient|sampleSender|previewSeed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body", "bodyFormat", "sampleRecipient", "sampleSender", "previewSeed" ] } } }, "required": [ "action", "workspaceId", "campaignId", "inboxId", "test" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|inboxId|test)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "inboxId", "test" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "send" ] }, "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" }, "campaignId": { "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" }, "test": { "type": "object", "properties": { "contactId": { "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" }, "testEmail": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "contactId", "testEmail" ], "patternProperties": { "^(?!(?:contactId|testEmail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "testEmail" ] } } }, "required": [ "action", "workspaceId", "campaignId", "test" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|test)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "test" ] } } ], "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" } } } ``` ### 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": [ "render" ] }, "campaignId": { "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "test": { "type": "object", "properties": { "subject": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "sampleRecipient": { "type": "object", "properties": { "firstName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/IanaTimeZone" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:firstName|lastName|companyName|emailAddress|timezone)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "firstName", "lastName", "companyName", "emailAddress", "timezone" ] } }, "sampleSender": { "type": "object", "properties": { "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:senderFirstName|senderLastName|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderFirstName", "senderLastName", "emailAddress" ] } }, "previewSeed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "subject", "body", "bodyFormat" ], "patternProperties": { "^(?!(?:subject|body|bodyFormat|sampleRecipient|sampleSender|previewSeed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body", "bodyFormat", "sampleRecipient", "sampleSender", "previewSeed" ] } } }, "required": [ "action", "workspaceId", "campaignId", "inboxId", "test" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|inboxId|test)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "inboxId", "test" ] }, { "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": [ "send" ] }, "campaignId": { "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" }, "test": { "type": "object", "properties": { "contactId": { "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" }, "testEmail": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "contactId", "testEmail" ], "patternProperties": { "^(?!(?:contactId|testEmail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "testEmail" ] } } }, "required": [ "action", "workspaceId", "campaignId", "test" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|test)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "test" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "RenderedDraftText": { "type": "string", "maxLength": 1000000 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "subject": { "$ref": "#/$defs/RenderedDraftText" }, "body": { "$ref": "#/$defs/RenderedDraftText" }, "bodyContentType": { "type": "string", "enum": [ "plain", "html" ] }, "unresolvedExpressions": { "type": "object", "properties": { "subject": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "body": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "subject", "body" ], "patternProperties": { "^(?!(?:subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body" ] } }, "senderEmail": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "subject", "body", "bodyContentType", "unresolvedExpressions", "senderEmail" ], "patternProperties": { "^(?!(?:subject|body|bodyContentType|unresolvedExpressions|senderEmail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body", "bodyContentType", "unresolvedExpressions", "senderEmail" ] } }, { "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": { "subject": { "$ref": "#/$defs/RenderedDraftText" }, "body": { "$ref": "#/$defs/RenderedDraftText" }, "bodyContentType": { "type": "string", "enum": [ "plain", "html" ] }, "unresolvedExpressions": { "type": "object", "properties": { "subject": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "body": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "subject", "body" ], "patternProperties": { "^(?!(?:subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body" ] } }, "senderEmail": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "subject", "body", "bodyContentType", "unresolvedExpressions", "senderEmail" ], "patternProperties": { "^(?!(?:subject|body|bodyContentType|unresolvedExpressions|senderEmail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body", "bodyContentType", "unresolvedExpressions", "senderEmail" ] } }, { "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 - `campaignInboxes.renderDraftTest`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/inboxes/:inboxId/render-draft-test` - `campaigns.testCampaign`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/test` ## test_inbox_connection Live-probes a connected inbox and, when asked, forces a credential refresh through the pinned OAuth route. When asked whether an inbox still connects, or to heal a stale grant. For pre-connect credential checks — those are human-only by design. Scopes: inbox:read, inbox:update Risk: read; 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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "test" ] } }, "required": [ "workspaceId", "inboxId", "action" ], "patternProperties": { "^(?!(?:workspaceId|inboxId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxId", "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "refresh" ] } }, "required": [ "workspaceId", "inboxId", "action" ], "patternProperties": { "^(?!(?:workspaceId|inboxId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "inboxId", "action" ] } } ] } ``` ### 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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "test" ] } }, "required": [ "workspaceId", "inboxId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|inboxId|action)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "inboxId", "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" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "type": "string", "enum": [ "refresh" ] } }, "required": [ "workspaceId", "inboxId", "action" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|inboxId|action)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "inboxId", "action" ] }, { "enum": [ "workspaceId" ] } ] } } ] } ``` ### Output schema (structuredContent) ```json { "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "ok": { "type": "boolean" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grantedScopes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "tokenExpiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "error": { "$ref": "#/$defs/ShortText" } }, "required": [ "ok" ], "patternProperties": { "^(?!(?:ok|email|grantedScopes|tokenExpiresAt|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "ok", "email", "grantedScopes", "tokenExpiresAt", "error" ] } }, { "type": "object", "properties": { "connectionId": { "$ref": "#/$defs/OpaqueId" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "imap_smtp" ] }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "state": { "type": "string", "enum": [ "connected", "needs_reauthorization", "quarantined", "alert", "disconnected" ] }, "grantedScopes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "tokenExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "watchExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "credentialRefId": { "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" } ] }, "lastSyncAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "connectionId", "inboxId", "provider", "emailAddress", "state", "tokenExpiresAt", "watchExpiresAt", "credentialRefId", "lastSyncAt" ], "patternProperties": { "^(?!(?:connectionId|inboxId|provider|emailAddress|state|grantedScopes|tokenExpiresAt|watchExpiresAt|credentialRefId|lastSyncAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connectionId", "inboxId", "provider", "emailAddress", "state", "grantedScopes", "tokenExpiresAt", "watchExpiresAt", "credentialRefId", "lastSyncAt" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "ok": { "type": "boolean" }, "email": { "$ref": "#/$defs/EmailAddress" }, "grantedScopes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "tokenExpiresAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "error": { "$ref": "#/$defs/ShortText" } }, "required": [ "ok" ], "patternProperties": { "^(?!(?:ok|email|grantedScopes|tokenExpiresAt|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "ok", "email", "grantedScopes", "tokenExpiresAt", "error" ] } }, { "type": "object", "properties": { "connectionId": { "$ref": "#/$defs/OpaqueId" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "imap_smtp" ] }, "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "state": { "type": "string", "enum": [ "connected", "needs_reauthorization", "quarantined", "alert", "disconnected" ] }, "grantedScopes": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "tokenExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "watchExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "credentialRefId": { "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" } ] }, "lastSyncAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "connectionId", "inboxId", "provider", "emailAddress", "state", "tokenExpiresAt", "watchExpiresAt", "credentialRefId", "lastSyncAt" ], "patternProperties": { "^(?!(?:connectionId|inboxId|provider|emailAddress|state|grantedScopes|tokenExpiresAt|watchExpiresAt|credentialRefId|lastSyncAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "connectionId", "inboxId", "provider", "emailAddress", "state", "grantedScopes", "tokenExpiresAt", "watchExpiresAt", "credentialRefId", "lastSyncAt" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `inboxConnections.test`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/test` - `inboxConnections.refreshGrant`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/refresh` ## transfer_domains Push a domain to another account at the same registrar and check the progress of an outbound transfer. Use when a person explicitly wants a domain moved off Scheduler Zero to their own registrar account. A push is instant and the domain leaves the workspace; the EPP code for other registrars is only given to a person in the web app. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: domain:transfer, domain:read Risk: destructive; confirmation: explicit; 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" }, "domainId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "push" ] }, "request": { "type": "object", "properties": { "targetAccountName": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "targetAccountName" ], "patternProperties": { "^(?!(?:targetAccountName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "targetAccountName" ] } ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "status" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } } ] } }, "required": [ "workspaceId", "domainId", "action" ], "patternProperties": { "^(?!(?:workspaceId|domainId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "domainId", "action" ] } } ``` ### 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" }, "domainId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "push" ] }, "request": { "type": "object", "properties": { "targetAccountName": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [ "targetAccountName" ], "patternProperties": { "^(?!(?:targetAccountName)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "targetAccountName" ] } ] } } }, "required": [ "kind", "request" ], "patternProperties": { "^(?!(?:kind|request)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "kind", "request" ] } }, { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "status" ] } }, "required": [ "kind" ], "patternProperties": { "^(?!(?:kind)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "kind" ] } ] } } ] } }, "required": [ "workspaceId", "domainId", "action" ], "patternProperties": { "^(?!(?:workspaceId|domainId|action)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "domainId", "action" ] } } ``` ### Output schema (structuredContent) ```json { "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "patternProperties": { "^(?!(?:ok)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "ok" ] } ] } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "registering", "renew_option_pending", "active", "renewal_due", "transfer_pending", "transferred_out", "expired", "failed" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "changed": { "type": "boolean" } }, "required": [ "status", "rawStatus", "changed" ], "patternProperties": { "^(?!(?:status|rawStatus|changed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "rawStatus", "changed" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "patternProperties": { "^(?!(?:ok)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "ok" ] } ] } }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "registering", "renew_option_pending", "active", "renewal_due", "transfer_pending", "transferred_out", "expired", "failed" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "changed": { "type": "boolean" } }, "required": [ "status", "rawStatus", "changed" ], "patternProperties": { "^(?!(?:status|rawStatus|changed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "status", "rawStatus", "changed" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `domains.requestPush`: `POST /v1/workspaces/:workspaceId/domains/:domainId/push` - `domains.transferStatus`: `GET /v1/workspaces/:workspaceId/domains/:domainId/transfer-status` ## triage_unibox_threads Organize conversations: star, mark read, archive, unarchive, restore, relabel, and flag a message — singly or for up to a hundred threads at once. Select an explicit action and provide the identifiers and values it needs. Use to work an inbox down. Every action is reversible and setting a state a thread already holds succeeds, so a retry is safe. None of this touches the mailbox at the provider: archiving here does not archive in Gmail. Applying a reply label can start label-driven automation, so it is not a neutral annotation. Scopes: unibox:read, unibox:archive, unibox:label Risk: write; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "set_state" ] } ] }, "threadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, "starred": { "type": "boolean" }, "read": { "type": "boolean" } }, "required": [ "workspaceId", "action", "threadIds" ], "patternProperties": { "^(?!(?:workspaceId|action|threadIds|starred|read)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadIds", "starred", "read" ] } }, { "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": [ "archive", "unarchive", "restore" ] }, "threadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 } }, "required": [ "workspaceId", "action", "threadIds" ], "patternProperties": { "^(?!(?:workspaceId|action|threadIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "set_labels" ] } ] }, "threadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 1 }, "labels": { "type": "object", "properties": { "add": { "type": "array", "items": { "$ref": "#/$defs/ThreadLabelId" }, "maxItems": 20 }, "remove": { "type": "array", "items": { "$ref": "#/$defs/ThreadLabelId" }, "maxItems": 20 } }, "required": [ "add", "remove" ], "patternProperties": { "^(?!(?:add|remove)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "add", "remove" ] } } }, "required": [ "workspaceId", "action", "threadIds", "labels" ], "patternProperties": { "^(?!(?:workspaceId|action|threadIds|labels)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadIds", "labels" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "flag_message" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "flagged": { "type": "boolean" } }, "required": [ "workspaceId", "action", "messageId", "flagged" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId|flagged)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId", "flagged" ] } } ], "$defs": { "ThreadLabelId": { "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" } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "set_state" ] } ] }, "threadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 }, "starred": { "type": "boolean" }, "read": { "type": "boolean" } }, "required": [ "workspaceId", "action", "threadIds" ], "patternProperties": { "^(?!(?:workspaceId|action|threadIds|starred|read)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadIds", "starred", "read" ] } }, { "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": [ "archive", "unarchive", "restore" ] }, "threadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 100 } }, "required": [ "workspaceId", "action", "threadIds" ], "patternProperties": { "^(?!(?:workspaceId|action|threadIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadIds" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "set_labels" ] } ] }, "threadIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 1 }, "labels": { "type": "object", "properties": { "add": { "type": "array", "items": { "$ref": "#/$defs/ThreadLabelId" }, "maxItems": 20 }, "remove": { "type": "array", "items": { "$ref": "#/$defs/ThreadLabelId" }, "maxItems": 20 } }, "required": [ "add", "remove" ], "patternProperties": { "^(?!(?:add|remove)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "add", "remove" ] } } }, "required": [ "workspaceId", "action", "threadIds", "labels" ], "patternProperties": { "^(?!(?:workspaceId|action|threadIds|labels)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "threadIds", "labels" ] } }, { "type": "object", "properties": { "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "action": { "anyOf": [ { "type": "string", "enum": [ "flag_message" ] } ] }, "messageId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "flagged": { "type": "boolean" } }, "required": [ "workspaceId", "action", "messageId", "flagged" ], "patternProperties": { "^(?!(?:workspaceId|action|messageId|flagged)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "messageId", "flagged" ] } } ], "$defs": { "ThreadLabelId": { "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" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ThreadLabelId": { "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" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "AttachmentId": { "type": "string", "minLength": 1, "maxLength": 512 } }, "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" }, "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" } ] }, "organizationId": { "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" }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "contact": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "leadId": { "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" } ] } }, "required": [ "emailAddress", "name", "leadId" ], "patternProperties": { "^(?!(?:emailAddress|name|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "name", "leadId" ] } }, "providerThreadId": { "$ref": "#/$defs/OpaqueId" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "lastMessageAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "messageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ThreadLabelId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isFormerMember": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isFormerMember" ], "patternProperties": { "^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isFormerMember" ] } } }, "campaignId": { "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" } ] }, "campaignContactId": { "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" } ] }, "isRead": { "type": "boolean" }, "starredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "folders": { "type": "array", "items": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] } }, "recentMessages": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isRead": { "type": "boolean" }, "isFromInboxSender": { "type": "boolean" } }, "required": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ], "patternProperties": { "^(?!(?:id|providerInternalMessageId|from|to|cc|subject|snippet|receivedAt|isRead|isFromInboxSender)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ] } }, "maxItems": 20 } }, "required": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders" ], "patternProperties": { "^(?!(?:id|inboxId|organizationId|subject|snippet|contact|providerThreadId|provider|lastMessageAt|messageCount|labels|assignees|campaignId|campaignContactId|isRead|starredAt|archivedAt|deletedAt|folders|recentMessages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders", "recentMessages" ] } }, { "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" }, "threadId": { "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" }, "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" } ] }, "organizationId": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "rfc2822MessageId": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "isFromInboxSender": { "type": "boolean" }, "sentFromUnibox": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttachmentId" }, "filename": { "$ref": "#/$defs/ShortText" }, "contentType": { "$ref": "#/$defs/ShortText" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inline": { "type": "boolean" } }, "required": [ "id", "filename", "contentType", "size", "inline" ], "patternProperties": { "^(?!(?:id|filename|contentType|size|inline)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "filename", "contentType", "size", "inline" ] } } }, "bodyState": { "type": "string", "enum": [ "available", "pending" ] }, "isRead": { "type": "boolean" }, "flaggedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "headers": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 16384 } }, "authoredByWorkflowRunId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt" ], "patternProperties": { "^(?!(?:id|threadId|inboxId|organizationId|providerInternalMessageId|rfc2822MessageId|provider|from|to|cc|bcc|subject|snippet|receivedAt|direction|isFromInboxSender|sentFromUnibox|attachments|bodyState|isRead|flaggedAt|deletedAt|headers|authoredByWorkflowRunId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt", "headers", "authoredByWorkflowRunId" ] } }, { "type": "object", "properties": { "threadId": { "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" }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ThreadLabelId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } } }, "required": [ "threadId", "labels" ], "patternProperties": { "^(?!(?:threadId|labels)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "labels" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "threadId": { "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" }, "ok": { "type": "boolean" }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "threadId", "ok", "error" ], "patternProperties": { "^(?!(?:threadId|ok|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "ok", "error" ] } }, "maxItems": 100 }, "succeeded": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "succeeded", "failed" ], "patternProperties": { "^(?!(?:items|succeeded|failed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "succeeded", "failed" ] } } ] }, { "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" }, "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" } ] }, "organizationId": { "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" }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "contact": { "type": "object", "properties": { "emailAddress": { "$ref": "#/$defs/EmailAddress" }, "name": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "leadId": { "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" } ] } }, "required": [ "emailAddress", "name", "leadId" ], "patternProperties": { "^(?!(?:emailAddress|name|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "emailAddress", "name", "leadId" ] } }, "providerThreadId": { "$ref": "#/$defs/OpaqueId" }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "lastMessageAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "messageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ThreadLabelId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "$ref": "#/$defs/HttpUrl" }, { "type": "null" } ] }, "isFormerMember": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "isFormerMember" ], "patternProperties": { "^(?!(?:userId|name|email|image|isFormerMember)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "isFormerMember" ] } } }, "campaignId": { "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" } ] }, "campaignContactId": { "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" } ] }, "isRead": { "type": "boolean" }, "starredAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "archivedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "folders": { "type": "array", "items": { "type": "string", "enum": [ "inbox", "sent", "archived", "starred", "warmup", "trash" ] } }, "recentMessages": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "isRead": { "type": "boolean" }, "isFromInboxSender": { "type": "boolean" } }, "required": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ], "patternProperties": { "^(?!(?:id|providerInternalMessageId|from|to|cc|subject|snippet|receivedAt|isRead|isFromInboxSender)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "providerInternalMessageId", "from", "to", "cc", "subject", "snippet", "receivedAt", "isRead", "isFromInboxSender" ] } }, "maxItems": 20 } }, "required": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders" ], "patternProperties": { "^(?!(?:id|inboxId|organizationId|subject|snippet|contact|providerThreadId|provider|lastMessageAt|messageCount|labels|assignees|campaignId|campaignContactId|isRead|starredAt|archivedAt|deletedAt|folders|recentMessages)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "inboxId", "organizationId", "subject", "snippet", "contact", "providerThreadId", "provider", "lastMessageAt", "messageCount", "labels", "assignees", "campaignId", "campaignContactId", "isRead", "starredAt", "archivedAt", "deletedAt", "folders", "recentMessages" ] } }, { "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" }, "threadId": { "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" }, "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" } ] }, "organizationId": { "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" }, "providerInternalMessageId": { "$ref": "#/$defs/OpaqueId" }, "rfc2822MessageId": { "anyOf": [ { "$ref": "#/$defs/NonEmptyString" }, { "type": "null" } ] }, "provider": { "type": "string", "enum": [ "google_workspace", "microsoft_365", "other" ] }, "from": { "$ref": "#/$defs/NonEmptyString" }, "to": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "cc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "bcc": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" } }, "subject": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "snippet": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "receivedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "direction": { "type": "string", "enum": [ "inbound", "outbound" ] }, "isFromInboxSender": { "type": "boolean" }, "sentFromUnibox": { "type": "boolean" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/AttachmentId" }, "filename": { "$ref": "#/$defs/ShortText" }, "contentType": { "$ref": "#/$defs/ShortText" }, "size": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "inline": { "type": "boolean" } }, "required": [ "id", "filename", "contentType", "size", "inline" ], "patternProperties": { "^(?!(?:id|filename|contentType|size|inline)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "filename", "contentType", "size", "inline" ] } } }, "bodyState": { "type": "string", "enum": [ "available", "pending" ] }, "isRead": { "type": "boolean" }, "flaggedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "headers": { "type": "object", "additionalProperties": { "type": "string", "maxLength": 16384 } }, "authoredByWorkflowRunId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] } }, "required": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt" ], "patternProperties": { "^(?!(?:id|threadId|inboxId|organizationId|providerInternalMessageId|rfc2822MessageId|provider|from|to|cc|bcc|subject|snippet|receivedAt|direction|isFromInboxSender|sentFromUnibox|attachments|bodyState|isRead|flaggedAt|deletedAt|headers|authoredByWorkflowRunId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "threadId", "inboxId", "organizationId", "providerInternalMessageId", "rfc2822MessageId", "provider", "from", "to", "cc", "bcc", "subject", "snippet", "receivedAt", "direction", "isFromInboxSender", "sentFromUnibox", "attachments", "bodyState", "isRead", "flaggedAt", "deletedAt", "headers", "authoredByWorkflowRunId" ] } }, { "type": "object", "properties": { "threadId": { "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" }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "$ref": "#/$defs/ThreadLabelId" }, "name": { "$ref": "#/$defs/ShortText" }, "hexColor": { "$ref": "#/$defs/ShortText" }, "sentiment": { "anyOf": [ { "type": "string", "enum": [ "positive", "negative", "neutral" ] }, { "type": "null" } ] }, "type": { "type": "string", "enum": [ "custom", "default" ] } }, "required": [ "id", "name", "hexColor", "sentiment", "type" ], "patternProperties": { "^(?!(?:id|name|hexColor|sentiment|type)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "hexColor", "sentiment", "type" ] } } } }, "required": [ "threadId", "labels" ], "patternProperties": { "^(?!(?:threadId|labels)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "labels" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "threadId": { "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" }, "ok": { "type": "boolean" }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "threadId", "ok", "error" ], "patternProperties": { "^(?!(?:threadId|ok|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "threadId", "ok", "error" ] } }, "maxItems": 100 }, "succeeded": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "items", "succeeded", "failed" ], "patternProperties": { "^(?!(?:items|succeeded|failed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "items", "succeeded", "failed" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `uniboxThreads.update`: `PATCH /v1/workspaces/:workspaceId/unibox/threads/:threadId` - `uniboxThreads.archive`: `POST /v1/workspaces/:workspaceId/unibox/threads/:threadId/archive` - `uniboxThreads.unarchive`: `POST /v1/workspaces/:workspaceId/unibox/threads/:threadId/unarchive` - `uniboxThreads.restore`: `POST /v1/workspaces/:workspaceId/unibox/threads/:threadId/restore` - `uniboxThreads.setLabels`: `PUT /v1/workspaces/:workspaceId/unibox/threads/:threadId/labels` - `uniboxThreads.batchStar`: `POST /v1/workspaces/:workspaceId/unibox/threads/batch/star` - `uniboxThreads.batchArchive`: `POST /v1/workspaces/:workspaceId/unibox/threads/batch/archive` - `uniboxThreads.batchMarkRead`: `POST /v1/workspaces/:workspaceId/unibox/threads/batch/read` - `uniboxThreads.batchRestore`: `POST /v1/workspaces/:workspaceId/unibox/threads/batch/restore` - `uniboxMessages.update`: `PATCH /v1/workspaces/:workspaceId/unibox/messages/:messageId` ## update_integration_share Add workspaces to an existing share, or change whether workspaces created later join it. Use on the source workspace of a share. Detached workspaces are not re-added; their admins re-attach themselves. Use detach_integration_share or revoke_integration_share to narrow a share. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: integration:create Risk: write; confirmation: explicit; 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" }, "shareId": { "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" }, "addWorkspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 }, "includeFutureWorkspaces": { "type": "boolean" } }, "required": [ "workspaceId", "shareId" ], "patternProperties": { "^(?!(?:workspaceId|shareId|addWorkspaceIds|includeFutureWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "shareId", "addWorkspaceIds", "includeFutureWorkspaces" ] } } ``` ### 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" }, "shareId": { "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" }, "addWorkspaceIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "maxItems": 500 }, "includeFutureWorkspaces": { "type": "boolean" } }, "required": [ "workspaceId", "shareId" ], "patternProperties": { "^(?!(?:workspaceId|shareId|addWorkspaceIds|includeFutureWorkspaces)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "shareId", "addWorkspaceIds", "includeFutureWorkspaces" ] } } ``` ### Output schema (structuredContent) ```json { "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" }, "adapter": { "$ref": "#/$defs/IntegrationShareAdapter" }, "provider": { "type": "string", "pattern": "^[a-z][a-z0-9_-]{0,63}$" }, "displayName": { "$ref": "#/$defs/ShortText" }, "role": { "type": "string", "enum": [ "source", "target" ] }, "sourceWorkspaceId": { "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" }, "sourceWorkspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "sourceConnectionId": { "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" }, "sourceConnected": { "type": "boolean" }, "includeFutureWorkspaces": { "type": "boolean" }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "revokedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "targets": { "type": "array", "items": { "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" }, "workspaceName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "attaching", "attached", "detached", "failed" ] }, "connectionId": { "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" } ] }, "failureReason": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "attachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "detachedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] } }, "required": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ], "patternProperties": { "^(?!(?:workspaceId|workspaceName|state|connectionId|failureReason|attachedAt|detachedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "workspaceName", "state", "connectionId", "failureReason", "attachedAt", "detachedAt" ] } }, "maxItems": 500 } }, "required": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ], "patternProperties": { "^(?!(?:id|adapter|provider|displayName|role|sourceWorkspaceId|sourceWorkspaceName|sourceConnectionId|sourceConnected|includeFutureWorkspaces|createdAt|revokedAt|targets)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "adapter", "provider", "displayName", "role", "sourceWorkspaceId", "sourceWorkspaceName", "sourceConnectionId", "sourceConnected", "includeFutureWorkspaces", "createdAt", "revokedAt", "targets" ] }, "$defs": { "IntegrationShareAdapter": { "type": "string", "enum": [ "apollo", "prospeo", "conductor", "mxtoolbox", "clay", "floqer", "heyreach", "getleads", "plusvibe", "calendly", "cal_com", "attio", "email_verifier", "phone_verifier", "warmup_provider", "mcp_server", "app_connection" ] }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Underlying API operations - `integrationShares.update`: `PATCH /v1/workspaces/:workspaceId/integration-shares/:shareId` ## update_lead_details Patch descriptive lead fields, add an email contact point, or add/remove notes; action selects patch, add_email, add_note, or remove_note. Use for descriptive updates and notes; identity fields change only through the contact-point lane. addEmail conflicts when another lead owns the address; same-lead re-adds keep bad state. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: lead:update Risk: write; confirmation: explicit; 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" }, "leadId": { "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": [ "patch", "add_email", "add_note", "remove_note" ] }, "patch": { "type": "object", "properties": { "firstName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "locality": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "firstName", "lastName", "companyName", "companyWebsiteUrl", "jobTitle", "locality", "region", "country", "timezone", "personalLinkedInUrl", "companyLinkedInUrl" ] }, "minProperties": 1, "maxProperties": 11 }, "email": { "$ref": "#/$defs/EmailAddress" }, "noteId": { "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" }, "body": { "type": "string" } }, "required": [ "workspaceId", "leadId", "action" ], "patternProperties": { "^(?!(?:workspaceId|leadId|action|patch|email|noteId|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "leadId", "action", "patch", "email", "noteId", "body" ] }, "$defs": { "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" }, "leadId": { "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": [ "patch", "add_email", "add_note", "remove_note" ] }, "patch": { "type": "object", "properties": { "firstName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "locality": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "type": "string", "maxLength": 2048 }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "firstName", "lastName", "companyName", "companyWebsiteUrl", "jobTitle", "locality", "region", "country", "timezone", "personalLinkedInUrl", "companyLinkedInUrl" ] }, "minProperties": 1, "maxProperties": 11 }, "email": { "$ref": "#/$defs/EmailAddress" }, "noteId": { "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" }, "body": { "type": "string" } }, "required": [ "workspaceId", "leadId", "action" ], "patternProperties": { "^(?!(?:workspaceId|leadId|action|patch|email|noteId|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "leadId", "action", "patch", "email", "noteId", "body" ] }, "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "LeadStoredText": { "type": "string", "maxLength": 65536 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } }, "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" }, "organizationId": { "type": "string" }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneBase": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneExtension": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "locality": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "source": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "organizationId", "emailAddress", "phoneNumber", "phoneBase", "phoneExtension", "firstName", "lastName", "companyName", "companyWebsiteUrl", "jobTitle", "locality", "region", "country", "timezone", "personalLinkedInUrl", "companyLinkedInUrl", "source", "customFieldValues", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|organizationId|emailAddress|phoneNumber|phoneBase|phoneExtension|firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl|source|customFieldValues|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "organizationId", "emailAddress", "phoneNumber", "phoneBase", "phoneExtension", "firstName", "lastName", "companyName", "companyWebsiteUrl", "jobTitle", "locality", "region", "country", "timezone", "personalLinkedInUrl", "companyLinkedInUrl", "source", "customFieldValues", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } }, { "type": "object", "properties": { "note": { "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" }, "leadId": { "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" }, "body": { "type": "string" }, "authorUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "authorName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "leadId", "body", "authorUserId", "authorName", "createdAt" ], "patternProperties": { "^(?!(?:id|leadId|body|authorUserId|authorName|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "leadId", "body", "authorUserId", "authorName", "createdAt" ] } } }, "required": [ "note" ], "patternProperties": { "^(?!(?:note)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "note" ] } ] } } ] }, { "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" }, "organizationId": { "type": "string" }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneBase": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "phoneExtension": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyWebsiteUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "locality": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "region": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "country": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "personalLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "companyLinkedInUrl": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "source": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "customFieldValues": { "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "organizationId", "emailAddress", "phoneNumber", "phoneBase", "phoneExtension", "firstName", "lastName", "companyName", "companyWebsiteUrl", "jobTitle", "locality", "region", "country", "timezone", "personalLinkedInUrl", "companyLinkedInUrl", "source", "customFieldValues", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|organizationId|emailAddress|phoneNumber|phoneBase|phoneExtension|firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl|source|customFieldValues|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "organizationId", "emailAddress", "phoneNumber", "phoneBase", "phoneExtension", "firstName", "lastName", "companyName", "companyWebsiteUrl", "jobTitle", "locality", "region", "country", "timezone", "personalLinkedInUrl", "companyLinkedInUrl", "source", "customFieldValues", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "success": { "anyOf": [ { "type": "boolean", "enum": [ true ] } ] } }, "required": [ "success" ], "patternProperties": { "^(?!(?:success)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "success" ] } ] } }, { "type": "object", "properties": { "note": { "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" }, "leadId": { "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" }, "body": { "type": "string" }, "authorUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "authorName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "leadId", "body", "authorUserId", "authorName", "createdAt" ], "patternProperties": { "^(?!(?:id|leadId|body|authorUserId|authorName|createdAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "leadId", "body", "authorUserId", "authorName", "createdAt" ] } } }, "required": [ "note" ], "patternProperties": { "^(?!(?:note)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "note" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `leads.update`: `PATCH /v1/workspaces/:workspaceId/leads/:leadId` - `leads.addEmail`: `POST /v1/workspaces/:workspaceId/leads/:leadId/emails` - `leads.notes.add`: `POST /v1/workspaces/:workspaceId/leads/:leadId/notes` - `leads.notes.remove`: `DELETE /v1/workspaces/:workspaceId/leads/:leadId/notes/:noteId` ## update_task Update a task's mutable fields. Use to change title, description, due date, or lead link. The human request on a workflow task can never be edited; use the respond flow instead. Scopes: task:update 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" }, "taskId": { "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" }, "title": { "type": "string", "minLength": 1, "maxLength": 2000 }, "description": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "leadId": { "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" } ] } }, "required": [ "workspaceId", "taskId" ], "patternProperties": { "^(?!(?:workspaceId|taskId|title|description|dueDate|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "taskId", "title", "description", "dueDate", "leadId" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### 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" }, "taskId": { "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" }, "title": { "type": "string", "minLength": 1, "maxLength": 2000 }, "description": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "leadId": { "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" } ] } }, "required": [ "workspaceId", "taskId" ], "patternProperties": { "^(?!(?:workspaceId|taskId|title|description|dueDate|leadId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "taskId", "title", "description", "dueDate", "leadId" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" } } } ``` ### Output schema (structuredContent) ```json { "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" }, "title": { "type": "string", "minLength": 1, "maxLength": 2000 }, "description": { "anyOf": [ { "type": "string", "maxLength": 10000 }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "completedBy": { "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" } ] }, "outcome": { "anyOf": [ { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] }, { "type": "null" } ] }, "leadId": { "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" } ] }, "campaignContactId": { "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" } ] }, "campaignStepId": { "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" } ] }, "workflowRunId": { "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" } ] }, "workflow": { "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" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] }, "humanRequest": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "approval", "text" ] }, "question": { "$ref": "#/$defs/Description" } }, "required": [ "type", "question" ], "patternProperties": { "^(?!(?:type|question)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "question" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "choice" ] } ] }, "question": { "$ref": "#/$defs/Description" }, "options": { "type": "array", "items": { "$ref": "#/$defs/NonEmptyString" }, "maxItems": 20 } }, "required": [ "type", "question", "options" ], "patternProperties": { "^(?!(?:type|question|options)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "question", "options" ] } } ] }, { "type": "null" } ] }, "humanResponse": { "anyOf": [ { "anyOf": [ { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "approval" ] } ] }, "approved": { "type": "boolean" }, "comment": { "$ref": "#/$defs/ShortText" } }, "required": [ "type", "approved" ], "patternProperties": { "^(?!(?:type|approved|comment)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "approved", "comment" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] } ] }, "text": { "$ref": "#/$defs/Description" } }, "required": [ "type", "text" ], "patternProperties": { "^(?!(?:type|text)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "text" ] } }, { "type": "object", "properties": { "type": { "anyOf": [ { "type": "string", "enum": [ "choice" ] } ] }, "choice": { "$ref": "#/$defs/NonEmptyString" } }, "required": [ "type", "choice" ], "patternProperties": { "^(?!(?:type|choice)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "type", "choice" ] } } ] }, { "type": "null" } ] }, "requestState": { "anyOf": [ { "type": "string", "enum": [ "pending", "answered", "expired", "cancelled" ] }, { "type": "null" } ] }, "responseExpiresAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "requestedByAgentRegistrationId": { "anyOf": [ { "$ref": "#/$defs/OpaqueId" }, { "type": "null" } ] }, "operationId": { "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" } ] }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } } }, "createdBy": { "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" } ] }, "createdByUser": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } }, { "type": "null" } ] }, "completedByUser": { "anyOf": [ { "type": "object", "properties": { "userId": { "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": { "$ref": "#/$defs/ShortText" }, "email": { "$ref": "#/$defs/EmailAddress" }, "image": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inOrg": { "type": "boolean" } }, "required": [ "userId", "name", "email", "image", "inOrg" ], "patternProperties": { "^(?!(?:userId|name|email|image|inOrg)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "userId", "name", "email", "image", "inOrg" ] } }, { "type": "null" } ] }, "lead": { "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" }, "firstName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "firstName", "lastName", "companyName", "emailAddress", "phoneNumber" ], "patternProperties": { "^(?!(?:id|firstName|lastName|companyName|emailAddress|phoneNumber)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "firstName", "lastName", "companyName", "emailAddress", "phoneNumber" ] } }, { "type": "null" } ] }, "outcomeDetail": { "anyOf": [ { "type": "object", "properties": { "phoneOutcomes": { "type": "array", "items": { "type": "object", "properties": { "leadPhoneId": { "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" }, "outcome": { "type": "string", "enum": [ "no_luck", "responded", "bad_info" ] } }, "required": [ "leadPhoneId", "outcome" ], "patternProperties": { "^(?!(?:leadPhoneId|outcome)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "leadPhoneId", "outcome" ] } }, "maxItems": 50 } }, "required": [ "phoneOutcomes" ], "patternProperties": { "^(?!(?:phoneOutcomes)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "phoneOutcomes" ] } ] } }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "title", "description", "dueDate", "completedAt", "completedBy", "outcome", "leadId", "campaignContactId", "campaignStepId", "workflowRunId", "workflow", "humanRequest", "humanResponse", "requestState", "responseExpiresAt", "requestedByAgentRegistrationId", "operationId", "assignees", "createdBy", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|title|description|dueDate|completedAt|completedBy|outcome|leadId|campaignContactId|campaignStepId|workflowRunId|workflow|humanRequest|humanResponse|requestState|responseExpiresAt|requestedByAgentRegistrationId|operationId|assignees|createdBy|createdByUser|completedByUser|lead|outcomeDetail|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "title", "description", "dueDate", "completedAt", "completedBy", "outcome", "leadId", "campaignContactId", "campaignStepId", "workflowRunId", "workflow", "humanRequest", "humanResponse", "requestState", "responseExpiresAt", "requestedByAgentRegistrationId", "operationId", "assignees", "createdBy", "createdByUser", "completedByUser", "lead", "outcomeDetail", "createdAt", "updatedAt" ] }, "$defs": { "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" } } } ``` ### Underlying API operations - `tasks.update`: `PATCH /v1/workspaces/:workspaceId/tasks/:taskId` ## validate_campaign Run the launch prerequisite checks and return a structured report. Use before launch_campaign to see which prerequisites are missing without changing state. Validation never mutates the campaign; use preview_launch to bind a version. Scopes: campaign:read Risk: read; confirmation: none; idempotency: none. ### 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" }, "campaignId": { "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", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId" ] } } ``` ### 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" }, "campaignId": { "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", "campaignId" ], "patternProperties": { "^(?!(?:workspaceId|campaignId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "campaignId" ] } } ``` ### Output schema (structuredContent) ```json { "type": "object", "properties": { "campaignId": { "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" }, "ok": { "type": "boolean" }, "checks": { "type": "array", "items": { "type": "object", "properties": { "name": { "$ref": "#/$defs/NonEmptyString" }, "ok": { "type": "boolean" }, "detail": { "$ref": "#/$defs/ShortText" } }, "required": [ "name", "ok" ], "patternProperties": { "^(?!(?:name|ok|detail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "ok", "detail" ] } } }, "missing": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "campaignId", "ok", "checks", "missing" ], "patternProperties": { "^(?!(?:campaignId|ok|checks|missing)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "ok", "checks", "missing" ] }, "$defs": { "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Underlying API operations - `campaigns.validate`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/validate` ## verify_contacts Verify email addresses or phone numbers through the workspace's connected verifier waterfall; single calls confirm inline, bulk calls enqueue a durable run. Use when asked to check whether an email or phone is valid before sending; bulk accepts explicit lists or a campaign scope and returns an operation handle. Never verify without a connected workspace verifier key; the run bills the workspace's own provider account, so confirm spend before bulk submission. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: emailVerification:verify, phoneVerification:verify, emailVerification:read, phoneVerification:read Risk: costly; confirmation: explicit; 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" }, "channel": { "type": "string", "enum": [ "email", "phone" ] }, "mode": { "type": "string", "enum": [ "single", "bulk" ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "phone": { "$ref": "#/$defs/PhoneNumberInput" }, "emails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 10000 }, "phones": { "type": "array", "items": { "$ref": "#/$defs/PhoneNumberInput" }, "maxItems": 10000 }, "scope": { "type": "object", "properties": { "campaignId": { "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" }, "search": { "$ref": "#/$defs/ShortText" }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "campaignId" ], "patternProperties": { "^(?!(?:campaignId|search|assigneeUserIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "search", "assigneeUserIds" ] } }, "forceRecheck": { "type": "boolean" } }, "required": [ "workspaceId", "channel", "mode" ], "patternProperties": { "^(?!(?:workspaceId|channel|mode|email|phone|emails|phones|scope|forceRecheck)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "channel", "mode", "email", "phone", "emails", "phones", "scope", "forceRecheck" ] }, "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "PhoneNumberInput": { "type": "string", "minLength": 1, "maxLength": 64 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### 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" }, "channel": { "type": "string", "enum": [ "email", "phone" ] }, "mode": { "type": "string", "enum": [ "single", "bulk" ] }, "email": { "$ref": "#/$defs/EmailAddress" }, "phone": { "$ref": "#/$defs/PhoneNumberInput" }, "emails": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 10000 }, "phones": { "type": "array", "items": { "$ref": "#/$defs/PhoneNumberInput" }, "maxItems": 10000 }, "scope": { "type": "object", "properties": { "campaignId": { "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" }, "search": { "$ref": "#/$defs/ShortText" }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } } }, "required": [ "campaignId" ], "patternProperties": { "^(?!(?:campaignId|search|assigneeUserIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "search", "assigneeUserIds" ] } }, "forceRecheck": { "type": "boolean" } }, "required": [ "workspaceId", "channel", "mode" ], "patternProperties": { "^(?!(?:workspaceId|channel|mode|email|phone|emails|phones|scope|forceRecheck)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "channel", "mode", "email", "phone", "emails", "phones", "scope", "forceRecheck" ] }, "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "PhoneNumberInput": { "type": "string", "minLength": 1, "maxLength": 64 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "source": { "type": "string", "enum": [ "cache", "dns", "provider" ] }, "provider": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "flags": { "type": "object", "properties": { "role": { "type": "boolean" }, "disposable": { "type": "boolean" }, "spamtrap": { "type": "boolean" }, "freeProvider": { "type": "boolean" } }, "patternProperties": { "^(?!(?:role|disposable|spamtrap|freeProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "role", "disposable", "spamtrap", "freeProvider" ] } }, "verifiedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "fromCache": { "type": "boolean" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "resolved": { "type": "boolean" } }, "required": [ "providerId", "status", "rawStatus", "confidence", "resolved" ], "patternProperties": { "^(?!(?:providerId|status|rawStatus|confidence|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "rawStatus", "confidence", "resolved" ] } } } }, "required": [ "email", "status", "source", "provider", "confidence", "verifiedAt", "fromCache", "attempts" ], "patternProperties": { "^(?!(?:email|status|source|provider|confidence|flags|verifiedAt|fromCache|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "status", "source", "provider", "confidence", "flags", "verifiedAt", "fromCache", "attempts" ] } }, { "type": "object", "properties": { "phone": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] }, "source": { "type": "string", "enum": [ "cache", "format", "provider" ] }, "provider": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "flags": { "type": "object", "properties": { "lineType": { "type": "string", "enum": [ "mobile", "landline", "voip", "toll_free", "premium", "unknown" ] }, "carrier": { "$ref": "#/$defs/ShortText" }, "isPrepaid": { "type": "boolean" }, "activityScore": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "isLitigatorRisk": { "type": "boolean" }, "countryCode": { "$ref": "#/$defs/ShortText" }, "e164Format": { "$ref": "#/$defs/ShortText" } }, "patternProperties": { "^(?!(?:lineType|carrier|isPrepaid|activityScore|isLitigatorRisk|countryCode|e164Format)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format" ] } }, "verifiedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "fromCache": { "type": "boolean" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "resolved": { "type": "boolean" } }, "required": [ "providerId", "status", "rawStatus", "confidence", "resolved" ], "patternProperties": { "^(?!(?:providerId|status|rawStatus|confidence|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "rawStatus", "confidence", "resolved" ] } } } }, "required": [ "phone", "status", "source", "provider", "confidence", "verifiedAt", "fromCache", "attempts" ], "patternProperties": { "^(?!(?:phone|status|source|provider|confidence|flags|verifiedAt|fromCache|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phone", "status", "source", "provider", "confidence", "flags", "verifiedAt", "fromCache", "attempts" ] } }, { "type": "object", "properties": { "runId": { "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" }, "queued": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "capped": { "type": "boolean" }, "cap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "operation": { "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" ] } } }, "required": [ "runId", "queued", "capped", "cap", "operation" ], "patternProperties": { "^(?!(?:runId|queued|capped|cap|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "queued", "capped", "cap", "operation" ] } }, { "type": "object", "properties": { "runId": { "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" }, "operation": { "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" ] } } }, "required": [ "runId", "operation" ], "patternProperties": { "^(?!(?:runId|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "operation" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "email": { "$ref": "#/$defs/EmailAddress" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "source": { "type": "string", "enum": [ "cache", "dns", "provider" ] }, "provider": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "flags": { "type": "object", "properties": { "role": { "type": "boolean" }, "disposable": { "type": "boolean" }, "spamtrap": { "type": "boolean" }, "freeProvider": { "type": "boolean" } }, "patternProperties": { "^(?!(?:role|disposable|spamtrap|freeProvider)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "role", "disposable", "spamtrap", "freeProvider" ] } }, "verifiedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "fromCache": { "type": "boolean" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "resolved": { "type": "boolean" } }, "required": [ "providerId", "status", "rawStatus", "confidence", "resolved" ], "patternProperties": { "^(?!(?:providerId|status|rawStatus|confidence|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "rawStatus", "confidence", "resolved" ] } } } }, "required": [ "email", "status", "source", "provider", "confidence", "verifiedAt", "fromCache", "attempts" ], "patternProperties": { "^(?!(?:email|status|source|provider|confidence|flags|verifiedAt|fromCache|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "email", "status", "source", "provider", "confidence", "flags", "verifiedAt", "fromCache", "attempts" ] } }, { "type": "object", "properties": { "phone": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "unknown" ] }, "source": { "type": "string", "enum": [ "cache", "format", "provider" ] }, "provider": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "flags": { "type": "object", "properties": { "lineType": { "type": "string", "enum": [ "mobile", "landline", "voip", "toll_free", "premium", "unknown" ] }, "carrier": { "$ref": "#/$defs/ShortText" }, "isPrepaid": { "type": "boolean" }, "activityScore": { "anyOf": [ { "type": "number" }, { "type": "string", "enum": [ "Infinity", "-Infinity", "NaN" ] } ] }, "isLitigatorRisk": { "type": "boolean" }, "countryCode": { "$ref": "#/$defs/ShortText" }, "e164Format": { "$ref": "#/$defs/ShortText" } }, "patternProperties": { "^(?!(?:lineType|carrier|isPrepaid|activityScore|isLitigatorRisk|countryCode|e164Format)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "lineType", "carrier", "isPrepaid", "activityScore", "isLitigatorRisk", "countryCode", "e164Format" ] } }, "verifiedAt": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "fromCache": { "type": "boolean" }, "attempts": { "type": "array", "items": { "type": "object", "properties": { "providerId": { "$ref": "#/$defs/ShortText" }, "status": { "type": "string", "enum": [ "valid", "invalid", "catch-all", "unknown", "disposable", "role", "spamtrap" ] }, "rawStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "minimum": 0, "maximum": 100 }, { "type": "null" } ] }, "resolved": { "type": "boolean" } }, "required": [ "providerId", "status", "rawStatus", "confidence", "resolved" ], "patternProperties": { "^(?!(?:providerId|status|rawStatus|confidence|resolved)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "providerId", "status", "rawStatus", "confidence", "resolved" ] } } } }, "required": [ "phone", "status", "source", "provider", "confidence", "verifiedAt", "fromCache", "attempts" ], "patternProperties": { "^(?!(?:phone|status|source|provider|confidence|flags|verifiedAt|fromCache|attempts)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "phone", "status", "source", "provider", "confidence", "flags", "verifiedAt", "fromCache", "attempts" ] } }, { "type": "object", "properties": { "runId": { "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" }, "queued": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "capped": { "type": "boolean" }, "cap": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "operation": { "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" ] } } }, "required": [ "runId", "queued", "capped", "cap", "operation" ], "patternProperties": { "^(?!(?:runId|queued|capped|cap|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "queued", "capped", "cap", "operation" ] } }, { "type": "object", "properties": { "runId": { "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" }, "operation": { "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" ] } } }, "required": [ "runId", "operation" ], "patternProperties": { "^(?!(?:runId|operation)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "runId", "operation" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `emailVerification.single`: `POST /v1/workspaces/:workspaceId/verification/verify` - `emailVerification.bulk`: `POST /v1/workspaces/:workspaceId/verification/verify/bulk` - `emailVerification.status`: `GET /v1/workspaces/:workspaceId/verification/runs/:runId/status` - `phoneVerification.single`: `POST /v1/workspaces/:workspaceId/phone-verification/verify` - `phoneVerification.bulk`: `POST /v1/workspaces/:workspaceId/phone-verification/verify/bulk` - `phoneVerification.status`: `GET /v1/workspaces/:workspaceId/phone-verification/runs/:runId/status`