inspect_campaign_delivery
Inspect delayed campaign sends, their outcomes, and individual delivery notices.
# 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)
## inspect_campaign_delivery
Inspect delayed campaign sends, their outcomes, and individual delivery notices.
Use to distinguish a pending delay from a final failure or unconfirmed result and to inspect source diagnostics before deciding whether to resume a held enrollment.
Submission to an ESP or absence of a bounce does not prove delivery. This tool does not resume or resend messages.
Scopes: campaign:read
Risk: read; confirmation: none; idempotency: none.
### Input schema (personal API key)
```json
{
"type": "object",
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"list"
]
},
"outcome": {
"type": "string",
"enum": [
"pending",
"delivered",
"failed",
"unconfirmed"
]
},
"cause": {
"type": "string",
"enum": [
"sender",
"recipient",
"unclassified"
]
},
"failureCharacter": {
"type": "string",
"enum": [
"temporary",
"permanent",
"unknown"
]
},
"sequenceDisposition": {
"type": "string",
"enum": [
"held",
"continued",
"resumed",
"stopped"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope|outcome|cause|failureCharacter|sequenceDisposition|limit|offset)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"outcome",
"cause",
"failureCharacter",
"sequenceDisposition",
"limit",
"offset"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"summary"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"detail"
]
},
"sendHistoryId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"evidenceOffset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"evidenceLimit": {
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"required": [
"workspaceId",
"campaignId",
"scope",
"sendHistoryId"
],
"patternProperties": {
"^(?!(?:workspaceId|campaignId|scope|sendHistoryId|evidenceOffset|evidenceLimit)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"sendHistoryId",
"evidenceOffset",
"evidenceLimit"
]
}
}
]
}
```
### 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"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"list"
]
},
"outcome": {
"type": "string",
"enum": [
"pending",
"delivered",
"failed",
"unconfirmed"
]
},
"cause": {
"type": "string",
"enum": [
"sender",
"recipient",
"unclassified"
]
},
"failureCharacter": {
"type": "string",
"enum": [
"temporary",
"permanent",
"unknown"
]
},
"sequenceDisposition": {
"type": "string",
"enum": [
"held",
"continued",
"resumed",
"stopped"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|outcome|cause|failureCharacter|sequenceDisposition|limit|offset)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"outcome",
"cause",
"failureCharacter",
"sequenceDisposition",
"limit",
"offset"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"summary"
]
}
},
"required": [
"workspaceId",
"campaignId",
"scope"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"campaignId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"scope": {
"type": "string",
"enum": [
"detail"
]
},
"sendHistoryId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"evidenceOffset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"evidenceLimit": {
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"required": [
"workspaceId",
"campaignId",
"scope",
"sendHistoryId"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|campaignId|scope|sendHistoryId|evidenceOffset|evidenceLimit)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"campaignId",
"scope",
"sendHistoryId",
"evidenceOffset",
"evidenceLimit"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
}
]
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"EmailAddress": {
"type": "string",
"minLength": 3,
"maxLength": 320,
"pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
},
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sendHistoryId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-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"
},
"campaignContactId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"recipientEmail": {
"$ref": "#/$defs/EmailAddress"
},
"pass": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"outcome": {
"type": "string",
"enum": [
"pending",
"delivered",
"failed",
"unconfirmed"
]
},
"cause": {
"type": "string",
"enum": [
"sender",
"recipient",
"unclassified"
]
},
"failureCharacter": {
"type": "string",
"enum": [
"temporary",
"permanent",
"unknown"
]
},
"sequenceDisposition": {
"anyOf": [
{
"type": "string",
"enum": [
"held",
"continued",
"resumed",
"stopped"
]
},
{
"type": "null"
}
]
},
"firstDelayedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"lastEvidenceAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"monitoringEndsAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"providerRetryUntil": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"confirmedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"outcomeAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"conflictingEvidence": {
"type": "boolean"
},
"canResume": {
"type": "boolean"
},
"canStop": {
"type": "boolean"
}
},
"required": [
"sendHistoryId",
"campaignId",
"campaignContactId",
"recipientEmail",
"pass",
"outcome",
"cause",
"failureCharacter",
"sequenceDisposition",
"firstDelayedAt",
"lastEvidenceAt",
"monitoringEndsAt",
"providerRetryUntil",
"confirmedAt",
"outcomeAt",
"conflictingEvidence",
"canResume",
"canStop"
],
"patternProperties": {
"^(?!(?:sendHistoryId|campaignId|campaignContactId|recipientEmail|pass|outcome|cause|failureCharacter|sequenceDisposition|firstDelayedAt|lastEvidenceAt|monitoringEndsAt|providerRetryUntil|confirmedAt|outcomeAt|conflictingEvidence|canResume|canStop)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"sendHistoryId",
"campaignId",
"campaignContactId",
"recipientEmail",
"pass",
"outcome",
"cause",
"failureCharacter",
"sequenceDisposition",
"firstDelayedAt",
"lastEvidenceAt",
"monitoringEndsAt",
"providerRetryUntil",
"confirmedAt",
"outcomeAt",
"conflictingEvidence",
"canResume",
"canStop"
]
}
}
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"items",
"total",
"limit",
"offset"
],
"patternProperties": {
"^(?!(?:items|total|limit|offset)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"total",
"limit",
"offset"
]
}
},
{
"type": "object",
"properties": {
"pending": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"delivered": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"failed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unconfirmed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"pending",
"delivered",
"failed",
"unconfirmed",
"total"
],
"patternProperties": {
"^(?!(?:pending|delivered|failed|unconfirmed|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"pending",
"delivered",
"failed",
"unconfirmed",
"total"
]
}
},
{
"type": "object",
"properties": {
"delivery": {
"type": "object",
"properties": {
"sendHistoryId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-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"
},
"campaignContactId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"recipientEmail": {
"$ref": "#/$defs/EmailAddress"
},
"pass": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"outcome": {
"type": "string",
"enum": [
"pending",
"delivered",
"failed",
"unconfirmed"
]
},
"cause": {
"type": "string",
"enum": [
"sender",
"recipient",
"unclassified"
]
},
"failureCharacter": {
"type": "string",
"enum": [
"temporary",
"permanent",
"unknown"
]
},
"sequenceDisposition": {
"anyOf": [
{
"type": "string",
"enum": [
"held",
"continued",
"resumed",
"stopped"
]
},
{
"type": "null"
}
]
},
"firstDelayedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"lastEvidenceAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"monitoringEndsAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"providerRetryUntil": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"confirmedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"outcomeAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"conflictingEvidence": {
"type": "boolean"
},
"canResume": {
"type": "boolean"
},
"canStop": {
"type": "boolean"
}
},
"required": [
"sendHistoryId",
"campaignId",
"campaignContactId",
"recipientEmail",
"pass",
"outcome",
"cause",
"failureCharacter",
"sequenceDisposition",
"firstDelayedAt",
"lastEvidenceAt",
"monitoringEndsAt",
"providerRetryUntil",
"confirmedAt",
"outcomeAt",
"conflictingEvidence",
"canResume",
"canStop"
],
"patternProperties": {
"^(?!(?:sendHistoryId|campaignId|campaignContactId|recipientEmail|pass|outcome|cause|failureCharacter|sequenceDisposition|firstDelayedAt|lastEvidenceAt|monitoringEndsAt|providerRetryUntil|confirmedAt|outcomeAt|conflictingEvidence|canResume|canStop)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"sendHistoryId",
"campaignId",
"campaignContactId",
"recipientEmail",
"pass",
"outcome",
"cause",
"failureCharacter",
"sequenceDisposition",
"firstDelayedAt",
"lastEvidenceAt",
"monitoringEndsAt",
"providerRetryUntil",
"confirmedAt",
"outcomeAt",
"conflictingEvidence",
"canResume",
"canStop"
]
}
},
"evidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"delayed",
"delivered",
"failed",
"relayed",
"expanded",
"unknown"
]
},
"source": {
"type": "string"
},
"sourceMessageId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"diagnostic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"statusCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"recipientEmail": {
"anyOf": [
{
"$ref": "#/$defs/EmailAddress"
},
{
"type": "null"
}
]
},
"observedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"occurredAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"failureCharacter": {
"type": "string",
"enum": [
"temporary",
"permanent",
"unknown"
]
},
"cause": {
"type": "string",
"enum": [
"sender",
"recipient",
"unclassified"
]
},
"providerRetryUntil": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"sourceComplete": {
"type": "boolean"
}
},
"required": [
"id",
"action",
"source",
"sourceMessageId",
"diagnostic",
"statusCode",
"recipientEmail",
"observedAt",
"occurredAt",
"failureCharacter",
"cause",
"providerRetryUntil",
"sourceComplete"
],
"patternProperties": {
"^(?!(?:id|action|source|sourceMessageId|diagnostic|statusCode|recipientEmail|observedAt|occurredAt|failureCharacter|cause|providerRetryUntil|sourceComplete)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"action",
"source",
"sourceMessageId",
"diagnostic",
"statusCode",
"recipientEmail",
"observedAt",
"occurredAt",
"failureCharacter",
"cause",
"providerRetryUntil",
"sourceComplete"
]
}
}
},
"evidenceTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"evidenceOffset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"evidenceNextOffset": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"delivery",
"evidence",
"evidenceTotal",
"evidenceOffset",
"evidenceNextOffset"
],
"patternProperties": {
"^(?!(?:delivery|evidence|evidenceTotal|evidenceOffset|evidenceNextOffset)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"delivery",
"evidence",
"evidenceTotal",
"evidenceOffset",
"evidenceNextOffset"
]
}
}
]
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sendHistoryId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-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"
},
"campaignContactId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"recipientEmail": {
"$ref": "#/$defs/EmailAddress"
},
"pass": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"outcome": {
"type": "string",
"enum": [
"pending",
"delivered",
"failed",
"unconfirmed"
]
},
"cause": {
"type": "string",
"enum": [
"sender",
"recipient",
"unclassified"
]
},
"failureCharacter": {
"type": "string",
"enum": [
"temporary",
"permanent",
"unknown"
]
},
"sequenceDisposition": {
"anyOf": [
{
"type": "string",
"enum": [
"held",
"continued",
"resumed",
"stopped"
]
},
{
"type": "null"
}
]
},
"firstDelayedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"lastEvidenceAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"monitoringEndsAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"providerRetryUntil": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"confirmedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"outcomeAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"conflictingEvidence": {
"type": "boolean"
},
"canResume": {
"type": "boolean"
},
"canStop": {
"type": "boolean"
}
},
"required": [
"sendHistoryId",
"campaignId",
"campaignContactId",
"recipientEmail",
"pass",
"outcome",
"cause",
"failureCharacter",
"sequenceDisposition",
"firstDelayedAt",
"lastEvidenceAt",
"monitoringEndsAt",
"providerRetryUntil",
"confirmedAt",
"outcomeAt",
"conflictingEvidence",
"canResume",
"canStop"
],
"patternProperties": {
"^(?!(?:sendHistoryId|campaignId|campaignContactId|recipientEmail|pass|outcome|cause|failureCharacter|sequenceDisposition|firstDelayedAt|lastEvidenceAt|monitoringEndsAt|providerRetryUntil|confirmedAt|outcomeAt|conflictingEvidence|canResume|canStop)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"sendHistoryId",
"campaignId",
"campaignContactId",
"recipientEmail",
"pass",
"outcome",
"cause",
"failureCharacter",
"sequenceDisposition",
"firstDelayedAt",
"lastEvidenceAt",
"monitoringEndsAt",
"providerRetryUntil",
"confirmedAt",
"outcomeAt",
"conflictingEvidence",
"canResume",
"canStop"
]
}
}
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"limit": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"items",
"total",
"limit",
"offset"
],
"patternProperties": {
"^(?!(?:items|total|limit|offset)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"items",
"total",
"limit",
"offset"
]
}
},
{
"type": "object",
"properties": {
"pending": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"delivered": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"failed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"unconfirmed": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"pending",
"delivered",
"failed",
"unconfirmed",
"total"
],
"patternProperties": {
"^(?!(?:pending|delivered|failed|unconfirmed|total)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"pending",
"delivered",
"failed",
"unconfirmed",
"total"
]
}
},
{
"type": "object",
"properties": {
"delivery": {
"type": "object",
"properties": {
"sendHistoryId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-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"
},
"campaignContactId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"recipientEmail": {
"$ref": "#/$defs/EmailAddress"
},
"pass": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"outcome": {
"type": "string",
"enum": [
"pending",
"delivered",
"failed",
"unconfirmed"
]
},
"cause": {
"type": "string",
"enum": [
"sender",
"recipient",
"unclassified"
]
},
"failureCharacter": {
"type": "string",
"enum": [
"temporary",
"permanent",
"unknown"
]
},
"sequenceDisposition": {
"anyOf": [
{
"type": "string",
"enum": [
"held",
"continued",
"resumed",
"stopped"
]
},
{
"type": "null"
}
]
},
"firstDelayedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"lastEvidenceAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"monitoringEndsAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"providerRetryUntil": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"confirmedAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"outcomeAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"conflictingEvidence": {
"type": "boolean"
},
"canResume": {
"type": "boolean"
},
"canStop": {
"type": "boolean"
}
},
"required": [
"sendHistoryId",
"campaignId",
"campaignContactId",
"recipientEmail",
"pass",
"outcome",
"cause",
"failureCharacter",
"sequenceDisposition",
"firstDelayedAt",
"lastEvidenceAt",
"monitoringEndsAt",
"providerRetryUntil",
"confirmedAt",
"outcomeAt",
"conflictingEvidence",
"canResume",
"canStop"
],
"patternProperties": {
"^(?!(?:sendHistoryId|campaignId|campaignContactId|recipientEmail|pass|outcome|cause|failureCharacter|sequenceDisposition|firstDelayedAt|lastEvidenceAt|monitoringEndsAt|providerRetryUntil|confirmedAt|outcomeAt|conflictingEvidence|canResume|canStop)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"sendHistoryId",
"campaignId",
"campaignContactId",
"recipientEmail",
"pass",
"outcome",
"cause",
"failureCharacter",
"sequenceDisposition",
"firstDelayedAt",
"lastEvidenceAt",
"monitoringEndsAt",
"providerRetryUntil",
"confirmedAt",
"outcomeAt",
"conflictingEvidence",
"canResume",
"canStop"
]
}
},
"evidence": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"delayed",
"delivered",
"failed",
"relayed",
"expanded",
"unknown"
]
},
"source": {
"type": "string"
},
"sourceMessageId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"diagnostic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"statusCode": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"recipientEmail": {
"anyOf": [
{
"$ref": "#/$defs/EmailAddress"
},
{
"type": "null"
}
]
},
"observedAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"occurredAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"failureCharacter": {
"type": "string",
"enum": [
"temporary",
"permanent",
"unknown"
]
},
"cause": {
"type": "string",
"enum": [
"sender",
"recipient",
"unclassified"
]
},
"providerRetryUntil": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"sourceComplete": {
"type": "boolean"
}
},
"required": [
"id",
"action",
"source",
"sourceMessageId",
"diagnostic",
"statusCode",
"recipientEmail",
"observedAt",
"occurredAt",
"failureCharacter",
"cause",
"providerRetryUntil",
"sourceComplete"
],
"patternProperties": {
"^(?!(?:id|action|source|sourceMessageId|diagnostic|statusCode|recipientEmail|observedAt|occurredAt|failureCharacter|cause|providerRetryUntil|sourceComplete)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"id",
"action",
"source",
"sourceMessageId",
"diagnostic",
"statusCode",
"recipientEmail",
"observedAt",
"occurredAt",
"failureCharacter",
"cause",
"providerRetryUntil",
"sourceComplete"
]
}
}
},
"evidenceTotal": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"evidenceOffset": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"evidenceNextOffset": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"required": [
"delivery",
"evidence",
"evidenceTotal",
"evidenceOffset",
"evidenceNextOffset"
],
"patternProperties": {
"^(?!(?:delivery|evidence|evidenceTotal|evidenceOffset|evidenceNextOffset)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"delivery",
"evidence",
"evidenceTotal",
"evidenceOffset",
"evidenceNextOffset"
]
}
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `campaignDelivery.list`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/delivery`
- `campaignDelivery.summary`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/delivery/summary`
- `campaignDelivery.get`: `GET /v1/workspaces/:workspaceId/campaigns/:campaignId/delivery/:sendHistoryId`
Scheduler Zero