Campaigns

One-off e-mail campaigns (newsletters): draft, audience, content, test, approve (send now or schedule), pause, resume, cancel, language variants.

Technická reference je anglicky (stejně jako strojově čitelný dokument OpenAPI). Celou skupinu pro AI agenta načtete z /api/openapi.json?tag=Campaigns.

Přihlášení: Authorization: Bearer pst_... nebo HTTP Basic (e-mail člena firmy a API klíč).

Operace#

List campaigns#

GET /api/v1/tenants/{tenant}/campaigns

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: list_campaigns

Campaigns (draft, scheduled, sending, paused, completed, cancelled) with recipients and stats.

Parametry

Odpovědi

• 200 OK: application/json object

Chyby

Create a campaign (draft)#

POST /api/v1/tenants/{tenant}/campaigns

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full · Nástroj MCP: create_campaign

Creates a campaign draft (only name and shopId are required). Then save_campaign_content, preview_campaign_audience, send_campaign_test and send_campaign.

Parametry

Tělo požadavku (application/json)

Odpovědi

• 201 Created: application/json CampaignDetail

Chyby

Count and explain the recipients of an audience#

POST /api/v1/tenants/{tenant}/campaigns/audience

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: preview_campaign_audience

Counts recipients of an audience without saving: matched, recipients and every excluded reason.

AudienceCount of an audience for a shop: matched, recipients and one reason per left-out contact. anyShop true = the audience of a language variant (lists and segments of any shop).

Parametry

Tělo požadavku (application/json)

object

Odpovědi

• 200 OK: application/json AudienceCount

Chyby

Change labels of campaigns#

POST /api/v1/tenants/{tenant}/campaigns/tags

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full

Parametry

Tělo požadavku (application/json): Required by the server: ids.

Odpovědi

• 200 OK: application/json object

Chyby

Get a campaign#

GET /api/v1/tenants/{tenant}/campaigns/{campaign_id}

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: get_campaign

One campaign with audience, sender, tracking and state.

Parametry

Odpovědi

• 200 OK: application/json CampaignDetail

Chyby

Update a campaign draft#

PATCH /api/v1/tenants/{tenant}/campaigns/{campaign_id}

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full · Nástroj MCP: update_campaign

Changes a draft campaign (any CampaignInput field).

Parametry

Tělo požadavku (application/json)

Odpovědi

• 200 OK: application/json CampaignDetail

Chyby

Delete a campaign draft#

DELETE /api/v1/tenants/{tenant}/campaigns/{campaign_id}

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full · Nástroj MCP: delete_campaign (přes MCP jen s náhledem a potvrzením)

Deletes a draft campaign that sent nothing.

Parametry

Odpovědi

• 204 No content

Chyby

Approve a campaign: send now or schedule#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/approve

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full · Nástroj MCP: send_campaign (přes MCP jen s náhledem a potvrzením)

Approves a draft campaign and sends it now (sendAt null) or schedules it (sendAt ISO time, 5 minutes to 365 days ahead). The preview shows subject, sender and the exact recipient count; expectedRecipients defaults to that count.

Body {sendAt: ISO time in UTC or null (now), expectedRecipients: the number the user confirmed}.

Parametry

Tělo požadavku (application/json)

Odpovědi

• 200 OK: application/json CampaignDetail

Chyby

Cancel a scheduled or paused campaign#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/cancel

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full · Nástroj MCP: cancel_campaign

Cancels a campaign for good (what was sent stays in the statistics).

Parametry

Tělo požadavku (application/json)

object

Odpovědi

• 200 OK: application/json CampaignDetail

Chyby

Get the content of a campaign#

GET /api/v1/tenants/{tenant}/campaigns/{campaign_id}/content

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: get_campaign_content

Content of a campaign (editor, html, design, version).

Parametry

Odpovědi

• 200 OK: application/json EmailContent

Chyby

Save the content of a campaign draft#

PUT /api/v1/tenants/{tenant}/campaigns/{campaign_id}/content

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full · Nástroj MCP: save_campaign_content

Saves the content of a draft campaign (copy a template: get_template, then save its content here).

Parametry

Tělo požadavku (application/json)

Odpovědi

• 200 OK: application/json EmailContent

Chyby

Pause a sending or scheduled campaign#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/pause

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full · Nástroj MCP: pause_campaign

Pauses a scheduled or sending campaign.

Parametry

Tělo požadavku (application/json)

object

Odpovědi

• 200 OK: application/json CampaignDetail

Chyby

Render a campaign for one contact#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/preview

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full

The e-mail as one contact would get it: body {email} of a contact of the tenant; answers {subject, preheader, html} with every merge tag filled and sample links. Nothing is sent or recorded. It shows one contact's data (name, e-mail, custom fields, orders in scripts), so it needs the module contacts too (read): campaigns read alone (content manager, developer) neither reads a contact nor learns whether an address is one (review of batch 8).

Parametry

Tělo požadavku (application/json): Required by the server: email.

Odpovědi

• 200 OK: application/json CampaignPreview

Chyby

Resume a paused campaign#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/resume

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full · Nástroj MCP: resume_campaign (přes MCP jen s náhledem a potvrzením)

Resumes a paused campaign (it sends again, or goes back to scheduled when its time is ahead).

Parametry

Tělo požadavku (application/json)

object

Odpovědi

• 200 OK: application/json CampaignDetail

Chyby

Statistics of a campaign by provider and domain#

GET /api/v1/tenants/{tenant}/campaigns/{campaign_id}/stats

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full

Parametry

Odpovědi

• 200 OK: application/json object

Chyby

Send a test e-mail of a campaign#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/test

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full · Nástroj MCP: send_campaign_test

Sends a test e-mail of the campaign to the account's test addresses only (list_test_recipients).

Parametry

Tělo požadavku (application/json)

Odpovědi

• 200 OK: application/json TestSendResult

Chyby

Get the language variants of a campaign#

GET /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full

Parametry

Odpovědi

• 200 OK: application/json CampaignVariantGroup

Chyby

Create language variants of a campaign#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full

Duplicate as variant: body {shopId, label, sourceLabel?}. Answers the new variant's id and the group.

Parametry

Tělo požadavku (application/json): Required by the server: label, shopId.

Odpovědi

• 201 Created: application/json CampaignVariantGroup

Chyby

Change the language variants of a campaign#

PUT /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full

Order and labels of the group: body {variants: [{id, label}] in the new order, every variant once}.

Parametry

Tělo požadavku (application/json): Required by the server: variants.

Odpovědi

• 200 OK: application/json CampaignVariantGroup

Chyby

Approve the language variants (send or schedule)#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/approve

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full

One send action for every variant: body {sendAt: ISO time or null (now), expectedRecipients: {id: final}}.

Parametry

Tělo požadavku (application/json)

Odpovědi

• 200 OK: application/json CampaignVariantGroup

Chyby

Cancel the language variants#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/cancel

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full

Parametry

Odpovědi

• 200 OK: application/json CampaignVariantGroup

Chyby

Pause the language variants#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/pause

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full

Parametry

Odpovědi

• 200 OK: application/json CampaignVariantGroup

Chyby

Preview the audience split of language variants#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/preview

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full

Final numbers per variant: matched, recipients of its own audience, taken by an earlier variant, final.

Parametry

Odpovědi

• 200 OK: application/json VariantPreview

Chyby

Resume the language variants#

POST /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/resume

Oprávnění: modul campaigns, úroveň full; klíč s přístupem full

Parametry

Odpovědi

• 200 OK: application/json CampaignVariantGroup

Chyby

Statistics of the language variants#

GET /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/stats

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full

Statistics per variant and combined (unique contacts: one variant per contact, so the sums add up).

Parametry

Odpovědi

• 200 OK: application/json VariantStats

Chyby

List saved content versions of a campaign#

GET /api/v1/tenants/{tenant}/campaigns/{campaign_id}/versions

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full

Parametry

Odpovědi

• 200 OK: application/json ContentVersionList

Chyby

Get one content version of a campaign#

GET /api/v1/tenants/{tenant}/campaigns/{campaign_id}/versions/{version_id}

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full

Parametry

Odpovědi

• 200 OK: application/json ContentVersionDetail

Chyby

List verified senders#

GET /api/v1/tenants/{tenant}/senders

Oprávnění: modul campaigns, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: list_senders

Sender addresses per shop (only verified ones may send).

Parametry

Odpovědi

• 200 OK: application/json object

Chyby

Schémata#

ApproveInput#

AudienceCount#

BoxPadding#

CampaignAudience#

CampaignDetail#

CampaignHeader#

CampaignInput#

CampaignLinkParam#

CampaignListItem#

CampaignPreview#

The e-mail as one contact would get it (POST /campaigns/{id}/preview): every merge tag filled, sample links.

CampaignStats#

Unique contacts per event type.

CampaignUtm#

CampaignVariant#

One variant: a whole campaign of its own shop (content, subject, sender, feeds) with an audience chosen by hand.

CampaignVariantGroup#

ContentVersion#

One entry of the content history (Historie uložení).

ContentVersionDetail#

ContentVersionList#

Currency#

one of: CZK, EUR

EmailContent#

E-mail content of a template or a campaign.

EmailContentInput#

EmailDesign#

Source of a visual design: MJML plus the global styles, so the editor reopens it exactly.

EmailStyles#

Global look of a visual design. The editor writes it as MJML attributes; every element can override it.

Error#

{
  "error": {
    "code": "validation",
    "message": "email"
  }
}

GridTagsInput#

Bulk label change: add and remove, or tags = the new labels of every row.

Lang#

one of: cs, sk

MagicBackground#

A background of the Magic editor: a plain colour, a linear gradient or a picture (https).

MagicStyles#

SendTiming#

one of: now, schedule, later

Sender#

TestSendResult#

VariantApproveInput#

VariantPreview#

VariantPreviewItem#

Counts of one variant before sending: its own audience, the recipients an earlier variant takes, the final number.

VariantStats#