# MCP tool reference 1 callable tools. Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference. Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result. [Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt) ## 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`