# MCP tool reference 1 callable tools. Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference. Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result. [Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt) ## manage_campaign_schedule Read and save a campaign's sending schedule, and manage the reusable schedule presets a campaign can follow. Use after reading the schedule, echoing back the schedule version it returned so a concurrent propagation cannot be silently swallowed. Editing a preset never changes a campaign; propagating is a separate, explicit act that reaches only the campaigns still following it. Deleting a preset only unlinks — it never deletes or blanks a campaign's schedule. Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token. Scopes: campaign:read, campaign:create, campaign:update, campaign:delete Risk: write; confirmation: explicit; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "get", "update", "profiles", "create_profile", "update_profile", "propagate", "set_default", "delete_profile" ] }, "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "campaignId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "schedule": { "anyOf": [ { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "exclusiveMinimum": 0 }, "rampUpDailyIncrement": { "type": "integer", "exclusiveMinimum": 0 }, "scheduleProfileId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "expectedScheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|scheduleProfileId|expectedScheduleVersion)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "scheduleProfileId", "expectedScheduleVersion" ] }, "minProperties": 1, "maxProperties": 19 }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } } }, "required": [ "name", "settings" ], "patternProperties": { "^(?!(?:name|isDefault|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "isDefault", "settings" ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } } }, "patternProperties": { "^(?!(?:name|isDefault|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "isDefault", "settings" ] } }, { "type": "object", "properties": { "parentId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "parentId" ], "patternProperties": { "^(?!(?:parentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "parentId" ] } ] } }, { "type": "object", "properties": { "campaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "folderId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "campaignIds", "folderId" ], "patternProperties": { "^(?!(?:campaignIds|folderId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignIds", "folderId" ] } } ] }, "profileId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|schedule|profileId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "schedule", "profileId" ] }, "$defs": { "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HolidayCalendarCode": { "type": "string", "pattern": "^[A-Z]{2}$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Input schema (OAuth / delegated agent) ```json { "type": "object", "properties": { "action": { "type": "string", "enum": [ "get", "update", "profiles", "create_profile", "update_profile", "propagate", "set_default", "delete_profile" ] }, "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "campaignId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "schedule": { "anyOf": [ { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "exclusiveMinimum": 0 }, "rampUpDailyIncrement": { "type": "integer", "exclusiveMinimum": 0 }, "scheduleProfileId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "expectedScheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|scheduleProfileId|expectedScheduleVersion)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "scheduleProfileId", "expectedScheduleVersion" ] }, "minProperties": 1, "maxProperties": 19 }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } } }, "required": [ "name", "settings" ], "patternProperties": { "^(?!(?:name|isDefault|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "isDefault", "settings" ] } }, { "type": "object", "properties": { "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } } }, "patternProperties": { "^(?!(?:name|isDefault|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "name", "isDefault", "settings" ] } }, { "type": "object", "properties": { "parentId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "parentId" ], "patternProperties": { "^(?!(?:parentId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "parentId" ] } ] } }, { "type": "object", "properties": { "campaignIds": { "type": "array", "items": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "minItems": 1, "maxItems": 500 }, "folderId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "campaignIds", "folderId" ], "patternProperties": { "^(?!(?:campaignIds|folderId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignIds", "folderId" ] } } ] }, "profileId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" } }, "required": [ "action", "workspaceId" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|schedule|profileId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "schedule", "profileId" ] }, "$defs": { "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HolidayCalendarCode": { "type": "string", "pattern": "^[A-Z]{2}$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "HolidayCalendarCode": { "type": "string", "pattern": "^[A-Z]{2}$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "campaignId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "scheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scheduleProfileId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpDailyIncrement": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpCompletedSendingDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "effectiveMaxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ], "patternProperties": { "^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ] } }, { "type": "object", "properties": { "schedule": { "type": "object", "properties": { "campaignId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "scheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scheduleProfileId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpDailyIncrement": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpCompletedSendingDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "effectiveMaxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ], "patternProperties": { "^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ] } }, "unlinkedFrom": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] } }, "required": [ "schedule", "unlinkedFrom" ], "patternProperties": { "^(?!(?:schedule|unlinkedFrom)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schedule", "unlinkedFrom" ] } }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "linkedCampaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|isDefault|linkedCampaignCount|settings|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "linkedCampaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|isDefault|linkedCampaignCount|settings|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "profileId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "profileName": { "$ref": "#/$defs/ShortText" }, "reached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "profileId", "profileName", "reached" ], "patternProperties": { "^(?!(?:profileId|profileName|reached)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileId", "profileName", "reached" ] } }, { "type": "object", "properties": { "profileId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "unlinkedCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "profileId", "unlinkedCampaigns" ], "patternProperties": { "^(?!(?:profileId|unlinkedCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileId", "unlinkedCampaigns" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "campaignId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "scheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scheduleProfileId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpDailyIncrement": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpCompletedSendingDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "effectiveMaxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ], "patternProperties": { "^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ] } }, { "type": "object", "properties": { "schedule": { "type": "object", "properties": { "campaignId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "scheduleVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "scheduleProfileId": { "anyOf": [ { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, { "type": "null" } ] }, "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "startDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "endDate": { "anyOf": [ { "$ref": "#/$defs/UtcDateTimeEncoded" }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxNewLeadsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpEnabled": { "type": "boolean" }, "rampUpInitialDailyLimit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpDailyIncrement": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rampUpCompletedSendingDays": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "effectiveMaxEmailsPerDay": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ], "patternProperties": { "^(?!(?:campaignId|scheduleVersion|scheduleProfileId|defaultTimezone|daysOfWeek|startDate|endDate|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay|rampUpEnabled|rampUpInitialDailyLimit|rampUpDailyIncrement|rampUpCompletedSendingDays|effectiveMaxEmailsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "campaignId", "scheduleVersion", "scheduleProfileId", "defaultTimezone", "daysOfWeek", "startDate", "endDate", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay", "rampUpEnabled", "rampUpInitialDailyLimit", "rampUpDailyIncrement", "rampUpCompletedSendingDays", "effectiveMaxEmailsPerDay" ] } }, "unlinkedFrom": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "name": { "$ref": "#/$defs/ShortText" } }, "required": [ "id", "name" ], "patternProperties": { "^(?!(?:id|name)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name" ] } }, { "type": "null" } ] } }, "required": [ "schedule", "unlinkedFrom" ], "patternProperties": { "^(?!(?:schedule|unlinkedFrom)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "schedule", "unlinkedFrom" ] } }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "linkedCampaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|isDefault|linkedCampaignCount|settings|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ] } }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "workspaceId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "name": { "$ref": "#/$defs/ShortText" }, "isDefault": { "type": "boolean" }, "linkedCampaignCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "settings": { "type": "object", "properties": { "defaultTimezone": { "$ref": "#/$defs/IanaTimeZone" }, "daysOfWeek": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "unixStartTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "unixEndTime": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 86400 }, { "type": "null" } ] }, "useAdvancedSchedule": { "type": "boolean" }, "weeklySchedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "tuesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "wednesday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "thursday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "friday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "saturday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 }, "sunday": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer", "minimum": 0, "maximum": 86400 }, "end": { "type": "integer", "minimum": 0, "maximum": 86400 } }, "required": [ "start", "end" ], "patternProperties": { "^(?!(?:start|end)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "start", "end" ] } }, "maxItems": 12 } }, "patternProperties": { "^(?!(?:monday|tuesday|wednesday|thursday|friday|saturday|sunday)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ] } }, { "type": "null" } ] }, "skipHolidays": { "type": "boolean" }, "holidayCalendar": { "anyOf": [ { "$ref": "#/$defs/HolidayCalendarCode" }, { "type": "null" } ] }, "respectLeadTimezone": { "type": "boolean" }, "timezoneFallbackPolicy": { "type": "string", "enum": [ "campaign_default", "hold" ] }, "maxEmailsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "maxNewLeadsPerDay": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ], "patternProperties": { "^(?!(?:defaultTimezone|daysOfWeek|unixStartTime|unixEndTime|useAdvancedSchedule|weeklySchedule|skipHolidays|holidayCalendar|respectLeadTimezone|timezoneFallbackPolicy|maxEmailsPerDay|maxNewLeadsPerDay)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "defaultTimezone", "daysOfWeek", "unixStartTime", "unixEndTime", "useAdvancedSchedule", "weeklySchedule", "skipHolidays", "holidayCalendar", "respectLeadTimezone", "timezoneFallbackPolicy", "maxEmailsPerDay", "maxNewLeadsPerDay" ] } }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|workspaceId|name|isDefault|linkedCampaignCount|settings|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "workspaceId", "name", "isDefault", "linkedCampaignCount", "settings", "createdAt", "updatedAt" ] } } } }, "required": [ "items" ], "patternProperties": { "^(?!(?:items)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "items" ] } ] } }, { "type": "object", "properties": { "profileId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "profileName": { "$ref": "#/$defs/ShortText" }, "reached": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "profileId", "profileName", "reached" ], "patternProperties": { "^(?!(?:profileId|profileName|reached)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileId", "profileName", "reached" ] } }, { "type": "object", "properties": { "profileId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "unlinkedCampaigns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "profileId", "unlinkedCampaigns" ], "patternProperties": { "^(?!(?:profileId|unlinkedCampaigns)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "profileId", "unlinkedCampaigns" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaigns.getSchedule`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/schedule` - `campaigns.updateSchedule`: `PATCH /v1/workspaces/:workspaceId/campaigns/:campaignId/schedule` - `campaignScheduleProfiles.list`: `GET /v1/workspaces/:workspaceId/campaign-schedule-profiles` - `campaignScheduleProfiles.create`: `POST /v1/workspaces/:workspaceId/campaign-schedule-profiles` - `campaignScheduleProfiles.update`: `PATCH /v1/workspaces/:workspaceId/campaign-schedule-profiles/:profileId` - `campaignScheduleProfiles.propagate`: `POST /v1/workspaces/:workspaceId/campaign-schedule-profiles/:profileId/propagate` - `campaignScheduleProfiles.setDefault`: `POST /v1/workspaces/:workspaceId/campaign-schedule-profiles/:profileId/default` - `campaignScheduleProfiles.delete`: `DELETE /v1/workspaces/:workspaceId/campaign-schedule-profiles/:profileId`