read_campaign_setup
Read a workspace's campaigns and everything that describes how one is set up: its list row and current pause reason/context, inbox pool, custom fields, variable coverage, copy guidance, version history, and the public-holiday calendars a schedule can skip.
# 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)
## read_campaign_setup
Read a workspace's campaigns and everything that describes how one is set up: its list row and current pause reason/context, inbox pool, custom fields, variable coverage, copy guidance, version history, and the public-holiday calendars a schedule can skip.
Use before proposing any campaign change, so the plan is grounded in the campaign's real steps, senders, and personalization coverage.
Version detail includes authored copy in its stored JSON snapshot. It does not return contact records or sender credentials; use the audience tools for lead data.
Scopes: campaign:read, inbox:read, lead:read
Risk: read; confirmation: none; idempotency: none.
### Input schema (personal API key)
```json
{
"type": "object",
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"list"
]
},
"campaignFilter": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"all"
]
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode"
],
"patternProperties": {
"^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"campaigns"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode",
"ids"
],
"patternProperties": {
"^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"ids",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"tags"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode",
"ids"
],
"patternProperties": {
"^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"ids",
"match",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"folders"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode",
"ids"
],
"patternProperties": {
"^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"ids",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"names"
]
},
"terms": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode",
"terms"
],
"patternProperties": {
"^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"terms",
"match",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"rules"
]
},
"rules": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"campaigns"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"folders"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tags"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"names"
]
},
"terms": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"terms"
],
"patternProperties": {
"^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"terms",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tagged"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"filed"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"group"
]
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"rules": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"campaigns"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"folders"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tags"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"names"
]
},
"terms": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"terms"
],
"patternProperties": {
"^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"terms",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tagged"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"filed"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"group"
]
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"rules": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"campaigns"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"folders"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tags"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"names"
]
},
"terms": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"terms"
],
"patternProperties": {
"^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"terms",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tagged"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"filed"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
}
]
},
"maxItems": 20,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"rules"
],
"patternProperties": {
"^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"match",
"rules",
"exclude"
]
}
}
]
},
"maxItems": 20,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"rules"
],
"patternProperties": {
"^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"match",
"rules",
"exclude"
]
}
}
]
},
"maxItems": 20,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode",
"rules"
],
"patternProperties": {
"^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"rules",
"match",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
}
]
},
"offset": {
"type": "string"
},
"limit": {
"type": "string"
},
"search": {
"$ref": "#/$defs/ShortText"
},
"status": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"enum": [
"all"
]
}
]
},
{
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
}
]
},
"folderId": {
"anyOf": [
{
"type": "string",
"enum": [
"all",
"root"
]
},
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
]
},
"tagId": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"enum": [
"all"
]
}
]
},
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
]
},
"sortBy": {
"type": "string",
"enum": [
"name",
"createdAt",
"updatedAt"
]
},
"sortOrder": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"workspaceId"
],
"patternProperties": {
"^(?!(?:workspaceId|scope|campaignFilter|offset|limit|search|status|folderId|tagId|sortBy|sortOrder)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"scope",
"campaignFilter",
"offset",
"limit",
"search",
"status",
"folderId",
"tagId",
"sortBy",
"sortOrder"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"campaign"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"inboxes"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"custom_field_keys"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"variable_coverage"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"copy_context"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"explicit_inboxes"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"inbox_count"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"validate_copy"
]
},
"payload": {
"type": "object",
"properties": {
"subject": {
"anyOf": [
{
"type": "object",
"properties": {
"root": {
"$ref": "#/$defs/Union_"
}
},
"required": [
"root"
],
"patternProperties": {
"^(?!(?:root)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"root"
]
}
]
}
},
{
"type": "null"
}
]
},
"body": {
"anyOf": [
{
"type": "object",
"properties": {
"root": {
"$ref": "#/$defs/Union_"
}
},
"required": [
"root"
],
"patternProperties": {
"^(?!(?:root)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"root"
]
}
]
}
},
{
"type": "null"
}
]
},
"isFirstEmailStep": {
"type": "boolean"
}
},
"required": [
"subject",
"body",
"isFirstEmailStep"
],
"patternProperties": {
"^(?!(?:subject|body|isFirstEmailStep)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"subject",
"body",
"isFirstEmailStep"
]
}
}
},
"required": [
"workspaceId",
"campaignId",
"scope",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope|payload)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"payload"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"resolved_inboxes"
]
},
"draft": {
"type": "string",
"enum": [
"true",
"false"
]
},
"inboxIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 500
},
"tagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 50
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope|draft|inboxIds|tagIds)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"draft",
"inboxIds",
"tagIds"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"versions"
]
},
"cursor": {
"type": "string"
},
"limit": {
"type": "string"
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope|cursor|limit)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"cursor",
"limit"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"version"
]
},
"version": {
"type": "string"
}
},
"required": [
"workspaceId",
"campaignId",
"scope",
"version"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope|version)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"version"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"holiday_calendar"
]
},
"calendar": {
"$ref": "#/$defs/HolidayCalendarCode"
}
},
"required": [
"workspaceId",
"scope",
"calendar"
],
"patternProperties": {
"^(?!(?:workspaceId|scope|calendar)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"scope",
"calendar"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"holiday_range"
]
},
"holidayScope": {
"type": "string",
"enum": [
"selected",
"all"
]
},
"calendar": {
"$ref": "#/$defs/HolidayCalendarCode"
},
"from": {
"$ref": "#/$defs/LocalDate"
},
"to": {
"$ref": "#/$defs/LocalDate"
}
},
"required": [
"workspaceId",
"scope",
"holidayScope",
"from",
"to"
],
"patternProperties": {
"^(?!(?:workspaceId|scope|holidayScope|calendar|from|to)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"scope",
"holidayScope",
"calendar",
"from",
"to"
]
}
}
],
"$defs": {
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"Union_": {
"anyOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/Union_"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/Union_"
}
}
]
},
"HolidayCalendarCode": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"LocalDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Target Workspace UUID. Call list_workspaces to enumerate the Workspaces this credential may access, then pass the chosen id here."
}
},
"required": [
"workspaceId"
],
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"list"
]
},
"campaignFilter": {
"anyOf": [
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"all"
]
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode"
],
"patternProperties": {
"^(?!(?:mode|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"campaigns"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode",
"ids"
],
"patternProperties": {
"^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"ids",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"tags"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode",
"ids"
],
"patternProperties": {
"^(?!(?:mode|ids|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"ids",
"match",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"folders"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode",
"ids"
],
"patternProperties": {
"^(?!(?:mode|ids|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"ids",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"names"
]
},
"terms": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode",
"terms"
],
"patternProperties": {
"^(?!(?:mode|terms|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"terms",
"match",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
},
{
"type": "object",
"properties": {
"mode": {
"type": "string",
"enum": [
"rules"
]
},
"rules": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"campaigns"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"folders"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tags"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"names"
]
},
"terms": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"terms"
],
"patternProperties": {
"^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"terms",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tagged"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"filed"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"group"
]
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"rules": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"campaigns"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"folders"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tags"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"names"
]
},
"terms": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"terms"
],
"patternProperties": {
"^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"terms",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tagged"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"filed"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"group"
]
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"rules": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"campaigns"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"folders"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tags"
]
},
"ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"ids"
],
"patternProperties": {
"^(?!(?:field|ids|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"ids",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"names"
]
},
"terms": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"terms"
],
"patternProperties": {
"^(?!(?:field|terms|match|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"terms",
"match",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"tagged"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
},
{
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"filed"
]
},
"value": {
"type": "boolean"
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"value"
],
"patternProperties": {
"^(?!(?:field|value|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"value",
"exclude"
]
}
}
]
},
"maxItems": 20,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"rules"
],
"patternProperties": {
"^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"match",
"rules",
"exclude"
]
}
}
]
},
"maxItems": 20,
"minItems": 1
},
"exclude": {
"type": "boolean"
}
},
"required": [
"field",
"rules"
],
"patternProperties": {
"^(?!(?:field|match|rules|exclude)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"match",
"rules",
"exclude"
]
}
}
]
},
"maxItems": 20,
"minItems": 1
},
"match": {
"type": "string",
"enum": [
"any",
"all"
]
},
"excludeCampaignIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeTagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeFolderIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 100
},
"excludeNameContains": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"maxItems": 20
},
"taggedOnly": {
"type": "boolean"
},
"filedOnly": {
"type": "boolean"
}
},
"required": [
"mode",
"rules"
],
"patternProperties": {
"^(?!(?:mode|rules|match|excludeCampaignIds|excludeTagIds|excludeFolderIds|excludeNameContains|taggedOnly|filedOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"mode",
"rules",
"match",
"excludeCampaignIds",
"excludeTagIds",
"excludeFolderIds",
"excludeNameContains",
"taggedOnly",
"filedOnly"
]
}
}
]
},
"offset": {
"type": "string"
},
"limit": {
"type": "string"
},
"search": {
"$ref": "#/$defs/ShortText"
},
"status": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"enum": [
"all"
]
}
]
},
{
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
}
]
},
"folderId": {
"anyOf": [
{
"type": "string",
"enum": [
"all",
"root"
]
},
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
]
},
"tagId": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"enum": [
"all"
]
}
]
},
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
]
},
"sortBy": {
"type": "string",
"enum": [
"name",
"createdAt",
"updatedAt"
]
},
"sortOrder": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"required": [
"workspaceId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|campaignFilter|offset|limit|search|status|folderId|tagId|sortBy|sortOrder)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"scope",
"campaignFilter",
"offset",
"limit",
"search",
"status",
"folderId",
"tagId",
"sortBy",
"sortOrder"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"campaign"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"inboxes"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"custom_field_keys"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"variable_coverage"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"copy_context"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"explicit_inboxes"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"inbox_count"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"validate_copy"
]
},
"payload": {
"type": "object",
"properties": {
"subject": {
"anyOf": [
{
"type": "object",
"properties": {
"root": {
"$ref": "#/$defs/Union_"
}
},
"required": [
"root"
],
"patternProperties": {
"^(?!(?:root)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"root"
]
}
]
}
},
{
"type": "null"
}
]
},
"body": {
"anyOf": [
{
"type": "object",
"properties": {
"root": {
"$ref": "#/$defs/Union_"
}
},
"required": [
"root"
],
"patternProperties": {
"^(?!(?:root)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"root"
]
}
]
}
},
{
"type": "null"
}
]
},
"isFirstEmailStep": {
"type": "boolean"
}
},
"required": [
"subject",
"body",
"isFirstEmailStep"
],
"patternProperties": {
"^(?!(?:subject|body|isFirstEmailStep)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"subject",
"body",
"isFirstEmailStep"
]
}
}
},
"required": [
"workspaceId",
"campaignId",
"scope",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|payload)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"payload"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"resolved_inboxes"
]
},
"draft": {
"type": "string",
"enum": [
"true",
"false"
]
},
"inboxIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 500
},
"tagIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"maxItems": 50
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|draft|inboxIds|tagIds)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"draft",
"inboxIds",
"tagIds"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"versions"
]
},
"cursor": {
"type": "string"
},
"limit": {
"type": "string"
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|cursor|limit)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"cursor",
"limit"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"version"
]
},
"version": {
"type": "string"
}
},
"required": [
"workspaceId",
"campaignId",
"scope",
"version"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|version)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"version"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"holiday_calendar"
]
},
"calendar": {
"$ref": "#/$defs/HolidayCalendarCode"
}
},
"required": [
"workspaceId",
"scope",
"calendar"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|calendar)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"scope",
"calendar"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"holiday_range"
]
},
"holidayScope": {
"type": "string",
"enum": [
"selected",
"all"
]
},
"calendar": {
"$ref": "#/$defs/HolidayCalendarCode"
},
"from": {
"$ref": "#/$defs/LocalDate"
},
"to": {
"$ref": "#/$defs/LocalDate"
}
},
"required": [
"workspaceId",
"scope",
"holidayScope",
"from",
"to"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|scope|holidayScope|calendar|from|to)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"scope",
"holidayScope",
"calendar",
"from",
"to"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
}
],
"$defs": {
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"Union_": {
"anyOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/Union_"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/Union_"
}
}
]
},
"HolidayCalendarCode": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"LocalDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
}
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"EmailAddress": {
"type": "string",
"minLength": 3,
"maxLength": 320,
"pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
},
"IanaTimeZone": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$"
},
"HolidayCalendarCode": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"Description": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"Union_": {
"anyOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/Union_"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/Union_"
}
}
]
},
"AuthoredCampaignSnapshot": {
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/Union_"
}
},
"LocalDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
},
"pauseContext": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"manual"
]
}
]
},
"pausedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"user"
]
}
]
},
"evidence": {
"type": "null"
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
},
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"bounce_threshold"
]
}
]
},
"pausedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"system"
]
}
]
},
"evidence": {
"type": "object",
"properties": {
"thresholdPercent": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"bounceRatePercent": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"sentCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"bouncedCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recipientBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"senderBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unclassifiedBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"campaign_lifetime"
]
}
]
}
},
"required": [
"thresholdPercent",
"bounceRatePercent",
"sentCount",
"bouncedCount",
"recipientBounceCount",
"senderBounceCount",
"unclassifiedBounceCount",
"scope"
],
"patternProperties": {
"^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"thresholdPercent",
"bounceRatePercent",
"sentCount",
"bouncedCount",
"recipientBounceCount",
"senderBounceCount",
"unclassifiedBounceCount",
"scope"
]
}
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
},
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"unknown"
]
}
]
},
"pausedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"unknown"
]
}
]
},
"evidence": {
"type": "null"
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
}
],
"description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution."
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"color": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"color"
],
"patternProperties": {
"^(?!(?:id|name|color)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"color"
]
}
}
},
"sentCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"replyCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"bounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recipientBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"senderBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unclassifiedBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"updatedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"name",
"status",
"folderId",
"tags",
"sentCount",
"replyCount",
"createdAt",
"updatedAt"
],
"patternProperties": {
"^(?!(?:id|name|status|pauseContext|folderId|tags|sentCount|replyCount|bounceCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|createdAt|updatedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"status",
"pauseContext",
"folderId",
"tags",
"sentCount",
"replyCount",
"bounceCount",
"recipientBounceCount",
"senderBounceCount",
"unclassifiedBounceCount",
"createdAt",
"updatedAt"
]
}
}
},
"pagination": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"offset",
"limit",
"total"
],
"patternProperties": {
"^(?!(?:offset|limit|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit",
"total"
]
}
}
},
"required": [
"items",
"pagination"
],
"patternProperties": {
"^(?!(?:items|pagination)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"pagination"
]
}
},
{
"type": "object",
"properties": {
"campaign": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
},
"pauseContext": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"manual"
]
}
]
},
"pausedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"user"
]
}
]
},
"evidence": {
"type": "null"
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
},
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"bounce_threshold"
]
}
]
},
"pausedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"system"
]
}
]
},
"evidence": {
"type": "object",
"properties": {
"thresholdPercent": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"bounceRatePercent": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"sentCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"bouncedCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recipientBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"senderBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unclassifiedBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"campaign_lifetime"
]
}
]
}
},
"required": [
"thresholdPercent",
"bounceRatePercent",
"sentCount",
"bouncedCount",
"recipientBounceCount",
"senderBounceCount",
"unclassifiedBounceCount",
"scope"
],
"patternProperties": {
"^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"thresholdPercent",
"bounceRatePercent",
"sentCount",
"bouncedCount",
"recipientBounceCount",
"senderBounceCount",
"unclassifiedBounceCount",
"scope"
]
}
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
},
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"unknown"
]
}
]
},
"pausedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"unknown"
]
}
]
},
"evidence": {
"type": "null"
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
}
],
"description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution."
},
{
"type": "null"
}
]
},
"kind": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"currentVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"inboxCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"contactCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"updatedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"workspaceId",
"name",
"status",
"kind",
"currentVersion",
"inboxCount",
"contactCount",
"createdAt",
"updatedAt"
],
"patternProperties": {
"^(?!(?:id|workspaceId|name|status|pauseContext|kind|currentVersion|inboxCount|contactCount|createdAt|updatedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"workspaceId",
"name",
"status",
"pauseContext",
"kind",
"currentVersion",
"inboxCount",
"contactCount",
"createdAt",
"updatedAt"
]
}
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"type": {
"type": "string",
"enum": [
"email_content",
"manual_review",
"linked_in_connection_request",
"linked_in_in_mail",
"phone_call",
"text_message",
"http_post_request",
"attio_task",
"heyreach_campaign"
]
},
"enabled": {
"type": "boolean"
}
},
"required": [
"id",
"type",
"enabled"
],
"patternProperties": {
"^(?!(?:id|type|enabled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"type",
"enabled"
]
}
}
},
"parentCampaignId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"scheduleProfileId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"color": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"color"
],
"patternProperties": {
"^(?!(?:id|name|color)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"color"
]
}
}
},
"settings": {
"type": "object",
"properties": {
"newLeadPriority": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"espMatchMode": {
"type": "string",
"enum": [
"off",
"match_then_spill",
"match_only"
]
},
"opportunityValue": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"stopSendingOnReply": {
"type": "boolean"
},
"continueSendingOnAutomaticReply": {
"type": "boolean"
},
"defaultDelayDaysForAutomaticReply": {
"type": "integer",
"exclusiveMinimum": 0
},
"stopSendingOnSameDomainReply": {
"type": "boolean"
},
"openRateTracking": {
"type": "boolean"
},
"unsubscribeLink": {
"type": "boolean"
},
"addUnsubscribedLeadsToBlockList": {
"type": "boolean"
},
"sendAsPlainText": {
"type": "boolean"
},
"sendRiskyEmails": {
"type": "boolean"
},
"skipSegEmails": {
"type": "boolean"
},
"autoPauseOnHighBounceRate": {
"type": "boolean"
},
"continueOnSoftBounce": {
"type": "boolean"
},
"softBounceMonitoringDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
},
"highBounceRateThreshold": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"fallbackSendingForRemovedInboxes": {
"type": "boolean"
},
"fallbackSendingForErroredInboxes": {
"type": "boolean"
},
"dailyCapPerRecipientDomain": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"waterfallEnabled": {
"type": "boolean"
},
"waterfallPassGapDays": {
"type": "integer",
"minimum": 1,
"maximum": 90
},
"waterfallResponseFreeze": {
"type": "string",
"enum": [
"freeze_ladder",
"contact_only"
]
},
"quotedChainAttribution": {
"type": "string",
"enum": [
"current_sender",
"original"
]
},
"ignoreInboxSendLimits": {
"type": "boolean"
},
"ccEmails": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/EmailAddress"
},
"maxItems": 5
},
{
"type": "null"
}
]
},
"initialDelayMinutes": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 43200
},
{
"type": "null"
}
]
}
},
"required": [
"newLeadPriority",
"espMatchMode",
"opportunityValue",
"stopSendingOnReply",
"continueSendingOnAutomaticReply",
"defaultDelayDaysForAutomaticReply",
"stopSendingOnSameDomainReply",
"openRateTracking",
"unsubscribeLink",
"addUnsubscribedLeadsToBlockList",
"sendAsPlainText",
"sendRiskyEmails",
"skipSegEmails",
"autoPauseOnHighBounceRate",
"continueOnSoftBounce",
"softBounceMonitoringDays",
"highBounceRateThreshold",
"fallbackSendingForRemovedInboxes",
"fallbackSendingForErroredInboxes",
"dailyCapPerRecipientDomain",
"waterfallEnabled",
"waterfallPassGapDays",
"waterfallResponseFreeze",
"quotedChainAttribution",
"ignoreInboxSendLimits",
"ccEmails",
"initialDelayMinutes"
],
"patternProperties": {
"^(?!(?:newLeadPriority|espMatchMode|opportunityValue|stopSendingOnReply|continueSendingOnAutomaticReply|defaultDelayDaysForAutomaticReply|stopSendingOnSameDomainReply|openRateTracking|unsubscribeLink|addUnsubscribedLeadsToBlockList|sendAsPlainText|sendRiskyEmails|skipSegEmails|autoPauseOnHighBounceRate|continueOnSoftBounce|softBounceMonitoringDays|highBounceRateThreshold|fallbackSendingForRemovedInboxes|fallbackSendingForErroredInboxes|dailyCapPerRecipientDomain|waterfallEnabled|waterfallPassGapDays|waterfallResponseFreeze|quotedChainAttribution|ignoreInboxSendLimits|ccEmails|initialDelayMinutes)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"newLeadPriority",
"espMatchMode",
"opportunityValue",
"stopSendingOnReply",
"continueSendingOnAutomaticReply",
"defaultDelayDaysForAutomaticReply",
"stopSendingOnSameDomainReply",
"openRateTracking",
"unsubscribeLink",
"addUnsubscribedLeadsToBlockList",
"sendAsPlainText",
"sendRiskyEmails",
"skipSegEmails",
"autoPauseOnHighBounceRate",
"continueOnSoftBounce",
"softBounceMonitoringDays",
"highBounceRateThreshold",
"fallbackSendingForRemovedInboxes",
"fallbackSendingForErroredInboxes",
"dailyCapPerRecipientDomain",
"waterfallEnabled",
"waterfallPassGapDays",
"waterfallResponseFreeze",
"quotedChainAttribution",
"ignoreInboxSendLimits",
"ccEmails",
"initialDelayMinutes"
]
}
},
"schedule": {
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scheduleVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"scheduleProfileId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"defaultTimezone": {
"$ref": "#/$defs/IanaTimeZone"
},
"daysOfWeek": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
}
},
{
"type": "null"
}
]
},
"startDate": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"endDate": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"unixStartTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86400
},
{
"type": "null"
}
]
},
"unixEndTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86400
},
{
"type": "null"
}
]
},
"useAdvancedSchedule": {
"type": "boolean"
},
"weeklySchedule": {
"anyOf": [
{
"type": "object",
"properties": {
"monday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"tuesday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"wednesday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"thursday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"friday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"saturday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"sunday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
}
},
"patternProperties": {
"^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
}
},
{
"type": "null"
}
]
},
"skipHolidays": {
"type": "boolean"
},
"holidayCalendar": {
"anyOf": [
{
"$ref": "#/$defs/HolidayCalendarCode"
},
{
"type": "null"
}
]
},
"respectLeadTimezone": {
"type": "boolean"
},
"timezoneFallbackPolicy": {
"type": "string",
"enum": [
"campaign_default",
"hold"
]
},
"maxEmailsPerDay": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"maxNewLeadsPerDay": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"rampUpEnabled": {
"type": "boolean"
},
"rampUpInitialDailyLimit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"rampUpDailyIncrement": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"rampUpCompletedSendingDays": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"effectiveMaxEmailsPerDay": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"campaignId",
"scheduleVersion",
"scheduleProfileId",
"defaultTimezone",
"daysOfWeek",
"startDate",
"endDate",
"unixStartTime",
"unixEndTime",
"useAdvancedSchedule",
"weeklySchedule",
"skipHolidays",
"holidayCalendar",
"respectLeadTimezone",
"timezoneFallbackPolicy",
"maxEmailsPerDay",
"maxNewLeadsPerDay",
"rampUpEnabled",
"rampUpInitialDailyLimit",
"rampUpDailyIncrement",
"rampUpCompletedSendingDays",
"effectiveMaxEmailsPerDay"
],
"patternProperties": {
"^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"scheduleVersion",
"scheduleProfileId",
"defaultTimezone",
"daysOfWeek",
"startDate",
"endDate",
"unixStartTime",
"unixEndTime",
"useAdvancedSchedule",
"weeklySchedule",
"skipHolidays",
"holidayCalendar",
"respectLeadTimezone",
"timezoneFallbackPolicy",
"maxEmailsPerDay",
"maxNewLeadsPerDay",
"rampUpEnabled",
"rampUpInitialDailyLimit",
"rampUpDailyIncrement",
"rampUpCompletedSendingDays",
"effectiveMaxEmailsPerDay"
]
}
},
"customFieldKeys": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"sequenceRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"initialDelayMinutes": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"campaign",
"steps"
],
"patternProperties": {
"^(?!(?:campaign|steps|parentCampaignId|folderId|scheduleProfileId|tags|settings|schedule|customFieldKeys|sequenceRevision|initialDelayMinutes)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaign",
"steps",
"parentCampaignId",
"folderId",
"scheduleProfileId",
"tags",
"settings",
"schedule",
"customFieldKeys",
"sequenceRevision",
"initialDelayMinutes"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"campaignId",
"inboxId"
],
"patternProperties": {
"^(?!(?:campaignId|inboxId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"inboxId"
]
}
}
}
},
"required": [
"items"
],
"patternProperties": {
"^(?!(?:items)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"items"
]
}
]
}
},
{
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"keys": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
}
},
"required": [
"campaignId",
"keys"
],
"patternProperties": {
"^(?!(?:campaignId|keys)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"keys"
]
}
},
{
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"coverage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variable": {
"$ref": "#/$defs/ShortText"
},
"nonEmpty": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"state": {
"type": "string",
"enum": [
"all",
"some",
"none"
]
}
},
"required": [
"variable",
"nonEmpty",
"state"
],
"patternProperties": {
"^(?!(?:variable|nonEmpty|state)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"variable",
"nonEmpty",
"state"
]
}
}
},
"sender": {
"anyOf": [
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"coverage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variable": {
"$ref": "#/$defs/ShortText"
},
"nonEmpty": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"state": {
"type": "string",
"enum": [
"all",
"some",
"none"
]
}
},
"required": [
"variable",
"nonEmpty",
"state"
],
"patternProperties": {
"^(?!(?:variable|nonEmpty|state)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"variable",
"nonEmpty",
"state"
]
}
}
}
},
"required": [
"total",
"coverage"
],
"patternProperties": {
"^(?!(?:total|coverage)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"total",
"coverage"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"campaignId",
"total",
"coverage",
"sender"
],
"patternProperties": {
"^(?!(?:campaignId|total|coverage|sender)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"total",
"coverage",
"sender"
]
}
},
{
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"syntax": {
"type": "object",
"properties": {
"liquidTags": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"liquidFilters": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"editorNodeTypes": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"unsupportedEditorNodeTypes": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"spintaxCommands": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"spintaxMaximumOptions": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"examples": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"$ref": "#/$defs/ShortText"
},
"template": {
"$ref": "#/$defs/Description"
}
},
"required": [
"label",
"template"
],
"patternProperties": {
"^(?!(?:label|template)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"label",
"template"
]
}
}
},
"rules": {
"type": "array",
"items": {
"$ref": "#/$defs/Description"
}
}
},
"required": [
"liquidTags",
"liquidFilters",
"editorNodeTypes",
"unsupportedEditorNodeTypes",
"spintaxCommands",
"spintaxMaximumOptions",
"examples",
"rules"
],
"patternProperties": {
"^(?!(?:liquidTags|liquidFilters|editorNodeTypes|unsupportedEditorNodeTypes|spintaxCommands|spintaxMaximumOptions|examples|rules)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"liquidTags",
"liquidFilters",
"editorNodeTypes",
"unsupportedEditorNodeTypes",
"spintaxCommands",
"spintaxMaximumOptions",
"examples",
"rules"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"$ref": "#/$defs/ShortText"
},
"type": {
"type": "string",
"enum": [
"lead",
"custom",
"platform",
"organization",
"thread",
"sender",
"unknown"
]
},
"syntax": {
"$ref": "#/$defs/ShortText"
},
"description": {
"$ref": "#/$defs/Description"
},
"bodyOnly": {
"type": "boolean"
}
},
"required": [
"name",
"type",
"syntax",
"description",
"bodyOnly"
],
"patternProperties": {
"^(?!(?:name|type|syntax|description|bodyOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"syntax",
"description",
"bodyOnly"
]
}
}
},
"customFieldKeys": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"organizationVariableKeys": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"totalContacts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"coverageStatus": {
"type": "string",
"enum": [
"checked",
"no_contacts"
]
},
"senderCoverage": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"checked",
"no_inboxes",
"unavailable"
]
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"total"
],
"patternProperties": {
"^(?!(?:status|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"status",
"total"
]
}
},
"isSubsequence": {
"type": "boolean"
},
"instruction": {
"$ref": "#/$defs/Description"
}
},
"required": [
"campaignId",
"syntax",
"variables",
"customFieldKeys",
"organizationVariableKeys",
"totalContacts",
"coverageStatus",
"senderCoverage",
"isSubsequence",
"instruction"
],
"patternProperties": {
"^(?!(?:campaignId|syntax|variables|customFieldKeys|organizationVariableKeys|totalContacts|coverageStatus|senderCoverage|isSubsequence|instruction)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"syntax",
"variables",
"customFieldKeys",
"organizationVariableKeys",
"totalContacts",
"coverageStatus",
"senderCoverage",
"isSubsequence",
"instruction"
]
}
},
{
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"valid",
"needs_review",
"invalid"
]
},
"syntaxValid": {
"type": "boolean"
},
"totalContacts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"coverageStatus": {
"type": "string",
"enum": [
"checked",
"no_contacts"
]
},
"senderCoverage": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"checked",
"no_inboxes",
"unavailable"
]
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"total"
],
"patternProperties": {
"^(?!(?:status|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"status",
"total"
]
}
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"subject",
"body"
]
},
"syntaxValid": {
"type": "boolean"
},
"syntaxMessage": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
]
},
"renderCase": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"$ref": "#/$defs/ShortText"
},
"type": {
"type": "string",
"enum": [
"lead",
"custom",
"platform",
"organization",
"thread",
"sender",
"unknown"
]
},
"isDefined": {
"type": "boolean"
},
"hasFallback": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"all",
"some",
"none",
"undefined",
"always",
"nullable",
"unknown",
"no_inboxes",
"no_prior_email",
"body_only"
]
},
"severity": {
"type": "string",
"enum": [
"ok",
"warn",
"error"
]
},
"coverage": {
"anyOf": [
{
"type": "object",
"properties": {
"nonEmpty": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"nonEmpty",
"total"
],
"patternProperties": {
"^(?!(?:nonEmpty|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"nonEmpty",
"total"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"type",
"isDefined",
"hasFallback",
"state",
"severity",
"coverage"
],
"patternProperties": {
"^(?!(?:name|type|isDefined|hasFallback|state|severity|coverage)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"isDefined",
"hasFallback",
"state",
"severity",
"coverage"
]
}
}
}
},
"required": [
"field",
"syntaxValid",
"syntaxMessage",
"renderCase",
"variables"
],
"patternProperties": {
"^(?!(?:field|syntaxValid|syntaxMessage|renderCase|variables)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"syntaxValid",
"syntaxMessage",
"renderCase",
"variables"
]
}
}
}
},
"required": [
"campaignId",
"status",
"syntaxValid",
"totalContacts",
"coverageStatus",
"senderCoverage",
"fields"
],
"patternProperties": {
"^(?!(?:campaignId|status|syntaxValid|totalContacts|coverageStatus|senderCoverage|fields)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"status",
"syntaxValid",
"totalContacts",
"coverageStatus",
"senderCoverage",
"fields"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
},
"provider": {
"$ref": "#/$defs/ShortText"
},
"status": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"id",
"emailAddress",
"provider",
"status"
],
"patternProperties": {
"^(?!(?:id|emailAddress|provider|status)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress",
"provider",
"status"
]
}
}
}
},
"required": [
"items"
],
"patternProperties": {
"^(?!(?:items)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"items"
]
}
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
},
"provider": {
"$ref": "#/$defs/ShortText"
},
"status": {
"$ref": "#/$defs/ShortText"
},
"explicit": {
"type": "boolean"
},
"viaTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"color": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"color"
],
"patternProperties": {
"^(?!(?:id|name|color)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"color"
]
}
}
}
},
"required": [
"id",
"emailAddress",
"provider",
"status",
"explicit",
"viaTags"
],
"patternProperties": {
"^(?!(?:id|emailAddress|provider|status|explicit|viaTags)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress",
"provider",
"status",
"explicit",
"viaTags"
]
}
}
}
},
"required": [
"items"
],
"patternProperties": {
"^(?!(?:items)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"items"
]
}
]
}
},
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"count"
],
"patternProperties": {
"^(?!(?:count)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"count"
]
}
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"source": {
"type": "string",
"enum": [
"baseline",
"created",
"duplicated",
"details",
"status",
"launched",
"settings",
"schedule",
"schedule_profile_propagated",
"sequence",
"step_toggle",
"subsequence_triggers",
"restored",
"system"
]
},
"campaignStatus": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
},
"name": {
"$ref": "#/$defs/ShortText"
},
"stepCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"actor": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user",
"api_key",
"system"
]
},
"userId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"$ref": "#/$defs/EmailAddress"
},
{
"type": "null"
}
]
}
},
"required": [
"type",
"userId",
"name",
"email"
],
"patternProperties": {
"^(?!(?:type|userId|name|email)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"type",
"userId",
"name",
"email"
]
}
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"campaignId",
"version",
"source",
"campaignStatus",
"name",
"stepCount",
"actor",
"createdAt"
],
"patternProperties": {
"^(?!(?:campaignId|version|source|campaignStatus|name|stepCount|actor|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"version",
"source",
"campaignStatus",
"name",
"stepCount",
"actor",
"createdAt"
]
}
}
},
"totalCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"nextCursor": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"totalCount",
"nextCursor"
],
"patternProperties": {
"^(?!(?:items|totalCount|nextCursor)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"totalCount",
"nextCursor"
]
}
},
{
"type": "object",
"properties": {
"record": {
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"source": {
"type": "string",
"enum": [
"baseline",
"created",
"duplicated",
"details",
"status",
"launched",
"settings",
"schedule",
"schedule_profile_propagated",
"sequence",
"step_toggle",
"subsequence_triggers",
"restored",
"system"
]
},
"campaignStatus": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
},
"name": {
"$ref": "#/$defs/ShortText"
},
"stepCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"actor": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user",
"api_key",
"system"
]
},
"userId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"$ref": "#/$defs/EmailAddress"
},
{
"type": "null"
}
]
}
},
"required": [
"type",
"userId",
"name",
"email"
],
"patternProperties": {
"^(?!(?:type|userId|name|email)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"type",
"userId",
"name",
"email"
]
}
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"campaignId",
"version",
"source",
"campaignStatus",
"name",
"stepCount",
"actor",
"createdAt"
],
"patternProperties": {
"^(?!(?:campaignId|version|source|campaignStatus|name|stepCount|actor|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"version",
"source",
"campaignStatus",
"name",
"stepCount",
"actor",
"createdAt"
]
}
},
"snapshotSchemaVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"contentHash": {
"$ref": "#/$defs/ShortText"
},
"snapshot": {
"type": "object",
"properties": {
"schemaVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"campaignName": {
"$ref": "#/$defs/ShortText"
},
"campaignStatus": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
},
"scheduleProfileName": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"inboxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
}
},
"required": [
"id",
"emailAddress"
],
"patternProperties": {
"^(?!(?:id|emailAddress)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress"
]
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"color": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"color"
],
"patternProperties": {
"^(?!(?:id|name|color)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"color"
]
}
}
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"stepId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"stepOrder": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"variantOrder": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"type": {
"$ref": "#/$defs/ShortText"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"id",
"stepId",
"stepOrder",
"variantOrder",
"type",
"enabled"
],
"patternProperties": {
"^(?!(?:id|stepId|stepOrder|variantOrder|type|enabled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"stepId",
"stepOrder",
"variantOrder",
"type",
"enabled"
]
}
}
},
"subsequenceTriggerCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"schemaVersion",
"campaignName",
"campaignStatus",
"scheduleProfileName",
"inboxes",
"tags",
"steps",
"subsequenceTriggerCount"
],
"patternProperties": {
"^(?!(?:schemaVersion|campaignName|campaignStatus|scheduleProfileName|inboxes|tags|steps|subsequenceTriggerCount)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"schemaVersion",
"campaignName",
"campaignStatus",
"scheduleProfileName",
"inboxes",
"tags",
"steps",
"subsequenceTriggerCount"
]
}
},
"authoredSnapshot": {
"$ref": "#/$defs/AuthoredCampaignSnapshot"
}
},
"required": [
"record",
"snapshotSchemaVersion",
"contentHash",
"snapshot"
],
"patternProperties": {
"^(?!(?:record|snapshotSchemaVersion|contentHash|snapshot|authoredSnapshot)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"record",
"snapshotSchemaVersion",
"contentHash",
"snapshot",
"authoredSnapshot"
]
}
},
{
"type": "object",
"properties": {
"calendar": {
"$ref": "#/$defs/HolidayCalendarCode"
},
"year": {
"type": "integer",
"minimum": 1970,
"maximum": 2999
},
"holidays": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"$ref": "#/$defs/LocalDate"
},
"name": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"date",
"name"
],
"patternProperties": {
"^(?!(?:date|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"date",
"name"
]
}
}
}
},
"required": [
"calendar",
"year",
"holidays"
],
"patternProperties": {
"^(?!(?:calendar|year|holidays)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"calendar",
"year",
"holidays"
]
}
},
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"selected",
"all"
]
},
"days": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"$ref": "#/$defs/LocalDate"
},
"observances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"calendarCode": {
"$ref": "#/$defs/HolidayCalendarCode"
},
"calendarName": {
"$ref": "#/$defs/ShortText"
},
"name": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"calendarCode",
"calendarName",
"name"
],
"patternProperties": {
"^(?!(?:calendarCode|calendarName|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"calendarCode",
"calendarName",
"name"
]
}
}
}
},
"required": [
"date",
"observances"
],
"patternProperties": {
"^(?!(?:date|observances)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"date",
"observances"
]
}
}
}
},
"required": [
"scope",
"days"
],
"patternProperties": {
"^(?!(?:scope|days)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"scope",
"days"
]
}
}
]
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
},
"pauseContext": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"manual"
]
}
]
},
"pausedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"user"
]
}
]
},
"evidence": {
"type": "null"
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
},
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"bounce_threshold"
]
}
]
},
"pausedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"system"
]
}
]
},
"evidence": {
"type": "object",
"properties": {
"thresholdPercent": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"bounceRatePercent": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"sentCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"bouncedCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recipientBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"senderBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unclassifiedBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"campaign_lifetime"
]
}
]
}
},
"required": [
"thresholdPercent",
"bounceRatePercent",
"sentCount",
"bouncedCount",
"recipientBounceCount",
"senderBounceCount",
"unclassifiedBounceCount",
"scope"
],
"patternProperties": {
"^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"thresholdPercent",
"bounceRatePercent",
"sentCount",
"bouncedCount",
"recipientBounceCount",
"senderBounceCount",
"unclassifiedBounceCount",
"scope"
]
}
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
},
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"unknown"
]
}
]
},
"pausedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"unknown"
]
}
]
},
"evidence": {
"type": "null"
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
}
],
"description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution."
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"color": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"color"
],
"patternProperties": {
"^(?!(?:id|name|color)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"color"
]
}
}
},
"sentCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"replyCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"bounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recipientBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"senderBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unclassifiedBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"updatedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"name",
"status",
"folderId",
"tags",
"sentCount",
"replyCount",
"createdAt",
"updatedAt"
],
"patternProperties": {
"^(?!(?:id|name|status|pauseContext|folderId|tags|sentCount|replyCount|bounceCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|createdAt|updatedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"status",
"pauseContext",
"folderId",
"tags",
"sentCount",
"replyCount",
"bounceCount",
"recipientBounceCount",
"senderBounceCount",
"unclassifiedBounceCount",
"createdAt",
"updatedAt"
]
}
}
},
"pagination": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"offset",
"limit",
"total"
],
"patternProperties": {
"^(?!(?:offset|limit|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"offset",
"limit",
"total"
]
}
}
},
"required": [
"items",
"pagination"
],
"patternProperties": {
"^(?!(?:items|pagination)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"pagination"
]
}
},
{
"type": "object",
"properties": {
"campaign": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"status": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
},
"pauseContext": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"manual"
]
}
]
},
"pausedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"user"
]
}
]
},
"evidence": {
"type": "null"
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
},
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"bounce_threshold"
]
}
]
},
"pausedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"system"
]
}
]
},
"evidence": {
"type": "object",
"properties": {
"thresholdPercent": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"bounceRatePercent": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"enum": [
"Infinity",
"-Infinity",
"NaN"
]
}
]
},
"sentCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"bouncedCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"recipientBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"senderBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unclassifiedBounceCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"scope": {
"anyOf": [
{
"type": "string",
"enum": [
"campaign_lifetime"
]
}
]
}
},
"required": [
"thresholdPercent",
"bounceRatePercent",
"sentCount",
"bouncedCount",
"recipientBounceCount",
"senderBounceCount",
"unclassifiedBounceCount",
"scope"
],
"patternProperties": {
"^(?!(?:thresholdPercent|bounceRatePercent|sentCount|bouncedCount|recipientBounceCount|senderBounceCount|unclassifiedBounceCount|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"thresholdPercent",
"bounceRatePercent",
"sentCount",
"bouncedCount",
"recipientBounceCount",
"senderBounceCount",
"unclassifiedBounceCount",
"scope"
]
}
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
},
{
"type": "object",
"properties": {
"reason": {
"anyOf": [
{
"type": "string",
"enum": [
"unknown"
]
}
]
},
"pausedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string",
"enum": [
"unknown"
]
}
]
},
"evidence": {
"type": "null"
}
},
"required": [
"reason",
"pausedAt",
"source",
"evidence"
],
"patternProperties": {
"^(?!(?:reason|pausedAt|source|evidence)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"reason",
"pausedAt",
"source",
"evidence"
]
}
}
],
"description": "Opt-in response context: request Accept: application/vnd.scheduler-zero.campaign-pause-context.v1+json, application/json. Unnegotiated responses omit pauseContext for strict legacy clients. Old servers omit it even for new clients; an absent field on a paused campaign means unknown attribution."
},
{
"type": "null"
}
]
},
"kind": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"currentVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"inboxCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"contactCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"updatedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"id",
"workspaceId",
"name",
"status",
"kind",
"currentVersion",
"inboxCount",
"contactCount",
"createdAt",
"updatedAt"
],
"patternProperties": {
"^(?!(?:id|workspaceId|name|status|pauseContext|kind|currentVersion|inboxCount|contactCount|createdAt|updatedAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"workspaceId",
"name",
"status",
"pauseContext",
"kind",
"currentVersion",
"inboxCount",
"contactCount",
"createdAt",
"updatedAt"
]
}
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"type": {
"type": "string",
"enum": [
"email_content",
"manual_review",
"linked_in_connection_request",
"linked_in_in_mail",
"phone_call",
"text_message",
"http_post_request",
"attio_task",
"heyreach_campaign"
]
},
"enabled": {
"type": "boolean"
}
},
"required": [
"id",
"type",
"enabled"
],
"patternProperties": {
"^(?!(?:id|type|enabled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"type",
"enabled"
]
}
}
},
"parentCampaignId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"folderId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"scheduleProfileId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"color": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"color"
],
"patternProperties": {
"^(?!(?:id|name|color)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"color"
]
}
}
},
"settings": {
"type": "object",
"properties": {
"newLeadPriority": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"espMatchMode": {
"type": "string",
"enum": [
"off",
"match_then_spill",
"match_only"
]
},
"opportunityValue": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"stopSendingOnReply": {
"type": "boolean"
},
"continueSendingOnAutomaticReply": {
"type": "boolean"
},
"defaultDelayDaysForAutomaticReply": {
"type": "integer",
"exclusiveMinimum": 0
},
"stopSendingOnSameDomainReply": {
"type": "boolean"
},
"openRateTracking": {
"type": "boolean"
},
"unsubscribeLink": {
"type": "boolean"
},
"addUnsubscribedLeadsToBlockList": {
"type": "boolean"
},
"sendAsPlainText": {
"type": "boolean"
},
"sendRiskyEmails": {
"type": "boolean"
},
"skipSegEmails": {
"type": "boolean"
},
"autoPauseOnHighBounceRate": {
"type": "boolean"
},
"continueOnSoftBounce": {
"type": "boolean"
},
"softBounceMonitoringDays": {
"type": "integer",
"minimum": 1,
"maximum": 30
},
"highBounceRateThreshold": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"fallbackSendingForRemovedInboxes": {
"type": "boolean"
},
"fallbackSendingForErroredInboxes": {
"type": "boolean"
},
"dailyCapPerRecipientDomain": {
"anyOf": [
{
"type": "integer",
"exclusiveMinimum": 0
},
{
"type": "null"
}
]
},
"waterfallEnabled": {
"type": "boolean"
},
"waterfallPassGapDays": {
"type": "integer",
"minimum": 1,
"maximum": 90
},
"waterfallResponseFreeze": {
"type": "string",
"enum": [
"freeze_ladder",
"contact_only"
]
},
"quotedChainAttribution": {
"type": "string",
"enum": [
"current_sender",
"original"
]
},
"ignoreInboxSendLimits": {
"type": "boolean"
},
"ccEmails": {
"anyOf": [
{
"type": "array",
"items": {
"$ref": "#/$defs/EmailAddress"
},
"maxItems": 5
},
{
"type": "null"
}
]
},
"initialDelayMinutes": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 43200
},
{
"type": "null"
}
]
}
},
"required": [
"newLeadPriority",
"espMatchMode",
"opportunityValue",
"stopSendingOnReply",
"continueSendingOnAutomaticReply",
"defaultDelayDaysForAutomaticReply",
"stopSendingOnSameDomainReply",
"openRateTracking",
"unsubscribeLink",
"addUnsubscribedLeadsToBlockList",
"sendAsPlainText",
"sendRiskyEmails",
"skipSegEmails",
"autoPauseOnHighBounceRate",
"continueOnSoftBounce",
"softBounceMonitoringDays",
"highBounceRateThreshold",
"fallbackSendingForRemovedInboxes",
"fallbackSendingForErroredInboxes",
"dailyCapPerRecipientDomain",
"waterfallEnabled",
"waterfallPassGapDays",
"waterfallResponseFreeze",
"quotedChainAttribution",
"ignoreInboxSendLimits",
"ccEmails",
"initialDelayMinutes"
],
"patternProperties": {
"^(?!(?:newLeadPriority|espMatchMode|opportunityValue|stopSendingOnReply|continueSendingOnAutomaticReply|defaultDelayDaysForAutomaticReply|stopSendingOnSameDomainReply|openRateTracking|unsubscribeLink|addUnsubscribedLeadsToBlockList|sendAsPlainText|sendRiskyEmails|skipSegEmails|autoPauseOnHighBounceRate|continueOnSoftBounce|softBounceMonitoringDays|highBounceRateThreshold|fallbackSendingForRemovedInboxes|fallbackSendingForErroredInboxes|dailyCapPerRecipientDomain|waterfallEnabled|waterfallPassGapDays|waterfallResponseFreeze|quotedChainAttribution|ignoreInboxSendLimits|ccEmails|initialDelayMinutes)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"newLeadPriority",
"espMatchMode",
"opportunityValue",
"stopSendingOnReply",
"continueSendingOnAutomaticReply",
"defaultDelayDaysForAutomaticReply",
"stopSendingOnSameDomainReply",
"openRateTracking",
"unsubscribeLink",
"addUnsubscribedLeadsToBlockList",
"sendAsPlainText",
"sendRiskyEmails",
"skipSegEmails",
"autoPauseOnHighBounceRate",
"continueOnSoftBounce",
"softBounceMonitoringDays",
"highBounceRateThreshold",
"fallbackSendingForRemovedInboxes",
"fallbackSendingForErroredInboxes",
"dailyCapPerRecipientDomain",
"waterfallEnabled",
"waterfallPassGapDays",
"waterfallResponseFreeze",
"quotedChainAttribution",
"ignoreInboxSendLimits",
"ccEmails",
"initialDelayMinutes"
]
}
},
"schedule": {
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scheduleVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"scheduleProfileId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"defaultTimezone": {
"$ref": "#/$defs/IanaTimeZone"
},
"daysOfWeek": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
}
},
{
"type": "null"
}
]
},
"startDate": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"endDate": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"unixStartTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86400
},
{
"type": "null"
}
]
},
"unixEndTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86400
},
{
"type": "null"
}
]
},
"useAdvancedSchedule": {
"type": "boolean"
},
"weeklySchedule": {
"anyOf": [
{
"type": "object",
"properties": {
"monday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"tuesday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"wednesday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"thursday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"friday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"saturday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
},
"sunday": {
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "integer",
"minimum": 0,
"maximum": 86400
},
"end": {
"type": "integer",
"minimum": 0,
"maximum": 86400
}
},
"required": [
"start",
"end"
],
"patternProperties": {
"^(?!(?:start|end)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"start",
"end"
]
}
},
"maxItems": 12
}
},
"patternProperties": {
"^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
]
}
},
{
"type": "null"
}
]
},
"skipHolidays": {
"type": "boolean"
},
"holidayCalendar": {
"anyOf": [
{
"$ref": "#/$defs/HolidayCalendarCode"
},
{
"type": "null"
}
]
},
"respectLeadTimezone": {
"type": "boolean"
},
"timezoneFallbackPolicy": {
"type": "string",
"enum": [
"campaign_default",
"hold"
]
},
"maxEmailsPerDay": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"maxNewLeadsPerDay": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"rampUpEnabled": {
"type": "boolean"
},
"rampUpInitialDailyLimit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"rampUpDailyIncrement": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"rampUpCompletedSendingDays": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"effectiveMaxEmailsPerDay": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"campaignId",
"scheduleVersion",
"scheduleProfileId",
"defaultTimezone",
"daysOfWeek",
"startDate",
"endDate",
"unixStartTime",
"unixEndTime",
"useAdvancedSchedule",
"weeklySchedule",
"skipHolidays",
"holidayCalendar",
"respectLeadTimezone",
"timezoneFallbackPolicy",
"maxEmailsPerDay",
"maxNewLeadsPerDay",
"rampUpEnabled",
"rampUpInitialDailyLimit",
"rampUpDailyIncrement",
"rampUpCompletedSendingDays",
"effectiveMaxEmailsPerDay"
],
"patternProperties": {
"^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"scheduleVersion",
"scheduleProfileId",
"defaultTimezone",
"daysOfWeek",
"startDate",
"endDate",
"unixStartTime",
"unixEndTime",
"useAdvancedSchedule",
"weeklySchedule",
"skipHolidays",
"holidayCalendar",
"respectLeadTimezone",
"timezoneFallbackPolicy",
"maxEmailsPerDay",
"maxNewLeadsPerDay",
"rampUpEnabled",
"rampUpInitialDailyLimit",
"rampUpDailyIncrement",
"rampUpCompletedSendingDays",
"effectiveMaxEmailsPerDay"
]
}
},
"customFieldKeys": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"sequenceRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"initialDelayMinutes": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"campaign",
"steps"
],
"patternProperties": {
"^(?!(?:campaign|steps|parentCampaignId|folderId|scheduleProfileId|tags|settings|schedule|customFieldKeys|sequenceRevision|initialDelayMinutes)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaign",
"steps",
"parentCampaignId",
"folderId",
"scheduleProfileId",
"tags",
"settings",
"schedule",
"customFieldKeys",
"sequenceRevision",
"initialDelayMinutes"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"campaignId",
"inboxId"
],
"patternProperties": {
"^(?!(?:campaignId|inboxId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"inboxId"
]
}
}
}
},
"required": [
"items"
],
"patternProperties": {
"^(?!(?:items)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"items"
]
}
]
}
},
{
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"keys": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
}
},
"required": [
"campaignId",
"keys"
],
"patternProperties": {
"^(?!(?:campaignId|keys)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"keys"
]
}
},
{
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"coverage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variable": {
"$ref": "#/$defs/ShortText"
},
"nonEmpty": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"state": {
"type": "string",
"enum": [
"all",
"some",
"none"
]
}
},
"required": [
"variable",
"nonEmpty",
"state"
],
"patternProperties": {
"^(?!(?:variable|nonEmpty|state)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"variable",
"nonEmpty",
"state"
]
}
}
},
"sender": {
"anyOf": [
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"coverage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"variable": {
"$ref": "#/$defs/ShortText"
},
"nonEmpty": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"state": {
"type": "string",
"enum": [
"all",
"some",
"none"
]
}
},
"required": [
"variable",
"nonEmpty",
"state"
],
"patternProperties": {
"^(?!(?:variable|nonEmpty|state)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"variable",
"nonEmpty",
"state"
]
}
}
}
},
"required": [
"total",
"coverage"
],
"patternProperties": {
"^(?!(?:total|coverage)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"total",
"coverage"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"campaignId",
"total",
"coverage",
"sender"
],
"patternProperties": {
"^(?!(?:campaignId|total|coverage|sender)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"total",
"coverage",
"sender"
]
}
},
{
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"syntax": {
"type": "object",
"properties": {
"liquidTags": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"liquidFilters": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"editorNodeTypes": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"unsupportedEditorNodeTypes": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"spintaxCommands": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"spintaxMaximumOptions": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"examples": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"$ref": "#/$defs/ShortText"
},
"template": {
"$ref": "#/$defs/Description"
}
},
"required": [
"label",
"template"
],
"patternProperties": {
"^(?!(?:label|template)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"label",
"template"
]
}
}
},
"rules": {
"type": "array",
"items": {
"$ref": "#/$defs/Description"
}
}
},
"required": [
"liquidTags",
"liquidFilters",
"editorNodeTypes",
"unsupportedEditorNodeTypes",
"spintaxCommands",
"spintaxMaximumOptions",
"examples",
"rules"
],
"patternProperties": {
"^(?!(?:liquidTags|liquidFilters|editorNodeTypes|unsupportedEditorNodeTypes|spintaxCommands|spintaxMaximumOptions|examples|rules)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"liquidTags",
"liquidFilters",
"editorNodeTypes",
"unsupportedEditorNodeTypes",
"spintaxCommands",
"spintaxMaximumOptions",
"examples",
"rules"
]
}
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"$ref": "#/$defs/ShortText"
},
"type": {
"type": "string",
"enum": [
"lead",
"custom",
"platform",
"organization",
"thread",
"sender",
"unknown"
]
},
"syntax": {
"$ref": "#/$defs/ShortText"
},
"description": {
"$ref": "#/$defs/Description"
},
"bodyOnly": {
"type": "boolean"
}
},
"required": [
"name",
"type",
"syntax",
"description",
"bodyOnly"
],
"patternProperties": {
"^(?!(?:name|type|syntax|description|bodyOnly)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"syntax",
"description",
"bodyOnly"
]
}
}
},
"customFieldKeys": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"organizationVariableKeys": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"totalContacts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"coverageStatus": {
"type": "string",
"enum": [
"checked",
"no_contacts"
]
},
"senderCoverage": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"checked",
"no_inboxes",
"unavailable"
]
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"total"
],
"patternProperties": {
"^(?!(?:status|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"status",
"total"
]
}
},
"isSubsequence": {
"type": "boolean"
},
"instruction": {
"$ref": "#/$defs/Description"
}
},
"required": [
"campaignId",
"syntax",
"variables",
"customFieldKeys",
"organizationVariableKeys",
"totalContacts",
"coverageStatus",
"senderCoverage",
"isSubsequence",
"instruction"
],
"patternProperties": {
"^(?!(?:campaignId|syntax|variables|customFieldKeys|organizationVariableKeys|totalContacts|coverageStatus|senderCoverage|isSubsequence|instruction)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"syntax",
"variables",
"customFieldKeys",
"organizationVariableKeys",
"totalContacts",
"coverageStatus",
"senderCoverage",
"isSubsequence",
"instruction"
]
}
},
{
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"valid",
"needs_review",
"invalid"
]
},
"syntaxValid": {
"type": "boolean"
},
"totalContacts": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"coverageStatus": {
"type": "string",
"enum": [
"checked",
"no_contacts"
]
},
"senderCoverage": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"checked",
"no_inboxes",
"unavailable"
]
},
"total": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"status",
"total"
],
"patternProperties": {
"^(?!(?:status|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"status",
"total"
]
}
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"enum": [
"subject",
"body"
]
},
"syntaxValid": {
"type": "boolean"
},
"syntaxMessage": {
"anyOf": [
{
"$ref": "#/$defs/Description"
},
{
"type": "null"
}
]
},
"renderCase": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"variables": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"$ref": "#/$defs/ShortText"
},
"type": {
"type": "string",
"enum": [
"lead",
"custom",
"platform",
"organization",
"thread",
"sender",
"unknown"
]
},
"isDefined": {
"type": "boolean"
},
"hasFallback": {
"type": "boolean"
},
"state": {
"type": "string",
"enum": [
"all",
"some",
"none",
"undefined",
"always",
"nullable",
"unknown",
"no_inboxes",
"no_prior_email",
"body_only"
]
},
"severity": {
"type": "string",
"enum": [
"ok",
"warn",
"error"
]
},
"coverage": {
"anyOf": [
{
"type": "object",
"properties": {
"nonEmpty": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"nonEmpty",
"total"
],
"patternProperties": {
"^(?!(?:nonEmpty|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"nonEmpty",
"total"
]
}
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"type",
"isDefined",
"hasFallback",
"state",
"severity",
"coverage"
],
"patternProperties": {
"^(?!(?:name|type|isDefined|hasFallback|state|severity|coverage)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"name",
"type",
"isDefined",
"hasFallback",
"state",
"severity",
"coverage"
]
}
}
}
},
"required": [
"field",
"syntaxValid",
"syntaxMessage",
"renderCase",
"variables"
],
"patternProperties": {
"^(?!(?:field|syntaxValid|syntaxMessage|renderCase|variables)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"field",
"syntaxValid",
"syntaxMessage",
"renderCase",
"variables"
]
}
}
}
},
"required": [
"campaignId",
"status",
"syntaxValid",
"totalContacts",
"coverageStatus",
"senderCoverage",
"fields"
],
"patternProperties": {
"^(?!(?:campaignId|status|syntaxValid|totalContacts|coverageStatus|senderCoverage|fields)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"status",
"syntaxValid",
"totalContacts",
"coverageStatus",
"senderCoverage",
"fields"
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
},
"provider": {
"$ref": "#/$defs/ShortText"
},
"status": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"id",
"emailAddress",
"provider",
"status"
],
"patternProperties": {
"^(?!(?:id|emailAddress|provider|status)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress",
"provider",
"status"
]
}
}
}
},
"required": [
"items"
],
"patternProperties": {
"^(?!(?:items)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"items"
]
}
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
},
"provider": {
"$ref": "#/$defs/ShortText"
},
"status": {
"$ref": "#/$defs/ShortText"
},
"explicit": {
"type": "boolean"
},
"viaTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"color": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"color"
],
"patternProperties": {
"^(?!(?:id|name|color)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"color"
]
}
}
}
},
"required": [
"id",
"emailAddress",
"provider",
"status",
"explicit",
"viaTags"
],
"patternProperties": {
"^(?!(?:id|emailAddress|provider|status|explicit|viaTags)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress",
"provider",
"status",
"explicit",
"viaTags"
]
}
}
}
},
"required": [
"items"
],
"patternProperties": {
"^(?!(?:items)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"items"
]
}
]
}
},
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"count"
],
"patternProperties": {
"^(?!(?:count)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"count"
]
}
]
}
},
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"source": {
"type": "string",
"enum": [
"baseline",
"created",
"duplicated",
"details",
"status",
"launched",
"settings",
"schedule",
"schedule_profile_propagated",
"sequence",
"step_toggle",
"subsequence_triggers",
"restored",
"system"
]
},
"campaignStatus": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
},
"name": {
"$ref": "#/$defs/ShortText"
},
"stepCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"actor": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user",
"api_key",
"system"
]
},
"userId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"$ref": "#/$defs/EmailAddress"
},
{
"type": "null"
}
]
}
},
"required": [
"type",
"userId",
"name",
"email"
],
"patternProperties": {
"^(?!(?:type|userId|name|email)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"type",
"userId",
"name",
"email"
]
}
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"campaignId",
"version",
"source",
"campaignStatus",
"name",
"stepCount",
"actor",
"createdAt"
],
"patternProperties": {
"^(?!(?:campaignId|version|source|campaignStatus|name|stepCount|actor|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"version",
"source",
"campaignStatus",
"name",
"stepCount",
"actor",
"createdAt"
]
}
}
},
"totalCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"nextCursor": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"items",
"totalCount",
"nextCursor"
],
"patternProperties": {
"^(?!(?:items|totalCount|nextCursor)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"totalCount",
"nextCursor"
]
}
},
{
"type": "object",
"properties": {
"record": {
"type": "object",
"properties": {
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"version": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"source": {
"type": "string",
"enum": [
"baseline",
"created",
"duplicated",
"details",
"status",
"launched",
"settings",
"schedule",
"schedule_profile_propagated",
"sequence",
"step_toggle",
"subsequence_triggers",
"restored",
"system"
]
},
"campaignStatus": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
},
"name": {
"$ref": "#/$defs/ShortText"
},
"stepCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"actor": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"user",
"api_key",
"system"
]
},
"userId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"email": {
"anyOf": [
{
"$ref": "#/$defs/EmailAddress"
},
{
"type": "null"
}
]
}
},
"required": [
"type",
"userId",
"name",
"email"
],
"patternProperties": {
"^(?!(?:type|userId|name|email)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"type",
"userId",
"name",
"email"
]
}
},
"createdAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
}
},
"required": [
"campaignId",
"version",
"source",
"campaignStatus",
"name",
"stepCount",
"actor",
"createdAt"
],
"patternProperties": {
"^(?!(?:campaignId|version|source|campaignStatus|name|stepCount|actor|createdAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"campaignId",
"version",
"source",
"campaignStatus",
"name",
"stepCount",
"actor",
"createdAt"
]
}
},
"snapshotSchemaVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"contentHash": {
"$ref": "#/$defs/ShortText"
},
"snapshot": {
"type": "object",
"properties": {
"schemaVersion": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"campaignName": {
"$ref": "#/$defs/ShortText"
},
"campaignStatus": {
"type": "string",
"enum": [
"draft",
"active",
"paused",
"archived",
"completed"
]
},
"scheduleProfileName": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"inboxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
}
},
"required": [
"id",
"emailAddress"
],
"patternProperties": {
"^(?!(?:id|emailAddress)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress"
]
}
}
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"name": {
"$ref": "#/$defs/ShortText"
},
"color": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"color"
],
"patternProperties": {
"^(?!(?:id|name|color)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"name",
"color"
]
}
}
},
"steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"stepId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"stepOrder": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"variantOrder": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"type": {
"$ref": "#/$defs/ShortText"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"id",
"stepId",
"stepOrder",
"variantOrder",
"type",
"enabled"
],
"patternProperties": {
"^(?!(?:id|stepId|stepOrder|variantOrder|type|enabled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"stepId",
"stepOrder",
"variantOrder",
"type",
"enabled"
]
}
}
},
"subsequenceTriggerCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"schemaVersion",
"campaignName",
"campaignStatus",
"scheduleProfileName",
"inboxes",
"tags",
"steps",
"subsequenceTriggerCount"
],
"patternProperties": {
"^(?!(?:schemaVersion|campaignName|campaignStatus|scheduleProfileName|inboxes|tags|steps|subsequenceTriggerCount)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"schemaVersion",
"campaignName",
"campaignStatus",
"scheduleProfileName",
"inboxes",
"tags",
"steps",
"subsequenceTriggerCount"
]
}
},
"authoredSnapshot": {
"$ref": "#/$defs/AuthoredCampaignSnapshot"
}
},
"required": [
"record",
"snapshotSchemaVersion",
"contentHash",
"snapshot"
],
"patternProperties": {
"^(?!(?:record|snapshotSchemaVersion|contentHash|snapshot|authoredSnapshot)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"record",
"snapshotSchemaVersion",
"contentHash",
"snapshot",
"authoredSnapshot"
]
}
},
{
"type": "object",
"properties": {
"calendar": {
"$ref": "#/$defs/HolidayCalendarCode"
},
"year": {
"type": "integer",
"minimum": 1970,
"maximum": 2999
},
"holidays": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"$ref": "#/$defs/LocalDate"
},
"name": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"date",
"name"
],
"patternProperties": {
"^(?!(?:date|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"date",
"name"
]
}
}
}
},
"required": [
"calendar",
"year",
"holidays"
],
"patternProperties": {
"^(?!(?:calendar|year|holidays)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"calendar",
"year",
"holidays"
]
}
},
{
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": [
"selected",
"all"
]
},
"days": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"$ref": "#/$defs/LocalDate"
},
"observances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"calendarCode": {
"$ref": "#/$defs/HolidayCalendarCode"
},
"calendarName": {
"$ref": "#/$defs/ShortText"
},
"name": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"calendarCode",
"calendarName",
"name"
],
"patternProperties": {
"^(?!(?:calendarCode|calendarName|name)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"calendarCode",
"calendarName",
"name"
]
}
}
}
},
"required": [
"date",
"observances"
],
"patternProperties": {
"^(?!(?:date|observances)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"date",
"observances"
]
}
}
}
},
"required": [
"scope",
"days"
],
"patternProperties": {
"^(?!(?:scope|days)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"scope",
"days"
]
}
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `campaigns.list`: `GET /v1/workspaces/:workspaceId/campaigns`
- `campaigns.get`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId`
- `campaigns.inboxes`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/inboxes`
- `campaigns.customFieldKeys`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/custom-field-keys`
- `campaigns.variableCoverage`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/variable-coverage`
- `campaigns.copyContext`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/copy-context`
- `campaigns.validateCopy`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/validate-copy`
- `campaignInboxes.listExplicit`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/inboxes/explicit`
- `campaignInboxes.listResolved`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/inboxes/resolved`
- `campaignInboxes.count`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/inboxes/count`
- `campaignVersions.list`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/versions`
- `campaignVersions.get`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/versions/:version`
- `campaignHolidays.list`: `GET /v1/workspaces/:workspaceId/campaigns/holidays/:calendar`
- `campaignHolidays.range`: `GET /v1/workspaces/:workspaceId/campaigns/holidays`