# 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_inbox_settings Patches inbox settings, including customVariables under {{inbox.key}}. For per-inbox custom variable CRUD: read_inbox_health action=settings, then manage_inbox_settings action=update with the complete customVariables array: add creates, replacing a value edits, omitting a key deletes, [] clears. Unique snake_case keys up to 64 chars; nonblank values up to 10000 chars; at most 50 keys and 16384 UTF-8 bytes for the complete serialized JSON array; reserved names forbidden. Values remain escaped literal data. Also supports tracking, sync, tags, placement recipients, and bulk settings/tag/move operations. When asked to change inbox settings, verify a tracking domain, move inboxes, or designate a placement recipient. For warmup toggles or policy changes — use manage_warmup. For deletes — delete_inboxes. 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:update 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": [ "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": { "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 500 }, { "type": "null" } ] }, "minGapSeconds": { "type": "integer", "minimum": 120, "maximum": 21600 }, "initialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 100 }, "dailyIncrement": { "type": "integer", "minimum": 1, "maximum": 50 }, "campaignEmailRampUp": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "patternProperties": { "^(?!(?:customVariables|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|syncNonCampaignEmails|signature|customTrackingDomain|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "customVariables", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "syncNonCampaignEmails", "signature", "customTrackingDomain", "tagIds" ] }, "minProperties": 1, "maxProperties": 15 } }, "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": [ "verify_tracking_domain" ] }, "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": [ "bulk_update" ] }, "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 }, "settings": { "type": "object", "properties": { "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "type": "integer", "minimum": 0, "maximum": 500 }, "minGapSeconds": { "type": "integer", "minimum": 120, "maximum": 21600 }, "campaignEmailRampUp": { "type": "boolean" }, "initialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 100 }, "dailyIncrement": { "type": "integer", "minimum": 1, "maximum": 50 }, "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 }, "syncNonCampaignEmails": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "patternProperties": { "^(?!(?:senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|campaignEmailRampUp|initialDailyLimit|dailyIncrement|warmupEnabled|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|syncNonCampaignEmails|signature|customTrackingDomain|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "campaignEmailRampUp", "initialDailyLimit", "dailyIncrement", "warmupEnabled", "warmupFilterTag", "warmupIncludeFilterTag", "dailyWarmupLimit", "warmupRampUp", "warmupInitialDailyLimit", "warmupDailyIncrement", "warmupRandomizedLimitEnabled", "warmupRandomizedLimitPercent", "warmupBusinessType", "warmupScheduleEnabled", "warmupTimezone", "warmupWeekdaysOnly", "warmupStartTime", "warmupEndTime", "warmupReplyRate", "syncNonCampaignEmails", "signature", "customTrackingDomain", "tagIds" ] }, "minProperties": 1, "maxProperties": 30 } }, "required": [ "inboxIds", "settings" ], "patternProperties": { "^(?!(?:inboxIds|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "settings" ] } } }, "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": [ "assign_tags" ] }, "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 }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 20 }, "mode": { "type": "string", "enum": [ "add", "remove" ] } }, "required": [ "inboxIds", "tagIds" ], "patternProperties": { "^(?!(?:inboxIds|tagIds|mode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "tagIds", "mode" ] } } }, "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": [ "move" ] }, "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 }, "targetWorkspaceId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "inboxIds", "targetWorkspaceId" ], "patternProperties": { "^(?!(?:inboxIds|targetWorkspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "targetWorkspaceId" ] } } }, "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": [ "designate_placement_recipient" ] }, "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" }, "confirmDedicated": { "type": "boolean", "enum": [ true ] } }, "required": [ "workspaceId", "action", "inboxId", "confirmDedicated" ], "patternProperties": { "^(?!(?:workspaceId|action|inboxId|confirmDedicated)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "confirmDedicated" ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### 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": [ "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": { "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 500 }, { "type": "null" } ] }, "minGapSeconds": { "type": "integer", "minimum": 120, "maximum": 21600 }, "initialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 100 }, "dailyIncrement": { "type": "integer", "minimum": 1, "maximum": 50 }, "campaignEmailRampUp": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "patternProperties": { "^(?!(?:customVariables|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|syncNonCampaignEmails|signature|customTrackingDomain|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "customVariables", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "syncNonCampaignEmails", "signature", "customTrackingDomain", "tagIds" ] }, "minProperties": 1, "maxProperties": 15 } }, "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": [ "verify_tracking_domain" ] }, "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": [ "bulk_update" ] }, "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 }, "settings": { "type": "object", "properties": { "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "type": "integer", "minimum": 0, "maximum": 500 }, "minGapSeconds": { "type": "integer", "minimum": 120, "maximum": 21600 }, "campaignEmailRampUp": { "type": "boolean" }, "initialDailyLimit": { "type": "integer", "minimum": 1, "maximum": 100 }, "dailyIncrement": { "type": "integer", "minimum": 1, "maximum": 50 }, "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 }, "syncNonCampaignEmails": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "patternProperties": { "^(?!(?:senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|campaignEmailRampUp|initialDailyLimit|dailyIncrement|warmupEnabled|warmupFilterTag|warmupIncludeFilterTag|dailyWarmupLimit|warmupRampUp|warmupInitialDailyLimit|warmupDailyIncrement|warmupRandomizedLimitEnabled|warmupRandomizedLimitPercent|warmupBusinessType|warmupScheduleEnabled|warmupTimezone|warmupWeekdaysOnly|warmupStartTime|warmupEndTime|warmupReplyRate|syncNonCampaignEmails|signature|customTrackingDomain|tagIds)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "campaignEmailRampUp", "initialDailyLimit", "dailyIncrement", "warmupEnabled", "warmupFilterTag", "warmupIncludeFilterTag", "dailyWarmupLimit", "warmupRampUp", "warmupInitialDailyLimit", "warmupDailyIncrement", "warmupRandomizedLimitEnabled", "warmupRandomizedLimitPercent", "warmupBusinessType", "warmupScheduleEnabled", "warmupTimezone", "warmupWeekdaysOnly", "warmupStartTime", "warmupEndTime", "warmupReplyRate", "syncNonCampaignEmails", "signature", "customTrackingDomain", "tagIds" ] }, "minProperties": 1, "maxProperties": 30 } }, "required": [ "inboxIds", "settings" ], "patternProperties": { "^(?!(?:inboxIds|settings)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "settings" ] } } }, "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": [ "assign_tags" ] }, "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 }, "tagIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 20 }, "mode": { "type": "string", "enum": [ "add", "remove" ] } }, "required": [ "inboxIds", "tagIds" ], "patternProperties": { "^(?!(?:inboxIds|tagIds|mode)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "tagIds", "mode" ] } } }, "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": [ "move" ] }, "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 }, "targetWorkspaceId": { "$ref": "#/$defs/OpaqueId" } }, "required": [ "inboxIds", "targetWorkspaceId" ], "patternProperties": { "^(?!(?:inboxIds|targetWorkspaceId)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "inboxIds", "targetWorkspaceId" ] } } }, "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": [ "designate_placement_recipient" ] }, "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" }, "confirmDedicated": { "type": "boolean", "enum": [ true ] } }, "required": [ "workspaceId", "action", "inboxId", "confirmDedicated" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|action|inboxId|confirmDedicated)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "workspaceId", "action", "inboxId", "confirmDedicated" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" }, "OpaqueId": { "type": "string", "minLength": 1, "maxLength": 512 } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "LeadStoredText": { "type": "string", "maxLength": 65536 }, "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "DomainName": { "type": "string", "minLength": 1, "maxLength": 253, "pattern": "^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z]{2,63}$" }, "HexColor": { "type": "string", "pattern": "^#[0-9A-Fa-f]{6}$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 } }, "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" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 120, "maximum": 21600 }, { "type": "null" } ] }, "initialDailyLimit": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 100 }, { "type": "null" } ] }, "dailyIncrement": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50 }, { "type": "null" } ] }, "campaignEmailRampUp": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "customTrackingDomainVerified": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "isPlacementTestRecipient": { "type": "boolean" }, "canSyncNonCampaignEmails": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } } }, "required": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ], "patternProperties": { "^(?!(?:id|emailAddress|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|signature|customVariables|customTrackingDomain|customTrackingDomainVerified|syncNonCampaignEmails|isPlacementTestRecipient|canSyncNonCampaignEmails|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ] } }, { "type": "object", "properties": { "verified": { "type": "boolean" }, "ready": { "type": "boolean" }, "cnameRecords": { "type": "array", "items": { "$ref": "#/$defs/DomainName" } }, "tls": { "anyOf": [ { "type": "object", "properties": { "supported": { "type": "boolean" }, "configured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "clientStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "supported", "configured", "clientStatus", "error" ], "patternProperties": { "^(?!(?:supported|configured|clientStatus|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "supported", "configured", "clientStatus", "error" ] } }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "verified", "ready", "cnameRecords", "tls", "error" ], "patternProperties": { "^(?!(?:verified|ready|cnameRecords|tls|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "verified", "ready", "cnameRecords", "tls", "error" ] } }, { "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": { "designated": { "type": "boolean", "enum": [ true ] } }, "required": [ "designated" ], "patternProperties": { "^(?!(?:designated)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "designated" ] } ] } } ] }, { "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" }, "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/LeadStoredText" }, { "type": "null" } ] }, "senderReplyTo": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "autoBcc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "autoCc": { "type": "array", "items": { "$ref": "#/$defs/EmailAddress" }, "maxItems": 5 }, "dailySendingLimit": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "minGapSeconds": { "anyOf": [ { "type": "integer", "minimum": 120, "maximum": 21600 }, { "type": "null" } ] }, "initialDailyLimit": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 100 }, { "type": "null" } ] }, "dailyIncrement": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50 }, { "type": "null" } ] }, "campaignEmailRampUp": { "type": "boolean" }, "signature": { "anyOf": [ { "$ref": "#/$defs/Union_" }, { "type": "null" } ] }, "customVariables": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z][a-z0-9_]*$" }, "value": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": [ "key", "value" ], "patternProperties": { "^(?!(?:key|value)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "key", "value" ] } }, "maxItems": 50 }, "customTrackingDomain": { "anyOf": [ { "$ref": "#/$defs/DomainName" }, { "type": "null" } ] }, "customTrackingDomainVerified": { "type": "boolean" }, "syncNonCampaignEmails": { "type": "boolean" }, "isPlacementTestRecipient": { "type": "boolean" }, "canSyncNonCampaignEmails": { "type": "boolean" }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "color": { "$ref": "#/$defs/HexColor" }, "description": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ] }, "createdAt": { "$ref": "#/$defs/UtcDateTimeEncoded" }, "updatedAt": { "$ref": "#/$defs/UtcDateTimeEncoded" } }, "required": [ "id", "name", "color", "description", "createdAt", "updatedAt" ], "patternProperties": { "^(?!(?:id|name|color|description|createdAt|updatedAt)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "name", "color", "description", "createdAt", "updatedAt" ] } } } }, "required": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ], "patternProperties": { "^(?!(?:id|emailAddress|senderFirstName|senderLastName|senderReplyTo|autoBcc|autoCc|dailySendingLimit|minGapSeconds|initialDailyLimit|dailyIncrement|campaignEmailRampUp|signature|customVariables|customTrackingDomain|customTrackingDomainVerified|syncNonCampaignEmails|isPlacementTestRecipient|canSyncNonCampaignEmails|tags)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "id", "emailAddress", "senderFirstName", "senderLastName", "senderReplyTo", "autoBcc", "autoCc", "dailySendingLimit", "minGapSeconds", "initialDailyLimit", "dailyIncrement", "campaignEmailRampUp", "signature", "customVariables", "customTrackingDomain", "customTrackingDomainVerified", "syncNonCampaignEmails", "isPlacementTestRecipient", "canSyncNonCampaignEmails", "tags" ] } }, { "type": "object", "properties": { "verified": { "type": "boolean" }, "ready": { "type": "boolean" }, "cnameRecords": { "type": "array", "items": { "$ref": "#/$defs/DomainName" } }, "tls": { "anyOf": [ { "type": "object", "properties": { "supported": { "type": "boolean" }, "configured": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "clientStatus": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "supported", "configured", "clientStatus", "error" ], "patternProperties": { "^(?!(?:supported|configured|clientStatus|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "supported", "configured", "clientStatus", "error" ] } }, { "type": "null" } ] }, "error": { "anyOf": [ { "$ref": "#/$defs/ShortText" }, { "type": "null" } ] } }, "required": [ "verified", "ready", "cnameRecords", "tls", "error" ], "patternProperties": { "^(?!(?:verified|ready|cnameRecords|tls|error)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "verified", "ready", "cnameRecords", "tls", "error" ] } }, { "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": { "designated": { "type": "boolean", "enum": [ true ] } }, "required": [ "designated" ], "patternProperties": { "^(?!(?:designated)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "designated" ] } ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `inboxSettings.update`: `PATCH /v1/workspaces/:workspaceId/inboxes/:inboxId/settings` - `inboxSettings.verifyTrackingDomain`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/verify-tracking-domain` - `inboxBulk.updateSettings`: `PATCH /v1/workspaces/:workspaceId/inboxes/bulk/settings` - `inboxBulk.assignTags`: `PATCH /v1/workspaces/:workspaceId/inboxes/bulk/tags` - `inboxBulk.move`: `POST /v1/workspaces/:workspaceId/inboxes/bulk/move` - `inboxPlacementDiagnostics.designateRecipient`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/placement-diagnostics/recipient`