manage_warmup
Toggles warmup enrollment and patches warmup limits, ramp, schedule, and policy overrides, in single-inbox and bulk form.
# 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_warmup
Toggles warmup enrollment and patches warmup limits, ramp, schedule, and policy overrides, in single-inbox and bulk form.
When asked to enable/disable warmup or change warmup configuration.
For non-warmup settings — use manage_inbox_settings.
Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token.
Scopes: inbox:warmup_manage
Risk: write; confirmation: explicit; idempotency: supported.
### Input schema (personal API key)
```json
{
"type": "object",
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"get"
]
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"workspaceId",
"action",
"inboxId"
],
"patternProperties": {
"^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"inboxId"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"update"
]
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"patch": {
"type": "object",
"properties": {
"warmupEnabled": {
"type": "boolean"
},
"warmupFilterTag": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"warmupIncludeFilterTag": {
"type": "boolean"
},
"dailyWarmupLimit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"warmupRampUp": {
"type": "boolean"
},
"warmupInitialDailyLimit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"warmupDailyIncrement": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"warmupRandomizedLimitEnabled": {
"type": "boolean"
},
"warmupRandomizedLimitPercent": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"warmupBusinessType": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"warmupScheduleEnabled": {
"type": "boolean"
},
"warmupTimezone": {
"$ref": "#/$defs/ShortText"
},
"warmupWeekdaysOnly": {
"type": "boolean"
},
"warmupStartTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86399
},
{
"type": "null"
}
]
},
"warmupEndTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86399
},
{
"type": "null"
}
]
},
"warmupReplyRate": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"advancedPolicy": {
"type": "object",
"properties": {
"engagement": {
"type": "object",
"properties": {
"replyRate": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
},
"patternProperties": {
"^(?!(?:replyRate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"replyRate"
]
}
]
}
}
},
"patternProperties": {
"^(?!(?:engagement)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"engagement"
]
}
]
}
}
},
"patternProperties": {
"^(?!(?:warmupEnabled|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|advancedPolicy)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"warmupEnabled",
"warmupFilterTag",
"warmupIncludeFilterTag",
"dailyWarmupLimit",
"warmupRampUp",
"warmupInitialDailyLimit",
"warmupDailyIncrement",
"warmupRandomizedLimitEnabled",
"warmupRandomizedLimitPercent",
"warmupBusinessType",
"warmupScheduleEnabled",
"warmupTimezone",
"warmupWeekdaysOnly",
"warmupStartTime",
"warmupEndTime",
"warmupReplyRate",
"advancedPolicy"
]
},
"minProperties": 1,
"maxProperties": 17
}
},
"required": [
"workspaceId",
"action",
"inboxId",
"patch"
],
"patternProperties": {
"^(?!(?:workspaceId|action|inboxId|patch)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"inboxId",
"patch"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"toggle"
]
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"payload": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"patternProperties": {
"^(?!(?:enabled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"enabled"
]
}
]
}
}
},
"required": [
"workspaceId",
"action",
"inboxId",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"inboxId",
"payload"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"send_test"
]
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"payload": {
"type": "object",
"properties": {
"to": {
"$ref": "#/$defs/EmailAddress"
}
},
"required": [
"to"
],
"patternProperties": {
"^(?!(?:to)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"to"
]
}
]
}
}
},
"required": [
"workspaceId",
"action",
"inboxId",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"inboxId",
"payload"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"bulk_enable"
]
},
"payload": {
"type": "object",
"properties": {
"inboxIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"minItems": 1,
"maxItems": 500
},
"enabled": {
"type": "boolean"
}
},
"required": [
"inboxIds",
"enabled"
],
"patternProperties": {
"^(?!(?:inboxIds|enabled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"inboxIds",
"enabled"
]
}
}
},
"required": [
"workspaceId",
"action",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId|action|payload)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"payload"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"bulk_policy"
]
},
"payload": {
"type": "object",
"properties": {
"inboxIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"minItems": 1,
"maxItems": 500
},
"policy": {
"type": "object",
"properties": {
"engagement": {
"type": "object",
"properties": {
"replyRate": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
},
"required": [
"replyRate"
],
"patternProperties": {
"^(?!(?:replyRate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"replyRate"
]
}
]
}
}
},
"required": [
"engagement"
],
"patternProperties": {
"^(?!(?:engagement)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"engagement"
]
}
]
}
}
},
"required": [
"inboxIds",
"policy"
],
"patternProperties": {
"^(?!(?:inboxIds|policy)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"inboxIds",
"policy"
]
}
}
},
"required": [
"workspaceId",
"action",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId|action|payload)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"action",
"payload"
]
}
}
],
"$defs": {
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"EmailAddress": {
"type": "string",
"minLength": 3,
"maxLength": 320,
"pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
}
}
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Target Workspace UUID. Call list_workspaces to enumerate the Workspaces this credential may access, then pass the chosen id here."
}
},
"required": [
"workspaceId"
],
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"get"
]
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
}
},
"required": [
"workspaceId",
"action",
"inboxId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"inboxId"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"update"
]
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"patch": {
"type": "object",
"properties": {
"warmupEnabled": {
"type": "boolean"
},
"warmupFilterTag": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"warmupIncludeFilterTag": {
"type": "boolean"
},
"dailyWarmupLimit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"warmupRampUp": {
"type": "boolean"
},
"warmupInitialDailyLimit": {
"type": "integer",
"minimum": 1,
"maximum": 50
},
"warmupDailyIncrement": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"warmupRandomizedLimitEnabled": {
"type": "boolean"
},
"warmupRandomizedLimitPercent": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"warmupBusinessType": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"warmupScheduleEnabled": {
"type": "boolean"
},
"warmupTimezone": {
"$ref": "#/$defs/ShortText"
},
"warmupWeekdaysOnly": {
"type": "boolean"
},
"warmupStartTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86399
},
{
"type": "null"
}
]
},
"warmupEndTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86399
},
{
"type": "null"
}
]
},
"warmupReplyRate": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"advancedPolicy": {
"type": "object",
"properties": {
"engagement": {
"type": "object",
"properties": {
"replyRate": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
},
"patternProperties": {
"^(?!(?:replyRate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"replyRate"
]
}
]
}
}
},
"patternProperties": {
"^(?!(?:engagement)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"engagement"
]
}
]
}
}
},
"patternProperties": {
"^(?!(?:warmupEnabled|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|advancedPolicy)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"warmupEnabled",
"warmupFilterTag",
"warmupIncludeFilterTag",
"dailyWarmupLimit",
"warmupRampUp",
"warmupInitialDailyLimit",
"warmupDailyIncrement",
"warmupRandomizedLimitEnabled",
"warmupRandomizedLimitPercent",
"warmupBusinessType",
"warmupScheduleEnabled",
"warmupTimezone",
"warmupWeekdaysOnly",
"warmupStartTime",
"warmupEndTime",
"warmupReplyRate",
"advancedPolicy"
]
},
"minProperties": 1,
"maxProperties": 17
}
},
"required": [
"workspaceId",
"action",
"inboxId",
"patch"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|patch)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"inboxId",
"patch"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"toggle"
]
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"payload": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"patternProperties": {
"^(?!(?:enabled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"enabled"
]
}
]
}
}
},
"required": [
"workspaceId",
"action",
"inboxId",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"inboxId",
"payload"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"send_test"
]
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"payload": {
"type": "object",
"properties": {
"to": {
"$ref": "#/$defs/EmailAddress"
}
},
"required": [
"to"
],
"patternProperties": {
"^(?!(?:to)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"to"
]
}
]
}
}
},
"required": [
"workspaceId",
"action",
"inboxId",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|payload)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"inboxId",
"payload"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"bulk_enable"
]
},
"payload": {
"type": "object",
"properties": {
"inboxIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"minItems": 1,
"maxItems": 500
},
"enabled": {
"type": "boolean"
}
},
"required": [
"inboxIds",
"enabled"
],
"patternProperties": {
"^(?!(?:inboxIds|enabled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"inboxIds",
"enabled"
]
}
}
},
"required": [
"workspaceId",
"action",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|payload)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"payload"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"bulk_policy"
]
},
"payload": {
"type": "object",
"properties": {
"inboxIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"minItems": 1,
"maxItems": 500
},
"policy": {
"type": "object",
"properties": {
"engagement": {
"type": "object",
"properties": {
"replyRate": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
},
"required": [
"replyRate"
],
"patternProperties": {
"^(?!(?:replyRate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"replyRate"
]
}
]
}
}
},
"required": [
"engagement"
],
"patternProperties": {
"^(?!(?:engagement)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"engagement"
]
}
]
}
}
},
"required": [
"inboxIds",
"policy"
],
"patternProperties": {
"^(?!(?:inboxIds|policy)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"inboxIds",
"policy"
]
}
}
},
"required": [
"workspaceId",
"action",
"payload"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|payload)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"action",
"payload"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
}
],
"$defs": {
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"EmailAddress": {
"type": "string",
"minLength": 3,
"maxLength": 320,
"pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
}
}
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"EmailAddress": {
"type": "string",
"minLength": 3,
"maxLength": 320,
"pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
},
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"OpaqueId": {
"type": "string",
"minLength": 1,
"maxLength": 512
},
"Union_": {
"anyOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/Union_"
}
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/Union_"
}
}
]
},
"HttpUrl": {
"type": "string",
"minLength": 1,
"maxLength": 2048,
"pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$"
},
"HttpResourcePath": {
"type": "string",
"minLength": 1,
"maxLength": 2048,
"pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$"
},
"NonEmptyString": {
"type": "string",
"minLength": 1,
"maxLength": 4096
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
},
"provider": {
"type": "string",
"enum": [
"google_workspace",
"microsoft_365",
"other"
]
},
"warmupEnabled": {
"type": "boolean"
},
"isPlacementTestRecipient": {
"type": "boolean"
},
"warmupFilterTag": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"warmupIncludeFilterTag": {
"type": "boolean"
},
"dailyWarmupLimit": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"warmupRampUp": {
"type": "boolean"
},
"warmupInitialDailyLimit": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"warmupDailyIncrement": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"warmupRandomizedLimitEnabled": {
"type": "boolean"
},
"warmupRandomizedLimitPercent": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"warmupBusinessType": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"warmupScheduleEnabled": {
"type": "boolean"
},
"warmupTimezone": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"warmupWeekdaysOnly": {
"type": "boolean"
},
"warmupStartTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86399
},
{
"type": "null"
}
]
},
"warmupEndTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86399
},
{
"type": "null"
}
]
},
"warmupReplyRate": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"warmupStartedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"pool": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/OpaqueId"
},
"configId": {
"$ref": "#/$defs/OpaqueId"
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"underfillStrategy": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"configId",
"name",
"underfillStrategy"
],
"patternProperties": {
"^(?!(?:id|configId|name|underfillStrategy)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"configId",
"name",
"underfillStrategy"
]
}
},
{
"type": "null"
}
]
},
"policyOverride": {
"anyOf": [
{
"type": "object",
"properties": {
"engagement": {
"type": "object",
"properties": {
"replyRate": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
},
"patternProperties": {
"^(?!(?:replyRate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"replyRate"
]
}
]
}
}
},
"patternProperties": {
"^(?!(?:engagement)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"engagement"
]
}
]
}
},
{
"type": "null"
}
]
},
"effectivePolicy": {
"$ref": "#/$defs/Union_"
}
},
"required": [
"id",
"emailAddress",
"provider",
"warmupEnabled",
"isPlacementTestRecipient",
"warmupFilterTag",
"warmupIncludeFilterTag",
"dailyWarmupLimit",
"warmupRampUp",
"warmupInitialDailyLimit",
"warmupDailyIncrement",
"warmupRandomizedLimitEnabled",
"warmupRandomizedLimitPercent",
"warmupBusinessType",
"warmupScheduleEnabled",
"warmupTimezone",
"warmupWeekdaysOnly",
"warmupStartTime",
"warmupEndTime",
"warmupReplyRate",
"warmupStartedAt",
"pool",
"policyOverride",
"effectivePolicy"
],
"patternProperties": {
"^(?!(?:id|emailAddress|provider|warmupEnabled|isPlacementTestRecipient|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|warmupStartedAt|pool|policyOverride|effectivePolicy)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress",
"provider",
"warmupEnabled",
"isPlacementTestRecipient",
"warmupFilterTag",
"warmupIncludeFilterTag",
"dailyWarmupLimit",
"warmupRampUp",
"warmupInitialDailyLimit",
"warmupDailyIncrement",
"warmupRandomizedLimitEnabled",
"warmupRandomizedLimitPercent",
"warmupBusinessType",
"warmupScheduleEnabled",
"warmupTimezone",
"warmupWeekdaysOnly",
"warmupStartTime",
"warmupEndTime",
"warmupReplyRate",
"warmupStartedAt",
"pool",
"policyOverride",
"effectivePolicy"
]
}
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"warmupEnabled": {
"type": "boolean"
}
},
"required": [
"id",
"warmupEnabled"
],
"patternProperties": {
"^(?!(?:id|warmupEnabled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"warmupEnabled"
]
}
},
{
"type": "object",
"properties": {
"outcomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"updated",
"skipped",
"failed"
]
},
"reason": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"inboxId",
"status",
"reason"
],
"patternProperties": {
"^(?!(?:inboxId|status|reason)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"inboxId",
"status",
"reason"
]
}
}
}
},
"required": [
"outcomes"
],
"patternProperties": {
"^(?!(?:outcomes)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"outcomes"
]
}
]
}
},
{
"type": "object",
"properties": {
"runId": {
"$ref": "#/$defs/OpaqueId"
},
"requestId": {
"$ref": "#/$defs/OpaqueId"
},
"operation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"statusUrl": {
"anyOf": [
{
"$ref": "#/$defs/HttpUrl"
},
{
"$ref": "#/$defs/HttpResourcePath"
}
]
},
"state": {
"type": "string",
"enum": [
"queued",
"running",
"waiting_for_user",
"succeeded",
"partially_succeeded",
"failed",
"canceled",
"canceling"
]
},
"acceptedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"progress": {
"type": "object",
"properties": {
"completed": {
"type": "integer",
"minimum": 0
},
"total": {
"type": "integer",
"minimum": 0
},
"message": {
"$ref": "#/$defs/NonEmptyString"
}
},
"required": [
"completed"
],
"patternProperties": {
"^(?!(?:completed|total|message)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"completed",
"total",
"message"
]
}
},
"canCancel": {
"type": "boolean"
}
},
"required": [
"id",
"statusUrl",
"state",
"acceptedAt",
"canCancel"
],
"patternProperties": {
"^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"statusUrl",
"state",
"acceptedAt",
"progress",
"canCancel"
]
}
}
},
"required": [
"runId",
"requestId",
"operation"
],
"patternProperties": {
"^(?!(?:runId|requestId|operation)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"runId",
"requestId",
"operation"
]
}
}
]
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
},
"provider": {
"type": "string",
"enum": [
"google_workspace",
"microsoft_365",
"other"
]
},
"warmupEnabled": {
"type": "boolean"
},
"isPlacementTestRecipient": {
"type": "boolean"
},
"warmupFilterTag": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"warmupIncludeFilterTag": {
"type": "boolean"
},
"dailyWarmupLimit": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"warmupRampUp": {
"type": "boolean"
},
"warmupInitialDailyLimit": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"warmupDailyIncrement": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"warmupRandomizedLimitEnabled": {
"type": "boolean"
},
"warmupRandomizedLimitPercent": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"warmupBusinessType": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"warmupScheduleEnabled": {
"type": "boolean"
},
"warmupTimezone": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"warmupWeekdaysOnly": {
"type": "boolean"
},
"warmupStartTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86399
},
{
"type": "null"
}
]
},
"warmupEndTime": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 86399
},
{
"type": "null"
}
]
},
"warmupReplyRate": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"warmupStartedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"pool": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"$ref": "#/$defs/OpaqueId"
},
"configId": {
"$ref": "#/$defs/OpaqueId"
},
"name": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
},
"underfillStrategy": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"configId",
"name",
"underfillStrategy"
],
"patternProperties": {
"^(?!(?:id|configId|name|underfillStrategy)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"configId",
"name",
"underfillStrategy"
]
}
},
{
"type": "null"
}
]
},
"policyOverride": {
"anyOf": [
{
"type": "object",
"properties": {
"engagement": {
"type": "object",
"properties": {
"replyRate": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
},
"patternProperties": {
"^(?!(?:replyRate)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"replyRate"
]
}
]
}
}
},
"patternProperties": {
"^(?!(?:engagement)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"engagement"
]
}
]
}
},
{
"type": "null"
}
]
},
"effectivePolicy": {
"$ref": "#/$defs/Union_"
}
},
"required": [
"id",
"emailAddress",
"provider",
"warmupEnabled",
"isPlacementTestRecipient",
"warmupFilterTag",
"warmupIncludeFilterTag",
"dailyWarmupLimit",
"warmupRampUp",
"warmupInitialDailyLimit",
"warmupDailyIncrement",
"warmupRandomizedLimitEnabled",
"warmupRandomizedLimitPercent",
"warmupBusinessType",
"warmupScheduleEnabled",
"warmupTimezone",
"warmupWeekdaysOnly",
"warmupStartTime",
"warmupEndTime",
"warmupReplyRate",
"warmupStartedAt",
"pool",
"policyOverride",
"effectivePolicy"
],
"patternProperties": {
"^(?!(?:id|emailAddress|provider|warmupEnabled|isPlacementTestRecipient|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|warmupStartedAt|pool|policyOverride|effectivePolicy)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"emailAddress",
"provider",
"warmupEnabled",
"isPlacementTestRecipient",
"warmupFilterTag",
"warmupIncludeFilterTag",
"dailyWarmupLimit",
"warmupRampUp",
"warmupInitialDailyLimit",
"warmupDailyIncrement",
"warmupRandomizedLimitEnabled",
"warmupRandomizedLimitPercent",
"warmupBusinessType",
"warmupScheduleEnabled",
"warmupTimezone",
"warmupWeekdaysOnly",
"warmupStartTime",
"warmupEndTime",
"warmupReplyRate",
"warmupStartedAt",
"pool",
"policyOverride",
"effectivePolicy"
]
}
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"warmupEnabled": {
"type": "boolean"
}
},
"required": [
"id",
"warmupEnabled"
],
"patternProperties": {
"^(?!(?:id|warmupEnabled)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"warmupEnabled"
]
}
},
{
"type": "object",
"properties": {
"outcomes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"status": {
"type": "string",
"enum": [
"updated",
"skipped",
"failed"
]
},
"reason": {
"anyOf": [
{
"$ref": "#/$defs/ShortText"
},
{
"type": "null"
}
]
}
},
"required": [
"inboxId",
"status",
"reason"
],
"patternProperties": {
"^(?!(?:inboxId|status|reason)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"inboxId",
"status",
"reason"
]
}
}
}
},
"required": [
"outcomes"
],
"patternProperties": {
"^(?!(?:outcomes)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"outcomes"
]
}
]
}
},
{
"type": "object",
"properties": {
"runId": {
"$ref": "#/$defs/OpaqueId"
},
"requestId": {
"$ref": "#/$defs/OpaqueId"
},
"operation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"statusUrl": {
"anyOf": [
{
"$ref": "#/$defs/HttpUrl"
},
{
"$ref": "#/$defs/HttpResourcePath"
}
]
},
"state": {
"type": "string",
"enum": [
"queued",
"running",
"waiting_for_user",
"succeeded",
"partially_succeeded",
"failed",
"canceled",
"canceling"
]
},
"acceptedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"progress": {
"type": "object",
"properties": {
"completed": {
"type": "integer",
"minimum": 0
},
"total": {
"type": "integer",
"minimum": 0
},
"message": {
"$ref": "#/$defs/NonEmptyString"
}
},
"required": [
"completed"
],
"patternProperties": {
"^(?!(?:completed|total|message)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"completed",
"total",
"message"
]
}
},
"canCancel": {
"type": "boolean"
}
},
"required": [
"id",
"statusUrl",
"state",
"acceptedAt",
"canCancel"
],
"patternProperties": {
"^(?!(?:id|statusUrl|state|acceptedAt|progress|canCancel)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"statusUrl",
"state",
"acceptedAt",
"progress",
"canCancel"
]
}
}
},
"required": [
"runId",
"requestId",
"operation"
],
"patternProperties": {
"^(?!(?:runId|requestId|operation)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"runId",
"requestId",
"operation"
]
}
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `inboxSettings.toggleWarmup`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/warmup`
- `inboxWarmupSettings.get`: `GET /v1/workspaces/:workspaceId/inboxes/:inboxId/warmup-settings`
- `inboxWarmupSettings.update`: `PATCH /v1/workspaces/:workspaceId/inboxes/:inboxId/warmup-settings`
- `inboxWarmupSettings.sendTest`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/warmup-settings/test`
- `inboxBulk.setWarmupEnabled`: `PATCH /v1/workspaces/:workspaceId/inboxes/bulk/warmup`
- `inboxBulk.updateWarmupPolicy`: `PATCH /v1/workspaces/:workspaceId/inboxes/bulk/warmup-policy`
Scheduler Zero