Email campaigns & segments

Email campaigns & segments endpoints of the Zanfia Workspace API, with schemas and code samples.

8 min readLast updated Sep 30, 2026

One-off email broadcasts and the audience segments that target them. A campaign is composed as a draft and sent (or scheduled up to 30 days ahead) via the send route — sending is irreversible, so preview the audience first with POST /segments/preview. GET /sender-domain shows the sending identity (custom domains, their DNS records, the platform fallback address) and PUT /sender-domain/postal-address sets the footer postal address a send requires; adding or verifying a domain stays in the dashboard. All routes require a Authorization: Bearer header — see Authentication.

List email campaigns

GET/campaigns

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/campaigns"

{  "count": 0,  "campaigns": [    {      "id": "string",      "name": "string",      "status": "draft",      "category": "platform-announcements",      "newsletterId": "string",      "subject": "string",      "preheader": "string",      "contentMarkdown": "string",      "contentFormat": "markdown",      "contentHtml": "string",      "sender": {        "fromName": "string",        "replyTo": "string",        "fromEmail": "string"      },      "templateId": "string",      "theme": {        "backgroundColor": "string",        "contentBackgroundColor": "string",        "linkColor": "string",        "buttonColor": "string",        "buttonTextColor": "string",        "lineHeight": 0,        "contentWidth": 0      },      "contentTextOverride": "string",      "trackEngagement": true,      "linkActions": [        {          "url": "string",          "addTagIds": [            "string"          ],          "removeTagIds": [            "string"          ],          "addToAutomationIds": [            "string"          ]        }      ],      "audience": {        "type": "segment",        "segmentId": "string"      },      "recipientCount": 0,      "duplicateRecipientsSkipped": 0,      "scheduledAt": "string",      "sendStartedAt": "string",      "completedAt": "string",      "quotaPausedUntil": "string",      "stats": {        "sent": 0,        "delivered": 0,        "bounced": 0,        "complained": 0,        "failed": 0,        "skippedSuppressed": 0,        "skippedMuted": 0,        "trackedRecipients": 0,        "uniqueClicks": 0,        "clicks": 0,        "uniqueOpens": 0,        "opens": 0,        "attributedOrders": 0,        "attributedRevenue": 0,        "attributedCurrency": "string",        "unsubscribed": 0      },      "createdAt": "string",      "updatedAt": "string",      "importedFrom": {        "provider": "string",        "accountUrl": "string",        "externalCampaignId": "string",        "sentAt": "string",        "audience": {          "listNames": [            "string"          ],          "segmentName": "string"        },        "stats": {          "sends": 0,          "opens": 0,          "uniqueOpens": 0,          "clicks": 0,          "uniqueClicks": 0,          "unsubscribes": 0,          "bounces": 0        },        "importedAt": "string"      }    }  ]}

{  "error": "string",  "message": "string"}

Create a campaign draft

POST/campaigns

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Creates a DRAFT campaign — nothing is emailed. Everything beyond the name is optional at draft time; completeness is enforced by the send route.

name*string

Internal label shown in the campaigns list — not the subject. Max 120 chars.

subject?string

preheader?string|null

contentMarkdown?string

Campaign body as markdown.

contentFormat?EmailCampaignContentFormat

markdown (default) or html. html makes this a designed e-mail whose body is contentHtml; fixed for the life of the campaign.

Value in

"markdown"
"html"

contentHtml?string

Designed e-mail body: one standalone HTML document. Scripts, forms and iframes are stripped, styles are inlined and the legal footer (unsubscribe link, sender address) is appended at send time when the document has none. Only with contentFormat: html.

templateId?|

Look template ("Szablon wyglądu") the markdown body renders into; null/omitted = the default shell.

sender?

theme?|null

trackEngagement?boolean

Measure opens and clicks for this campaign; omitted = true.

linkActions?array<>

Per-link click actions: { url, addTagIds, removeTagIds? } entries — the listed client tags are added to / removed from a recipient who clicks that link (tracked recipients only). Omitted = none.

audience?||

Defaults to { type: 'all-subscribed' }.

Response Body

`application/json`

curl -X POST "https://example.com/campaigns" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "campaign": {    "id": "string",    "name": "string",    "status": "draft",    "category": "platform-announcements",    "newsletterId": "string",    "subject": "string",    "preheader": "string",    "contentMarkdown": "string",    "contentFormat": "markdown",    "contentHtml": "string",    "sender": {      "fromName": "string",      "replyTo": "string",      "fromEmail": "string"    },    "templateId": "string",    "theme": {      "backgroundColor": "string",      "contentBackgroundColor": "string",      "linkColor": "string",      "buttonColor": "string",      "buttonTextColor": "string",      "lineHeight": 0,      "contentWidth": 0    },    "contentTextOverride": "string",    "trackEngagement": true,    "linkActions": [      {        "url": "string",        "addTagIds": [          "string"        ],        "removeTagIds": [          "string"        ],        "addToAutomationIds": [          "string"        ]      }    ],    "audience": {      "type": "segment",      "segmentId": "string"    },    "recipientCount": 0,    "duplicateRecipientsSkipped": 0,    "scheduledAt": "string",    "sendStartedAt": "string",    "completedAt": "string",    "quotaPausedUntil": "string",    "stats": {      "sent": 0,      "delivered": 0,      "bounced": 0,      "complained": 0,      "failed": 0,      "skippedSuppressed": 0,      "skippedMuted": 0,      "trackedRecipients": 0,      "uniqueClicks": 0,      "clicks": 0,      "uniqueOpens": 0,      "opens": 0,      "attributedOrders": 0,      "attributedRevenue": 0,      "attributedCurrency": "string",      "unsubscribed": 0    },    "createdAt": "string",    "updatedAt": "string",    "importedFrom": {      "provider": "string",      "accountUrl": "string",      "externalCampaignId": "string",      "sentAt": "string",      "audience": {        "listNames": [          "string"        ],        "segmentName": "string"      },      "stats": {        "sends": 0,        "opens": 0,        "uniqueOpens": 0,        "clicks": 0,        "uniqueClicks": 0,        "unsubscribes": 0,        "bounces": 0      },      "importedAt": "string"    }  }}

{  "error": "string",  "message": "string"}

Get a campaign

GET/campaigns/{campaignId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

campaignId*string

Campaign id

Response Body

`application/json`

curl -X GET "https://example.com/campaigns/string"

{  "campaign": {    "id": "string",    "name": "string",    "status": "draft",    "category": "platform-announcements",    "newsletterId": "string",    "subject": "string",    "preheader": "string",    "contentMarkdown": "string",    "contentFormat": "markdown",    "contentHtml": "string",    "sender": {      "fromName": "string",      "replyTo": "string",      "fromEmail": "string"    },    "templateId": "string",    "theme": {      "backgroundColor": "string",      "contentBackgroundColor": "string",      "linkColor": "string",      "buttonColor": "string",      "buttonTextColor": "string",      "lineHeight": 0,      "contentWidth": 0    },    "contentTextOverride": "string",    "trackEngagement": true,    "linkActions": [      {        "url": "string",        "addTagIds": [          "string"        ],        "removeTagIds": [          "string"        ],        "addToAutomationIds": [          "string"        ]      }    ],    "audience": {      "type": "segment",      "segmentId": "string"    },    "recipientCount": 0,    "duplicateRecipientsSkipped": 0,    "scheduledAt": "string",    "sendStartedAt": "string",    "completedAt": "string",    "quotaPausedUntil": "string",    "stats": {      "sent": 0,      "delivered": 0,      "bounced": 0,      "complained": 0,      "failed": 0,      "skippedSuppressed": 0,      "skippedMuted": 0,      "trackedRecipients": 0,      "uniqueClicks": 0,      "clicks": 0,      "uniqueOpens": 0,      "opens": 0,      "attributedOrders": 0,      "attributedRevenue": 0,      "attributedCurrency": "string",      "unsubscribed": 0    },    "createdAt": "string",    "updatedAt": "string",    "importedFrom": {      "provider": "string",      "accountUrl": "string",      "externalCampaignId": "string",      "sentAt": "string",      "audience": {        "listNames": [          "string"        ],        "segmentName": "string"      },      "stats": {        "sends": 0,        "opens": 0,        "uniqueOpens": 0,        "clicks": 0,        "uniqueClicks": 0,        "unsubscribes": 0,        "bounces": 0      },      "importedAt": "string"    }  }}

{  "error": "string",  "message": "string"}

Update a campaign draft

PATCH/campaigns/{campaignId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

campaignId*string

Campaign id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Drafts only — a campaign past draft is immutable except cancel.

name?string

subject?string

preheader?string|null

contentMarkdown?string

contentHtml?string

New HTML document of a designed e-mail (contentFormat: html campaigns only).

templateId?|

Look template id; null = back to the default shell.

sender?

theme?|null

trackEngagement?boolean

Measure opens and clicks for this campaign.

linkActions?array<>

Per-link click actions; replaces the whole list, [] clears.

audience?||

Campaign audience selector — a saved segment reference (re-resolved at send time), every client whose emailSubscription.status === 'subscribed', or the subscribers of a newsletter product.

newsletter-subscribers is the audience of a newsletter ISSUE (category newsletter): every client with ACTIVE access to the product (direct or through a bundle), regardless of the workspace-level marketing subscription state — the issue is the product they subscribed to, not a marketing broadcast. Newsletter-scoped mutes and global suppressions still apply at send time.

Response Body

`application/json`

curl -X PATCH "https://example.com/campaigns/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "campaign": {    "id": "string",    "name": "string",    "status": "draft",    "category": "platform-announcements",    "newsletterId": "string",    "subject": "string",    "preheader": "string",    "contentMarkdown": "string",    "contentFormat": "markdown",    "contentHtml": "string",    "sender": {      "fromName": "string",      "replyTo": "string",      "fromEmail": "string"    },    "templateId": "string",    "theme": {      "backgroundColor": "string",      "contentBackgroundColor": "string",      "linkColor": "string",      "buttonColor": "string",      "buttonTextColor": "string",      "lineHeight": 0,      "contentWidth": 0    },    "contentTextOverride": "string",    "trackEngagement": true,    "linkActions": [      {        "url": "string",        "addTagIds": [          "string"        ],        "removeTagIds": [          "string"        ],        "addToAutomationIds": [          "string"        ]      }    ],    "audience": {      "type": "segment",      "segmentId": "string"    },    "recipientCount": 0,    "duplicateRecipientsSkipped": 0,    "scheduledAt": "string",    "sendStartedAt": "string",    "completedAt": "string",    "quotaPausedUntil": "string",    "stats": {      "sent": 0,      "delivered": 0,      "bounced": 0,      "complained": 0,      "failed": 0,      "skippedSuppressed": 0,      "skippedMuted": 0,      "trackedRecipients": 0,      "uniqueClicks": 0,      "clicks": 0,      "uniqueOpens": 0,      "opens": 0,      "attributedOrders": 0,      "attributedRevenue": 0,      "attributedCurrency": "string",      "unsubscribed": 0    },    "createdAt": "string",    "updatedAt": "string",    "importedFrom": {      "provider": "string",      "accountUrl": "string",      "externalCampaignId": "string",      "sentAt": "string",      "audience": {        "listNames": [          "string"        ],        "segmentName": "string"      },      "stats": {        "sends": 0,        "opens": 0,        "uniqueOpens": 0,        "clicks": 0,        "uniqueClicks": 0,        "unsubscribes": 0,        "bounces": 0      },      "importedAt": "string"    }  }}

{  "error": "string",  "message": "string"}

Delete a campaign

DELETE/campaigns/{campaignId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

campaignId*string

Campaign id

Response Body

`application/json`

curl -X DELETE "https://example.com/campaigns/string"

{  "campaignId": "string",  "deleted": true}

{  "error": "string",  "message": "string"}

Send or schedule a campaign

POST/campaigns/{campaignId}/send

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

campaignId*string

Campaign id

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

⚠️ HIGHEST-STAKES ROUTE: this SENDS the campaign — real bulk email to the resolved audience (every subscribed client, or the saved segment). Once the fan-out starts, delivered mail cannot be recalled; the only recovery is POST /campaigns/:campaignId/cancel, which stops REMAINING sends only.

The use case guards: draft-only (CAS status transition doubles as the double-send guard), completeness check (subject/content/sender), non-empty audience, and a ≤ 30-days-out schedule ceiling. Omit scheduledAt to send immediately.

scheduledAt?|

ISO timestamp for a scheduled send (≤ 30 days out); omitted/null = send NOW.

Response Body

`application/json`

curl -X POST "https://example.com/campaigns/string/send" \  -H "Content-Type: application/json" \  -d '{}'

{  "campaign": {    "id": "string",    "name": "string",    "status": "draft",    "category": "platform-announcements",    "newsletterId": "string",    "subject": "string",    "preheader": "string",    "contentMarkdown": "string",    "contentFormat": "markdown",    "contentHtml": "string",    "sender": {      "fromName": "string",      "replyTo": "string",      "fromEmail": "string"    },    "templateId": "string",    "theme": {      "backgroundColor": "string",      "contentBackgroundColor": "string",      "linkColor": "string",      "buttonColor": "string",      "buttonTextColor": "string",      "lineHeight": 0,      "contentWidth": 0    },    "contentTextOverride": "string",    "trackEngagement": true,    "linkActions": [      {        "url": "string",        "addTagIds": [          "string"        ],        "removeTagIds": [          "string"        ],        "addToAutomationIds": [          "string"        ]      }    ],    "audience": {      "type": "segment",      "segmentId": "string"    },    "recipientCount": 0,    "duplicateRecipientsSkipped": 0,    "scheduledAt": "string",    "sendStartedAt": "string",    "completedAt": "string",    "quotaPausedUntil": "string",    "stats": {      "sent": 0,      "delivered": 0,      "bounced": 0,      "complained": 0,      "failed": 0,      "skippedSuppressed": 0,      "skippedMuted": 0,      "trackedRecipients": 0,      "uniqueClicks": 0,      "clicks": 0,      "uniqueOpens": 0,      "opens": 0,      "attributedOrders": 0,      "attributedRevenue": 0,      "attributedCurrency": "string",      "unsubscribed": 0    },    "createdAt": "string",    "updatedAt": "string",    "importedFrom": {      "provider": "string",      "accountUrl": "string",      "externalCampaignId": "string",      "sentAt": "string",      "audience": {        "listNames": [          "string"        ],        "segmentName": "string"      },      "stats": {        "sends": 0,        "opens": 0,        "uniqueOpens": 0,        "clicks": 0,        "uniqueClicks": 0,        "unsubscribes": 0,        "bounces": 0      },      "importedAt": "string"    }  }}

{  "error": "string",  "message": "string"}

Cancel a scheduled/sending campaign

POST/campaigns/{campaignId}/cancel

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

campaignId*string

Campaign id

Response Body

`application/json`

curl -X POST "https://example.com/campaigns/string/cancel"

{  "campaign": {    "id": "string",    "name": "string",    "status": "draft",    "category": "platform-announcements",    "newsletterId": "string",    "subject": "string",    "preheader": "string",    "contentMarkdown": "string",    "contentFormat": "markdown",    "contentHtml": "string",    "sender": {      "fromName": "string",      "replyTo": "string",      "fromEmail": "string"    },    "templateId": "string",    "theme": {      "backgroundColor": "string",      "contentBackgroundColor": "string",      "linkColor": "string",      "buttonColor": "string",      "buttonTextColor": "string",      "lineHeight": 0,      "contentWidth": 0    },    "contentTextOverride": "string",    "trackEngagement": true,    "linkActions": [      {        "url": "string",        "addTagIds": [          "string"        ],        "removeTagIds": [          "string"        ],        "addToAutomationIds": [          "string"        ]      }    ],    "audience": {      "type": "segment",      "segmentId": "string"    },    "recipientCount": 0,    "duplicateRecipientsSkipped": 0,    "scheduledAt": "string",    "sendStartedAt": "string",    "completedAt": "string",    "quotaPausedUntil": "string",    "stats": {      "sent": 0,      "delivered": 0,      "bounced": 0,      "complained": 0,      "failed": 0,      "skippedSuppressed": 0,      "skippedMuted": 0,      "trackedRecipients": 0,      "uniqueClicks": 0,      "clicks": 0,      "uniqueOpens": 0,      "opens": 0,      "attributedOrders": 0,      "attributedRevenue": 0,      "attributedCurrency": "string",      "unsubscribed": 0    },    "createdAt": "string",    "updatedAt": "string",    "importedFrom": {      "provider": "string",      "accountUrl": "string",      "externalCampaignId": "string",      "sentAt": "string",      "audience": {        "listNames": [          "string"        ],        "segmentName": "string"      },      "stats": {        "sends": 0,        "opens": 0,        "uniqueOpens": 0,        "clicks": 0,        "uniqueClicks": 0,        "unsubscribes": 0,        "bounces": 0      },      "importedAt": "string"    }  }}

{  "error": "string",  "message": "string"}

List campaign recipients

GET/campaigns/{campaignId}/recipients

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

campaignId*string

Campaign id

Query Parameters

status?string

Value in

"pending"
"sent"
"delivered"
"skipped-suppressed"
"skipped-muted"
"failed"
"bounced"
"complained"
"clicked"

linkId?string

Only recipients who clicked this link; wins over status.

limit?integer

Range1 <= value <= 200

Default50

cursor?string

Response Body

`application/json`

curl -X GET "https://example.com/campaigns/string/recipients"

{  "recipients": [    {      "id": "string",      "email": "string",      "status": "pending",      "statusDetails": "string",      "processedAt": "string",      "tracked": true,      "firstOpenedAt": "string",      "firstClickedAt": "string",      "openCount": 0,      "clickCount": 0,      "unsubscribedAt": "string"    }  ],  "nextCursor": "string"}

{  "error": "string",  "message": "string"}

List campaign link clicks

GET/campaigns/{campaignId}/links

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

campaignId*string

Campaign id

Response Body

`application/json`

curl -X GET "https://example.com/campaigns/string/links"

{  "links": [    {      "id": "string",      "url": "string",      "label": "string",      "uniqueClicks": 0,      "clicks": 0,      "firstClickedAt": "string",      "lastClickedAt": "string"    }  ]}

{  "error": "string",  "message": "string"}

List audience segments

GET/segments

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/segments"

{  "count": 0,  "segments": [    {      "id": "string",      "name": "string",      "type": "dynamic",      "conditions": [        {          "field": "tag",          "operator": "has",          "tagId": "string"        }      ],      "lastEvaluatedCount": 0,      "lastEvaluatedSendableCount": 0,      "lastEvaluatedAt": "string",      "createdAt": "string",      "updatedAt": "string"    }  ]}

{  "error": "string",  "message": "string"}

Create an audience segment

POST/segments

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Unique per workspace (case-insensitive). Max 80 chars.

conditions*array<||||||||>

ANDed conditions — every one must hold. 1–10 conditions.

Response Body

`application/json`

curl -X POST "https://example.com/segments" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "conditions": [      {        "field": "tag",        "operator": "has",        "tagId": "string"      }    ]  }'

{  "segment": {    "id": "string",    "name": "string",    "type": "dynamic",    "conditions": [      {        "field": "tag",        "operator": "has",        "tagId": "string"      }    ],    "lastEvaluatedCount": 0,    "lastEvaluatedSendableCount": 0,    "lastEvaluatedAt": "string",    "createdAt": "string",    "updatedAt": "string"  }}

{  "error": "string",  "message": "string"}

Update an audience segment

PATCH/segments/{segmentId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

segmentId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

conditions?array<||||||||>

Response Body

`application/json`

curl -X PATCH "https://example.com/segments/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "segment": {    "id": "string",    "name": "string",    "type": "dynamic",    "conditions": [      {        "field": "tag",        "operator": "has",        "tagId": "string"      }    ],    "lastEvaluatedCount": 0,    "lastEvaluatedSendableCount": 0,    "lastEvaluatedAt": "string",    "createdAt": "string",    "updatedAt": "string"  }}

{  "error": "string",  "message": "string"}

Delete an audience segment

DELETE/segments/{segmentId}

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Path Parameters

segmentId*string

Response Body

`application/json`

curl -X DELETE "https://example.com/segments/string"

{  "segmentId": "string",  "deleted": true}

{  "error": "string",  "message": "string"}

Preview a segment's audience

POST/segments/preview

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Stateless evaluation of a condition set — nothing is persisted.

conditions*array<||||||||>

Response Body

`application/json`

curl -X POST "https://example.com/segments/preview" \  -H "Content-Type: application/json" \  -d '{    "conditions": [      {        "field": "tag",        "operator": "has",        "tagId": "string"      }    ]  }'

{  "count": 0}

{  "error": "string",  "message": "string"}

Get the sender domain

GET/sender-domain

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Response Body

`application/json`

curl -X GET "https://example.com/sender-domain"

{  "senderDomain": {    "domain": "string",    "status": "pending",    "mailFromStatus": "pending",    "ownershipVerified": true,    "records": [      {        "type": "CNAME",        "name": "string",        "value": "string",        "purpose": "dkim",        "required": true,        "priority": 0      }    ],    "defaultFromLocalPart": "string",    "defaultFromEmail": "string",    "verifiedAt": "string",    "lastCheckedAt": "string",    "isDefault": true  },  "senderDomains": [    {      "domain": "string",      "status": "pending",      "mailFromStatus": "pending",      "ownershipVerified": true,      "records": [        {          "type": "CNAME",          "name": "string",          "value": "string",          "purpose": "dkim",          "required": true,          "priority": 0        }      ],      "defaultFromLocalPart": "string",      "defaultFromEmail": "string",      "verifiedAt": "string",      "lastCheckedAt": "string",      "isDefault": true    }  ],  "maxSenderDomains": 0,  "platformFromAddress": "string",  "postalAddress": "string",  "unsubscribeLabel": "string",  "systemEmailsFromCustomDomain": true}

{  "error": "string",  "message": "string"}

Set the footer postal address

PUT/sender-domain/postal-address

Authorization

bearerAuth

AuthorizationBearer <token>

API key from Dashboard → Integrations → API, MCP and CLI.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

postalAddress*|

One plain-text line ("Company, street, city, country"), max 300 chars; null / blank clears it.

Response Body

`application/json`

curl -X PUT "https://example.com/sender-domain/postal-address" \  -H "Content-Type: application/json" \  -d '{    "postalAddress": "string"  }'

{  "postalAddress": "string"}

{  "error": "string",  "message": "string"}

Was this article helpful?

Spotted something off? Tell us at support@zanfia.com.

List email campaigns

200application/json

4XXapplication/json

Create a campaign draft

200application/json

4XXapplication/json

Get a campaign

200application/json

4XXapplication/json

Update a campaign draft

200application/json

4XXapplication/json

Delete a campaign

200application/json

4XXapplication/json

Send or schedule a campaign

200application/json

4XXapplication/json

Cancel a scheduled/sending campaign

200application/json

4XXapplication/json

List campaign recipients

200application/json

4XXapplication/json

List campaign link clicks

200application/json

4XXapplication/json

List audience segments

200application/json

4XXapplication/json

Create an audience segment

200application/json

4XXapplication/json

Update an audience segment

200application/json

4XXapplication/json

Delete an audience segment

200application/json

4XXapplication/json

Preview a segment's audience

200application/json

4XXapplication/json

Get the sender domain

200application/json

4XXapplication/json

Set the footer postal address

200application/json

4XXapplication/json

Related articles

API overview

Authentication and API keys

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`