Appearance
newsletter-app
66 endpoints.
GET /api/v1/newsletter-app/groups
List Groups
200 — Successful Response
json
{}GET /api/v1/newsletter-app/customer-groups
List Customer Groups
Live customer groups (from the tenant's books site) for the "+ Add customer group" picker on the Compose page.
200 — Successful Response
json
{}GET /api/v1/newsletter-app/lead-segments
List Lead Segments
Live CRM lead status segments for the "+ Add lead segment" picker.
200 — Successful Response
json
{}POST /api/v1/newsletter-app/groups/live
Create Live Group
Request body
json
{
"properties": {
"title": {
"type": "string",
"title": "Title"
},
"source_type": {
"type": "string",
"title": "Source Type"
},
"source_filter": {
"additionalProperties": true,
"type": "object",
"title": "Source Filter"
}
},
"type": "object",
"required": [
"title",
"source_type"
],
"title": "LiveGroupIn"
}201 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/groups/{group_id}/sync
Sync Live Group
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
group_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/smtp
Get Org Smtp
This org's SMTP override (password withheld) — unset fields mean the org falls back to the platform's own SMTP.
200 — Successful Response
json
{}PUT /api/v1/newsletter-app/smtp
Update Org Smtp
Upsert this org's SMTP override, then return the refreshed (masked) view. clear: true removes the override entirely.
Request body
json
{
"properties": {
"host": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
],
"title": "Host"
},
"port": {
"anyOf": [
{
"type": "integer",
"maximum": 65535,
"minimum": 1
},
{
"type": "null"
}
],
"title": "Port"
},
"user": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
],
"title": "User"
},
"password": {
"anyOf": [
{
"type": "string",
"maxLength": 512
},
{
"type": "null"
}
],
"title": "Password"
},
"security": {
"anyOf": [
{
"type": "string",
"pattern": "^(starttls|ssl|none)$"
},
{
"type": "null"
}
],
"title": "Security"
},
"from": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
],
"title": "From"
},
"from_name": {
"anyOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
],
"title": "From Name"
},
"timeout": {
"anyOf": [
{
"type": "number",
"maximum": 300,
"exclusiveMinimum": 0
},
{
"type": "null"
}
],
"title": "Timeout"
},
"clear": {
"type": "boolean",
"title": "Clear",
"default": false
}
},
"type": "object",
"title": "OrgSmtpIn",
"description": "Partial update for this org's own SMTP override. A field omitted\n(``None``) is left untouched; an empty string clears just that field."
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/smtp/test
Test Org Smtp
Live connect + authenticate using this org's currently-saved SMTP override. Sends nothing. Returns {ok, detail}; ok=False with a "not configured" detail when no override is saved (nothing to test — the org is using the platform default).
200 — Successful Response
json
{}POST /api/v1/newsletter-app/suppressions/import
Import Suppressions
Request body
json
{
"properties": {
"text": {
"type": "string",
"maxLength": 5000000,
"minLength": 1,
"title": "Text"
},
"reason": {
"type": "string",
"title": "Reason",
"default": "import"
},
"details": {
"anyOf": [
{
"type": "string",
"maxLength": 400
},
{
"type": "null"
}
],
"title": "Details"
}
},
"type": "object",
"required": [
"text"
],
"title": "SuppressionImportIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/campaigns
Create Campaign
Request body
json
{
"properties": {
"subject": {
"type": "string",
"title": "Subject"
},
"sender_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sender Name"
},
"sender_email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Sender Email"
},
"reply_to": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Reply To"
},
"content_type": {
"type": "string",
"title": "Content Type",
"default": "rich_text"
},
"message": {
"type": "string",
"title": "Message",
"default": ""
},
"email_group_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Email Group Ids"
},
"include_tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Include Tags"
},
"exclude_tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Exclude Tags"
},
"send_unsubscribe_link": {
"type": "boolean",
"title": "Send Unsubscribe Link",
"default": true
},
"schedule_send": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Schedule Send"
},
"segment_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Segment Id"
},
"ab_enabled": {
"type": "boolean",
"title": "Ab Enabled",
"default": false
},
"ab_variants": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Ab Variants"
},
"ab_split_percent": {
"anyOf": [
{
"type": "integer",
"maximum": 100,
"minimum": 2
},
{
"type": "null"
}
],
"title": "Ab Split Percent"
},
"ab_wait_minutes": {
"anyOf": [
{
"type": "integer",
"maximum": 10080,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Ab Wait Minutes"
},
"ab_metric": {
"anyOf": [
{
"type": "string",
"pattern": "^(open|click)$"
},
{
"type": "null"
}
],
"title": "Ab Metric"
},
"utm_enabled": {
"type": "boolean",
"title": "Utm Enabled",
"default": false
},
"utm_campaign": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
],
"title": "Utm Campaign"
},
"summary_to": {
"anyOf": [
{
"type": "string",
"maxLength": 400
},
{
"type": "null"
}
],
"title": "Summary To"
}
},
"type": "object",
"required": [
"subject"
],
"title": "CampaignIn"
}201 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/campaigns/{campaign_id}
Get Campaign
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}PATCH /api/v1/newsletter-app/campaigns/{campaign_id}
Update Campaign
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_id | path | yes | string |
Request body
json
{
"properties": {
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject"
},
"sender_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sender Name"
},
"sender_email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Sender Email"
},
"reply_to": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Reply To"
},
"content_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Content Type"
},
"message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Message"
},
"email_group_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Email Group Ids"
},
"include_tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Include Tags"
},
"exclude_tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Exclude Tags"
},
"send_unsubscribe_link": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Send Unsubscribe Link"
},
"schedule_send": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Schedule Send"
},
"segment_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Segment Id"
},
"ab_enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Ab Enabled"
},
"ab_variants": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Ab Variants"
},
"ab_split_percent": {
"anyOf": [
{
"type": "integer",
"maximum": 100,
"minimum": 2
},
{
"type": "null"
}
],
"title": "Ab Split Percent"
},
"ab_wait_minutes": {
"anyOf": [
{
"type": "integer",
"maximum": 10080,
"minimum": 0
},
{
"type": "null"
}
],
"title": "Ab Wait Minutes"
},
"ab_metric": {
"anyOf": [
{
"type": "string",
"pattern": "^(open|click)$"
},
{
"type": "null"
}
],
"title": "Ab Metric"
},
"utm_enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Utm Enabled"
},
"utm_campaign": {
"anyOf": [
{
"type": "string",
"maxLength": 120
},
{
"type": "null"
}
],
"title": "Utm Campaign"
},
"summary_to": {
"anyOf": [
{
"type": "string",
"maxLength": 400
},
{
"type": "null"
}
],
"title": "Summary To"
},
"clear_schedule": {
"type": "boolean",
"title": "Clear Schedule",
"default": false
}
},
"type": "object",
"title": "CampaignPatch"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/campaigns/{campaign_id}/attachments
Upload Attachment
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_id | path | yes | string |
201 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}DELETE /api/v1/newsletter-app/campaigns/{campaign_id}/attachments/{attachment_id}
Delete Attachment
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_id | path | yes | string | |
attachment_id | path | yes | string |
204 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/campaigns/{campaign_id}/send-preview
Send Preview
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/campaigns/{campaign_id}/send-test
Send Test
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_id | path | yes | string |
Request body
json
{
"properties": {
"to": {
"type": "string",
"format": "email",
"title": "To"
}
},
"type": "object",
"required": [
"to"
],
"title": "SendTestIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/campaigns/{campaign_id}/send
Send Now
Queue the campaign for the background sending worker and return at once (queued = recipients snapshotted). Progress is polled from send-progress; the send carries on if the browser goes away.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/campaigns/{campaign_id}/control/{action}
Campaign Control
Pause / resume / cancel a sending campaign, or re-queue its failed recipients (retry-failed). Validation happens before any write, so a refusal changes nothing.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_id | path | yes | string | |
action | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/campaigns/{campaign_id}/send-progress
Send Progress
Polled by the Send modal while the background worker works the queue (the worker commits per recipient, so this is live).
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/unsubscribe/{token}
Unsubscribe
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token | path | yes | string | |
r | query | no |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/unsubscribe/{token}
Unsubscribe Confirm
Both doors land here: the confirm page's button and a mail client's RFC 8058 one-click POST (body List-Unsubscribe=One-Click, no page shown). Unsubscribes the address from EVERY group on the tenant — live-synced ones included — and puts it on the suppression list, so a later CRM re-sync or import cannot quietly add it back (owner, 2026-09-30).
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token | path | yes | string | |
r | query | no |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/track/open/{token}.png
Track Open
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/track/click/{link_token}/{rec_token}
Track Click
Click redirect: sent-mail hrefs are rewritten to this URL (see newsletter_app_send.rewrite_click_links). Records the click against both the link and the recipient, then 302s to the real destination. An unknown link token 404s; an unknown recipient token still redirects (the destination matters more than the stats).
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
link_token | path | yes | string | |
rec_token | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/templates
List Templates
200 — Successful Response
json
{}POST /api/v1/newsletter-app/templates
Create Template
Request body
json
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"content_type": {
"type": "string",
"title": "Content Type",
"default": "rich_text"
},
"body": {
"type": "string",
"title": "Body",
"default": ""
},
"design_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Design Json"
}
},
"type": "object",
"required": [
"name"
],
"title": "TemplateIn"
}201 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/templates/{template_id}
Get Template
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
template_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}PUT /api/v1/newsletter-app/templates/{template_id}
Update Template
Update a template in place (the drag-and-drop Template Builder's Save) — unlike POST's upsert-by-name, renames stay on this row.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
template_id | path | yes | string |
Request body
json
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"content_type": {
"type": "string",
"title": "Content Type",
"default": "rich_text"
},
"body": {
"type": "string",
"title": "Body",
"default": ""
},
"design_json": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Design Json"
}
},
"type": "object",
"required": [
"name"
],
"title": "TemplateIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/template-images
Upload Template Image
Store an image for use in a template/campaign body and return its public URL. The URL is absolute (https://<site host>/api/v1/newsletter-app/image/…) because it is embedded in outgoing email, where a relative path is meaningless.
201 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/image/{token}
Serve Template Image
PUBLIC (no auth): serves an uploaded body image to mail clients.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/segments
List Segments
200 — Successful Response
json
{}POST /api/v1/newsletter-app/segments
Create Segment
Request body
json
{
"properties": {
"match": {
"type": "string",
"title": "Match",
"default": "all"
},
"rules": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Rules"
},
"name": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 400
},
{
"type": "null"
}
],
"title": "Description"
}
},
"type": "object",
"required": [
"name"
],
"title": "SegmentIn"
}201 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/segments/{segment_id}
Get Segment
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
segment_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}PUT /api/v1/newsletter-app/segments/{segment_id}
Update Segment
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
segment_id | path | yes | string |
Request body
json
{
"properties": {
"match": {
"type": "string",
"title": "Match",
"default": "all"
},
"rules": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Rules"
},
"name": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string",
"maxLength": 400
},
{
"type": "null"
}
],
"title": "Description"
}
},
"type": "object",
"required": [
"name"
],
"title": "SegmentIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/segments/preview
Preview Segment
How many of the tenant's mailable subscribers (one per address, across every group) the rules match — the live count in the segment editor.
Request body
json
{
"properties": {
"match": {
"type": "string",
"title": "Match",
"default": "all"
},
"rules": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Rules"
}
},
"type": "object",
"title": "SegmentRulesIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/groups/{group_id}/import
Import Group Csv
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
group_id | path | yes | string |
Request body
json
{
"properties": {
"csv": {
"type": "string",
"maxLength": 20000000,
"minLength": 1,
"title": "Csv"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"update_existing": {
"type": "boolean",
"title": "Update Existing",
"default": true
}
},
"type": "object",
"required": [
"csv"
],
"title": "GroupImportIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/groups/{group_id}/export
Export Group Csv
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
group_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/groups/{group_id}/signup-info
Group Signup Info
The public signup URL + an embeddable form for a group.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
group_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/subscribers/history
Subscriber History
Everything that happened to one address on this tenant: memberships, suppression, sends (with open/click) and the event log, newest first.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
email | query | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/subscribe/{group_uuid}
Public Signup Form
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
group_uuid | path | yes | string |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/subscribe/{group_uuid}
Public Signup
Signup form / embed target. Honeypot + minimum fill time + a per-IP hourly cap keep bots out; with double opt-in (default) the address is added UNCONFIRMED and only mailed after it follows the emailed link. The answer never reveals whether an address was already subscribed or is suppressed.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
group_uuid | path | yes | string |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/confirm/{token}
Public Confirm
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token | path | yes | string |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/preferences/{token}
Public Preferences
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token | path | yes | string | |
saved | query | no | integer |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/preferences/{token}
Public Preferences Save
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token | path | yes | string |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/view/{campaign_uuid}/{open_token}
Public Webview
The campaign in a browser (). With the recipient's token it shows their personalised copy; without, a generic one — and only for a campaign that has actually gone out (the uuid is in every sent mail).
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_uuid | path | yes | string | |
open_token | path | yes |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/view/{campaign_uuid}
Public Webview
The campaign in a browser (). With the recipient's token it shows their personalised copy; without, a generic one — and only for a campaign that has actually gone out (the uuid is in every sent mail).
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_uuid | path | yes | string | |
open_token | query | no |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/campaigns/{campaign_id}/report
Campaign Report
Headline numbers, opens/clicks over time (hourly for the first 72h after sending, then daily), per-link clicks with unique clickers, and the A/B variants.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/campaigns/{campaign_id}/links/{link_id}/clickers
Link Clickers
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
campaign_id | path | yes | string | |
link_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/automations/{automation_id}
Get Automation
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
automation_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}PUT /api/v1/newsletter-app/automations/{automation_id}
Update Automation
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
automation_id | path | yes | string |
Request body
json
{
"properties": {
"name": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"title": "Name"
},
"trigger_type": {
"type": "string",
"pattern": "^(subscribed|tag_added|date)$",
"title": "Trigger Type"
},
"trigger_config": {
"additionalProperties": true,
"type": "object",
"title": "Trigger Config"
},
"steps": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Steps"
}
},
"type": "object",
"required": [
"name",
"trigger_type"
],
"title": "AutomationIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/automations
Create Automation
Request body
json
{
"properties": {
"name": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"title": "Name"
},
"trigger_type": {
"type": "string",
"pattern": "^(subscribed|tag_added|date)$",
"title": "Trigger Type"
},
"trigger_config": {
"additionalProperties": true,
"type": "object",
"title": "Trigger Config"
},
"steps": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Steps"
}
},
"type": "object",
"required": [
"name",
"trigger_type"
],
"title": "AutomationIn"
}201 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/automations/{automation_id}/control/{action}
Automation Control
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
automation_id | path | yes | string | |
action | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/automations/{automation_id}/runs
Automation Runs
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
automation_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/api-tokens
Create Api Token
Mint a public-API token. The token is returned ONCE; only its hash is kept.
Request body
json
{
"properties": {
"name": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"title": "Name"
}
},
"type": "object",
"required": [
"name"
],
"title": "ApiTokenIn"
}201 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/webhooks/{webhook_id}/test
Test Webhook
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
webhook_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/transactional-templates/{template_id}
Get Tx Template
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
template_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}PUT /api/v1/newsletter-app/transactional-templates/{template_id}
Update Tx Template
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
template_id | path | yes | string |
Request body
json
{
"properties": {
"name": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"title": "Name"
},
"slug": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Slug"
},
"subject": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"title": "Subject"
},
"body": {
"type": "string",
"title": "Body",
"default": ""
},
"from_name": {
"anyOf": [
{
"type": "string",
"maxLength": 160
},
{
"type": "null"
}
],
"title": "From Name"
},
"from_email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "From Email"
},
"reply_to": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Reply To"
}
},
"type": "object",
"required": [
"name",
"subject"
],
"title": "TxTemplateIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/transactional-templates
Create Tx Template
Request body
json
{
"properties": {
"name": {
"type": "string",
"maxLength": 160,
"minLength": 1,
"title": "Name"
},
"slug": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
],
"title": "Slug"
},
"subject": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"title": "Subject"
},
"body": {
"type": "string",
"title": "Body",
"default": ""
},
"from_name": {
"anyOf": [
{
"type": "string",
"maxLength": 160
},
{
"type": "null"
}
],
"title": "From Name"
},
"from_email": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "From Email"
},
"reply_to": {
"anyOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Reply To"
}
},
"type": "object",
"required": [
"name",
"subject"
],
"title": "TxTemplateIn"
}201 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/transactional-templates/{template_id}/send
Send Tx Template
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
template_id | path | yes | string |
Request body
json
{
"properties": {
"to": {
"type": "string",
"format": "email",
"title": "To"
},
"variables": {
"additionalProperties": true,
"type": "object",
"title": "Variables"
}
},
"type": "object",
"required": [
"to"
],
"title": "TxTestIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/archive/{group_uuid}
Public Archive
Every campaign sent to a group, when the group's archive is public.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
group_uuid | path | yes | string |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/public/v1/groups
Api Groups
200 — Successful Response
json
{}POST /api/v1/newsletter-app/public/v1/subscribe
Api Subscribe
Request body
json
{
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
},
"group": {
"type": "string",
"title": "Group"
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "First Name"
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Name"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"title": "Attributes"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"title": "Tags"
},
"double_opt_in": {
"type": "boolean",
"title": "Double Opt In",
"default": false
}
},
"type": "object",
"required": [
"email",
"group"
],
"title": "ApiSubscribeIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/public/v1/unsubscribe
Api Unsubscribe
Request body
json
{
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Group"
}
},
"type": "object",
"required": [
"email"
],
"title": "ApiUnsubscribeIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/newsletter-app/public/v1/tags
Api Tags
Request body
json
{
"properties": {
"email": {
"type": "string",
"format": "email",
"title": "Email"
},
"add": {
"items": {
"type": "string"
},
"type": "array",
"title": "Add"
},
"remove": {
"items": {
"type": "string"
},
"type": "array",
"title": "Remove"
},
"group": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Group"
}
},
"type": "object",
"required": [
"email"
],
"title": "ApiTagsIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/public/v1/campaigns
Api Campaigns
200 — Successful Response
json
{}POST /api/v1/newsletter-app/public/v1/transactional/send
Api Tx Send
Request body
json
{
"properties": {
"template": {
"type": "string",
"title": "Template"
},
"to": {
"type": "string",
"format": "email",
"title": "To"
},
"variables": {
"additionalProperties": true,
"type": "object",
"title": "Variables"
}
},
"type": "object",
"required": [
"template",
"to"
],
"title": "ApiTxSendIn"
}200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/newsletter-app/transactional-logs/{log_id}
Get Tx Log
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
log_id | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}