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