# 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) ## test_campaign Preview a draft's rendered subject and body against a real sending inbox, and send one real test email to a chosen address. Render first — it dispatches nothing — and only send a test once the rendered copy looks right. The send is real outbound mail billed to the workspace and is refused on a frozen subscription; never use it to reach a prospect. Scopes: campaign:read, campaign:update, inbox:read Risk: costly; confirmation: none; idempotency: supported. ### Input schema (personal API key) ```json { "type": "object", "anyOf": [ { "type": "object", "properties": { "action": { "type": "string", "enum": [ "render" ] }, "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" }, "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" }, "test": { "type": "object", "properties": { "subject": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "sampleRecipient": { "type": "object", "properties": { "firstName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/IanaTimeZone" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:firstName|lastName|companyName|emailAddress|timezone)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "firstName", "lastName", "companyName", "emailAddress", "timezone" ] } }, "sampleSender": { "type": "object", "properties": { "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:senderFirstName|senderLastName|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderFirstName", "senderLastName", "emailAddress" ] } }, "previewSeed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "subject", "body", "bodyFormat" ], "patternProperties": { "^(?!(?:subject|body|bodyFormat|sampleRecipient|sampleSender|previewSeed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body", "bodyFormat", "sampleRecipient", "sampleSender", "previewSeed" ] } } }, "required": [ "action", "workspaceId", "campaignId", "inboxId", "test" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|inboxId|test)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "inboxId", "test" ] } }, { "type": "object", "properties": { "action": { "type": "string", "enum": [ "send" ] }, "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" }, "test": { "type": "object", "properties": { "contactId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "testEmail": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "contactId", "testEmail" ], "patternProperties": { "^(?!(?:contactId|testEmail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "testEmail" ] } } }, "required": [ "action", "workspaceId", "campaignId", "test" ], "patternProperties": { "^(?!(?:action|workspaceId|campaignId|test)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "test" ] } } ], "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" } } } ``` ### 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": [ "render" ] }, "campaignId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "inboxId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "test": { "type": "object", "properties": { "subject": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "body": { "anyOf": [ { "type": "object", "properties": { "root": { "$ref": "#/$defs/Union_" } }, "required": [ "root" ], "patternProperties": { "^(?!(?:root)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "root" ] } ] } }, { "type": "null" } ] }, "bodyFormat": { "type": "string", "enum": [ "inherit", "plain", "html" ] }, "sampleRecipient": { "type": "object", "properties": { "firstName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "companyName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "$ref": "#/$defs/IanaTimeZone" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:firstName|lastName|companyName|emailAddress|timezone)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "firstName", "lastName", "companyName", "emailAddress", "timezone" ] } }, "sampleSender": { "type": "object", "properties": { "senderFirstName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "senderLastName": { "anyOf": [ { "$ref": "#/$defs/Description" }, { "type": "null" } ] }, "emailAddress": { "anyOf": [ { "$ref": "#/$defs/EmailAddress" }, { "type": "null" } ] } }, "patternProperties": { "^(?!(?:senderFirstName|senderLastName|emailAddress)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "senderFirstName", "senderLastName", "emailAddress" ] } }, "previewSeed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "subject", "body", "bodyFormat" ], "patternProperties": { "^(?!(?:subject|body|bodyFormat|sampleRecipient|sampleSender|previewSeed)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body", "bodyFormat", "sampleRecipient", "sampleSender", "previewSeed" ] } } }, "required": [ "action", "workspaceId", "campaignId", "inboxId", "test" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|inboxId|test)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "inboxId", "test" ] }, { "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" ] }, "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" }, "test": { "type": "object", "properties": { "contactId": { "type": "string", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$", "format": "uuid" }, "testEmail": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "contactId", "testEmail" ], "patternProperties": { "^(?!(?:contactId|testEmail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "contactId", "testEmail" ] } } }, "required": [ "action", "workspaceId", "campaignId", "test" ], "patternProperties": { "^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:action|workspaceId|campaignId|test)$)[\\s\\S]*$)": false }, "additionalProperties": true, "propertyNames": { "anyOf": [ { "type": "string", "enum": [ "action", "workspaceId", "campaignId", "test" ] }, { "enum": [ "workspaceId" ] } ] } } ], "$defs": { "Union_": { "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": { "$ref": "#/$defs/Union_" } }, { "type": "object", "additionalProperties": { "$ref": "#/$defs/Union_" } } ] }, "Description": { "type": "string", "minLength": 1, "maxLength": 4096 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "IanaTimeZone": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^(?:UTC|[A-Za-z0-9_+-]+(?:\\/[A-Za-z0-9_+-]+)+)$" } } } ``` ### Output schema (structuredContent) ```json { "$defs": { "RenderedDraftText": { "type": "string", "maxLength": 1000000 }, "ShortText": { "type": "string", "minLength": 1, "maxLength": 256 }, "EmailAddress": { "type": "string", "minLength": 3, "maxLength": 320, "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$" }, "HttpUrl": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^https?:\\/\\/[^\\s/$.?#][^\\s]*$" }, "HttpResourcePath": { "type": "string", "minLength": 1, "maxLength": 2048, "pattern": "^\\/[A-Za-z0-9._~!$&'()*+,;=:@/%-]*$" }, "UtcDateTimeEncoded": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$" }, "NonEmptyString": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "type": "object", "anyOf": [ { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "subject": { "$ref": "#/$defs/RenderedDraftText" }, "body": { "$ref": "#/$defs/RenderedDraftText" }, "bodyContentType": { "type": "string", "enum": [ "plain", "html" ] }, "unresolvedExpressions": { "type": "object", "properties": { "subject": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "body": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "subject", "body" ], "patternProperties": { "^(?!(?:subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body" ] } }, "senderEmail": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "subject", "body", "bodyContentType", "unresolvedExpressions", "senderEmail" ], "patternProperties": { "^(?!(?:subject|body|bodyContentType|unresolvedExpressions|senderEmail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body", "bodyContentType", "unresolvedExpressions", "senderEmail" ] } }, { "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" ] } } ] }, { "type": "object" } ] }, { "type": "object", "properties": { "data": { "allOf": [ { "anyOf": [ { "type": "object", "properties": { "subject": { "$ref": "#/$defs/RenderedDraftText" }, "body": { "$ref": "#/$defs/RenderedDraftText" }, "bodyContentType": { "type": "string", "enum": [ "plain", "html" ] }, "unresolvedExpressions": { "type": "object", "properties": { "subject": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } }, "body": { "type": "array", "items": { "$ref": "#/$defs/ShortText" } } }, "required": [ "subject", "body" ], "patternProperties": { "^(?!(?:subject|body)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body" ] } }, "senderEmail": { "$ref": "#/$defs/EmailAddress" } }, "required": [ "subject", "body", "bodyContentType", "unresolvedExpressions", "senderEmail" ], "patternProperties": { "^(?!(?:subject|body|bodyContentType|unresolvedExpressions|senderEmail)$)[\\s\\S]*$": false }, "additionalProperties": true, "propertyNames": { "type": "string", "enum": [ "subject", "body", "bodyContentType", "unresolvedExpressions", "senderEmail" ] } }, { "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" ] } } ] }, { "not": { "type": "object" } } ] } }, "required": [ "data" ], "additionalProperties": false } ] } ``` ### Underlying API operations - `campaignInboxes.renderDraftTest`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/inboxes/:inboxId/render-draft-test` - `campaigns.testCampaign`: `POST /v1/workspaces/:workspaceId/campaigns/:campaignId/test`