Přehled operací
Podrobná technická reference každé skupiny (parametry, těla, odpovědi, chyby a schémata) je anglicky, stejně jako dokument OpenAPI 3.1, ze kterého se generuje. Jen jednu skupinu načtete parametrem ?tag= (například https://www.postarna.cz/api/openapi.json?tag=Automations).
Každá operace v OpenAPI nese:
x-postarna-permission: modul, úroveň a potřebný přístup klíče,x-mcp-tool: nástroj serveru MCP, který ji obaluje,x-mcp-confirm: operace posílá skutečným lidem nebo maže (přes MCP jen s potvrzením),- u odpovědí se seznamem kódů chyb a hodnot
message, které trasa může vrátit.
Cesty se počítají od https://www.postarna.cz; {tenant} je ID firmy.
Contacts
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/tenants/{tenant}/contacts | List contacts (search, filters, paging) |
| POST | /api/v1/tenants/{tenant}/contacts | Create a contact |
| POST | /api/v1/tenants/{tenant}/contacts/bulk | Start a bulk action over contacts in the background |
| GET | /api/v1/tenants/{tenant}/contacts/duplicates | Find possible duplicate contacts |
| GET | /api/v1/tenants/{tenant}/contacts/summary | Count contacts by status |
| GET | /api/v1/tenants/{tenant}/contacts/{contact_id} | Get a contact |
| PATCH | /api/v1/tenants/{tenant}/contacts/{contact_id} | Update a contact |
| DELETE | /api/v1/tenants/{tenant}/contacts/{contact_id} | Delete a contact |
| GET | /api/v1/tenants/{tenant}/contacts/{contact_id}/activities | List activities of a contact |
| POST | /api/v1/tenants/{tenant}/contacts/{contact_id}/activities | Add a manual activity (note) to a contact |
| GET | /api/v1/tenants/{tenant}/contacts/{contact_id}/automation-runs | The real journey of a contact through the automations (runs and steps) |
| POST | /api/v1/tenants/{tenant}/contacts/{contact_id}/blacklist | Blacklist a contact |
| DELETE | /api/v1/tenants/{tenant}/contacts/{contact_id}/blacklist | Remove a contact from the blacklist |
| GET | /api/v1/tenants/{tenant}/contacts/{contact_id}/coupons | List coupons given to a contact |
| POST | /api/v1/tenants/{tenant}/contacts/{contact_id}/erase | Erase a contact (GDPR, irreversible) |
| GET | /api/v1/tenants/{tenant}/contacts/{contact_id}/export | Export all data of a contact (GDPR access) |
| GET | /api/v1/tenants/{tenant}/contacts/{contact_id}/neighbors | Previous and next contact of a filtered list |
| GET | /api/v1/tenants/{tenant}/contacts/{contact_id}/purposes | List consents (purposes) of a contact |
| POST | /api/v1/tenants/{tenant}/contacts/{contact_id}/purposes | Record a consent (purpose) of a contact |
| POST | /api/v1/tenants/{tenant}/contacts/{contact_id}/purposes/{consent_id}/withdraw | Withdraw a consent of a contact |
| GET | /api/v1/tenants/{tenant}/contacts/{contact_id}/segments | List segments a contact belongs to |
| POST | /api/v1/tenants/{tenant}/contacts/{contact_id}/unsubscribe | Unsubscribe a contact from everything |
| GET | /api/v1/tenants/{tenant}/custom-fields | List custom fields |
| POST | /api/v1/tenants/{tenant}/custom-fields | Create a custom field |
| PATCH | /api/v1/tenants/{tenant}/custom-fields/{field_id} | Update a custom field |
| DELETE | /api/v1/tenants/{tenant}/custom-fields/{field_id} | Delete a custom field |
| GET | /api/v1/tenants/{tenant}/purposes | List purposes of processing (consent types) |
| POST | /api/v1/tenants/{tenant}/purposes | Create a purpose of processing |
| PATCH | /api/v1/tenants/{tenant}/purposes/{purpose_id} | Update a purpose of processing |
| DELETE | /api/v1/tenants/{tenant}/purposes/{purpose_id} | Delete a purpose of processing |
| POST | /api/v1/tenants/{tenant}/purposes/{purpose_id}/to-contact-list | Create a list of the contacts with a purpose |
| GET | /api/v1/tenants/{tenant}/search | Search contacts, campaigns, templates and more |
| GET | /api/v1/tenants/{tenant}/suppressions | List suppressed addresses |
| POST | /api/v1/tenants/{tenant}/suppressions | Suppress an address |
| POST | /api/v1/tenants/{tenant}/suppressions/blacklist-import | Import addresses to the blacklist |
| DELETE | /api/v1/tenants/{tenant}/suppressions/{email} | Remove one suppression |
Lists
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/tenants/{tenant}/lists | List contact lists |
| POST | /api/v1/tenants/{tenant}/lists | Create a list |
| POST | /api/v1/tenants/{tenant}/lists/merge | Merge lists into a new list (background) |
| POST | /api/v1/tenants/{tenant}/lists/tags | Change labels of lists |
| GET | /api/v1/tenants/{tenant}/lists/{list_id} | Get a list |
| PATCH | /api/v1/tenants/{tenant}/lists/{list_id} | Update a list |
| DELETE | /api/v1/tenants/{tenant}/lists/{list_id} | Delete a list (only the list, with its contacts, or keeping contacts in other lists) |
| POST | /api/v1/tenants/{tenant}/lists/{list_id}/autofill | Fill empty name day, gender and salutations of the members |
| POST | /api/v1/tenants/{tenant}/lists/{list_id}/copy | Copy a list with its members |
| GET | /api/v1/tenants/{tenant}/lists/{list_id}/members | List members of a list |
| POST | /api/v1/tenants/{tenant}/lists/{list_id}/members | Add contacts to a list |
| POST | /api/v1/tenants/{tenant}/lists/{list_id}/members/remove | Remove contacts from a list |
| POST | /api/v1/tenants/{tenant}/lists/{list_id}/members/unsubscribe | Unsubscribe contacts from a list |
Segments
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/tenants/{tenant}/segments | List segments |
| POST | /api/v1/tenants/{tenant}/segments | Create a segment |
| POST | /api/v1/tenants/{tenant}/segments/preview | Count the contacts of a segment definition (no save) |
| POST | /api/v1/tenants/{tenant}/segments/tags | Change labels of segments |
| GET | /api/v1/tenants/{tenant}/segments/{segment} | Get a segment |
| PATCH | /api/v1/tenants/{tenant}/segments/{segment} | Update a segment |
| DELETE | /api/v1/tenants/{tenant}/segments/{segment} | Delete a segment no campaign, segment or automation names |
| GET | /api/v1/tenants/{tenant}/segments/{segment}/members | List the members of a segment |
| POST | /api/v1/tenants/{tenant}/segments/{segment}/recompute | Recompute a segment now |
| POST | /api/v1/tenants/{tenant}/segments/{segment}/to-list | Convert a segment into a manual list of its mailable contacts |
Campaigns
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/tenants/{tenant}/campaigns | List campaigns |
| POST | /api/v1/tenants/{tenant}/campaigns | Create a campaign (draft) |
| POST | /api/v1/tenants/{tenant}/campaigns/audience | Count and explain the recipients of an audience |
| POST | /api/v1/tenants/{tenant}/campaigns/tags | Change labels of campaigns |
| GET | /api/v1/tenants/{tenant}/campaigns/{campaign_id} | Get a campaign |
| PATCH | /api/v1/tenants/{tenant}/campaigns/{campaign_id} | Update a campaign draft |
| DELETE | /api/v1/tenants/{tenant}/campaigns/{campaign_id} | Delete a campaign draft |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/approve | Approve a campaign: send now or schedule |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/cancel | Cancel a scheduled or paused campaign |
| GET | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/content | Get the content of a campaign |
| PUT | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/content | Save the content of a campaign draft |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/pause | Pause a sending or scheduled campaign |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/preview | Render a campaign for one contact |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/resume | Resume a paused campaign |
| GET | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/stats | Statistics of a campaign by provider and domain |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/test | Send a test e-mail of a campaign |
| GET | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants | Get the language variants of a campaign |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants | Create language variants of a campaign |
| PUT | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants | Change the language variants of a campaign |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/approve | Approve the language variants (send or schedule) |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/cancel | Cancel the language variants |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/pause | Pause the language variants |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/preview | Preview the audience split of language variants |
| POST | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/resume | Resume the language variants |
| GET | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/variants/stats | Statistics of the language variants |
| GET | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/versions | List saved content versions of a campaign |
| GET | /api/v1/tenants/{tenant}/campaigns/{campaign_id}/versions/{version_id} | Get one content version of a campaign |
| GET | /api/v1/tenants/{tenant}/senders | List verified senders |
Templates and content
| Metoda | Cesta | Popis |
|---|---|---|
| POST | /api/v1/tenants/{tenant}/content/lint | Check e-mail content (merge tags, links, required parts) |
| POST | /api/v1/tenants/{tenant}/content/spam-check | Antispam check of e-mail content |
| GET | /api/v1/tenants/{tenant}/editor-elements | List saved editor elements |
| POST | /api/v1/tenants/{tenant}/editor-elements | Save an editor element |
| PATCH | /api/v1/tenants/{tenant}/editor-elements/{element_id} | Update a saved editor element |
| DELETE | /api/v1/tenants/{tenant}/editor-elements/{element_id} | Delete a saved editor element |
| GET | /api/v1/tenants/{tenant}/file-folders | List folders of the file manager |
| POST | /api/v1/tenants/{tenant}/file-folders | Create a folder |
| PATCH | /api/v1/tenants/{tenant}/file-folders/{folder_id} | Rename a folder |
| DELETE | /api/v1/tenants/{tenant}/file-folders/{folder_id} | Delete a folder |
| GET | /api/v1/tenants/{tenant}/files | List files of the file manager |
| POST | /api/v1/tenants/{tenant}/files | Upload a file (multipart) |
| POST | /api/v1/tenants/{tenant}/files/stock-photo | Save a stock photo to the file manager |
| POST | /api/v1/tenants/{tenant}/files/video-thumbnail | Create a video thumbnail image |
| GET | /api/v1/tenants/{tenant}/files/{asset_id} | Get a file |
| PATCH | /api/v1/tenants/{tenant}/files/{asset_id} | Rename or move a file |
| DELETE | /api/v1/tenants/{tenant}/files/{asset_id} | Delete a file |
| POST | /api/v1/tenants/{tenant}/files/{asset_id}/picked | Record that a file was used |
| GET | /api/v1/tenants/{tenant}/footers | List footers |
| POST | /api/v1/tenants/{tenant}/footers | Create a footer |
| GET | /api/v1/tenants/{tenant}/footers/{footer_id} | Get a footer |
| PATCH | /api/v1/tenants/{tenant}/footers/{footer_id} | Rename a footer |
| DELETE | /api/v1/tenants/{tenant}/footers/{footer_id} | Delete a footer |
| PUT | /api/v1/tenants/{tenant}/footers/{footer_id}/content | Save the content of a footer |
| POST | /api/v1/tenants/{tenant}/footers/{footer_id}/copy | Copy a footer |
| POST | /api/v1/tenants/{tenant}/footers/{footer_id}/default | Make a footer the default |
| DELETE | /api/v1/tenants/{tenant}/footers/{footer_id}/default | Stop using a footer as the default |
| POST | /api/v1/tenants/{tenant}/footers/{footer_id}/publish | Publish a footer |
| GET | /api/v1/tenants/{tenant}/footers/{footer_id}/versions | List saved versions of a footer |
| GET | /api/v1/tenants/{tenant}/footers/{footer_id}/versions/{version_id} | Get one version of a footer |
| GET | /api/v1/tenants/{tenant}/landing-pages | List landing pages |
| POST | /api/v1/tenants/{tenant}/landing-pages | Create a landing page |
| GET | /api/v1/tenants/{tenant}/landing-pages/{landing_page_id} | Get a landing page |
| PATCH | /api/v1/tenants/{tenant}/landing-pages/{landing_page_id} | Update a landing page |
| DELETE | /api/v1/tenants/{tenant}/landing-pages/{landing_page_id} | Delete a landing page |
| POST | /api/v1/tenants/{tenant}/landing-pages/{landing_page_id}/copy | Copy a landing page |
| GET | /api/v1/tenants/{tenant}/script-templates | List script templates (Twig) |
| POST | /api/v1/tenants/{tenant}/script-templates | Create a script template |
| GET | /api/v1/tenants/{tenant}/script-templates/{script_id} | Get a script template |
| PATCH | /api/v1/tenants/{tenant}/script-templates/{script_id} | Update a script template |
| DELETE | /api/v1/tenants/{tenant}/script-templates/{script_id} | Delete a script template |
| GET | /api/v1/tenants/{tenant}/sms-templates | List SMS templates |
| POST | /api/v1/tenants/{tenant}/sms-templates | Create an SMS template |
| GET | /api/v1/tenants/{tenant}/sms-templates/{sms_template_id} | Get an SMS template |
| PATCH | /api/v1/tenants/{tenant}/sms-templates/{sms_template_id} | Update an SMS template |
| DELETE | /api/v1/tenants/{tenant}/sms-templates/{sms_template_id} | Delete an SMS template |
| POST | /api/v1/tenants/{tenant}/sms-templates/{sms_template_id}/copy | Copy an SMS template |
| GET | /api/v1/tenants/{tenant}/stock-photos | Search stock photos |
| GET | /api/v1/tenants/{tenant}/stock-photos/status | Whether the stock photo search is available |
| GET | /api/v1/tenants/{tenant}/surveys | List surveys |
| POST | /api/v1/tenants/{tenant}/surveys | Create a survey |
| GET | /api/v1/tenants/{tenant}/surveys/{survey_id} | Get a survey |
| PATCH | /api/v1/tenants/{tenant}/surveys/{survey_id} | Update a survey |
| DELETE | /api/v1/tenants/{tenant}/surveys/{survey_id} | Delete a survey |
| POST | /api/v1/tenants/{tenant}/surveys/{survey_id}/copy | Copy a survey |
| GET | /api/v1/tenants/{tenant}/surveys/{survey_id}/responses | List responses of a survey |
| GET | /api/v1/tenants/{tenant}/surveys/{survey_id}/results | Summary results of a survey |
| GET | /api/v1/tenants/{tenant}/templates | List templates |
| POST | /api/v1/tenants/{tenant}/templates | Create a template |
| POST | /api/v1/tenants/{tenant}/templates/tags | Change labels of templates |
| GET | /api/v1/tenants/{tenant}/templates/{template_id} | Get a template with its content |
| PATCH | /api/v1/tenants/{tenant}/templates/{template_id} | Update template settings (name, subject, preheader ...) |
| DELETE | /api/v1/tenants/{tenant}/templates/{template_id} | Delete a template |
| POST | /api/v1/tenants/{tenant}/templates/{template_id}/archive | Archive a template |
| PUT | /api/v1/tenants/{tenant}/templates/{template_id}/content | Save the content of a template |
| POST | /api/v1/tenants/{tenant}/templates/{template_id}/convert-to-visual | Convert an HTML template to the visual editor |
| DELETE | /api/v1/tenants/{tenant}/templates/{template_id}/draft | Discard the unpublished draft of a template |
| POST | /api/v1/tenants/{tenant}/templates/{template_id}/duplicate | Duplicate a template |
| POST | /api/v1/tenants/{tenant}/templates/{template_id}/publish | Publish the draft of a template used by an active automation |
| POST | /api/v1/tenants/{tenant}/templates/{template_id}/test | Send a test e-mail of a template |
| POST | /api/v1/tenants/{tenant}/templates/{template_id}/unarchive | Restore an archived template |
| GET | /api/v1/tenants/{tenant}/templates/{template_id}/versions | List saved content versions of a template |
| GET | /api/v1/tenants/{tenant}/templates/{template_id}/versions/{version_id} | Get one content version of a template |
| GET | /api/v1/tenants/{tenant}/test-recipients | List the test addresses of the company |
| PUT | /api/v1/tenants/{tenant}/test-recipients | Replace the test addresses of the company |
| GET | /api/v1/tenants/{tenant}/unsubscribe-pages | List unsubscribe pages |
| POST | /api/v1/tenants/{tenant}/unsubscribe-pages | Create an unsubscribe page |
| POST | /api/v1/tenants/{tenant}/unsubscribe-pages/preview | Render an unsubscribe page preview |
| GET | /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id} | Get an unsubscribe page |
| PATCH | /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id} | Update an unsubscribe page |
| DELETE | /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id} | Delete an unsubscribe page |
| POST | /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/copy | Copy an unsubscribe page |
| POST | /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/default | Make an unsubscribe page the default |
| DELETE | /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/default | Stop using an unsubscribe page as the default |
Automations
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/tenants/{tenant}/automations | List automations |
| POST | /api/v1/tenants/{tenant}/automations | Create an automation (draft) |
| POST | /api/v1/tenants/{tenant}/automations/resolve-time | Resolve a time spec to a moment (preview) |
| POST | /api/v1/tenants/{tenant}/automations/tags | Change labels of automations |
| POST | /api/v1/tenants/{tenant}/automations/validate | Validate a graph without saving |
| GET | /api/v1/tenants/{tenant}/automations/{automation_id} | Get an automation with its graph and issues |
| PATCH | /api/v1/tenants/{tenant}/automations/{automation_id} | Update name, description or labels of an automation |
| DELETE | /api/v1/tenants/{tenant}/automations/{automation_id} | Delete an automation that never ran |
| POST | /api/v1/tenants/{tenant}/automations/{automation_id}/activate | Activate (start) an automation |
| POST | /api/v1/tenants/{tenant}/automations/{automation_id}/contacts | Add contacts by hand to a running automation |
| POST | /api/v1/tenants/{tenant}/automations/{automation_id}/copy | Copy an automation as a new draft |
| GET | /api/v1/tenants/{tenant}/automations/{automation_id}/counts | Live counts per node and output |
| POST | /api/v1/tenants/{tenant}/automations/{automation_id}/editing | Report that the editor has a scenario open and see who else has it |
| GET | /api/v1/tenants/{tenant}/automations/{automation_id}/editor | Everything the editor needs in one answer |
| PUT | /api/v1/tenants/{tenant}/automations/{automation_id}/graph | Save the graph of an automation (new version) |
| GET | /api/v1/tenants/{tenant}/automations/{automation_id}/nodes/{key}/passes | Contacts that went through a node |
| POST | /api/v1/tenants/{tenant}/automations/{automation_id}/nodes/{key}/release | Release the contacts waiting in a node |
| POST | /api/v1/tenants/{tenant}/automations/{automation_id}/nodes/{key}/reschedule | Recompute the end of waiting in a node |
| POST | /api/v1/tenants/{tenant}/automations/{automation_id}/pause | Pause an automation |
| GET | /api/v1/tenants/{tenant}/automations/{automation_id}/report | Statistics of the e-mail nodes (JSON or CSV) |
| GET | /api/v1/tenants/{tenant}/automations/{automation_id}/runs | Run history per contact |
| POST | /api/v1/tenants/{tenant}/automations/{automation_id}/test | Test the scenario on today's data (nothing is sent) |
| POST | /api/v1/tenants/{tenant}/automations/{automation_id}/trace | Trace one contact through the scenario (nothing is sent) |
| GET | /api/v1/tenants/{tenant}/automations/{automation_id}/versions | List saved versions of the graph |
| GET | /api/v1/tenants/{tenant}/automations/{automation_id}/versions/{version} | Get one saved version of the graph |
| POST | /api/v1/tenants/{tenant}/contact-events | Record an event of a contact (custom event, cart, page visit) |
Forms
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/tenants/{tenant}/forms | List forms |
| POST | /api/v1/tenants/{tenant}/forms | Create a form |
| GET | /api/v1/tenants/{tenant}/forms/doi-templates | List templates usable as the double opt-in e-mail |
| POST | /api/v1/tenants/{tenant}/forms/preview | Render a form preview |
| POST | /api/v1/tenants/{tenant}/forms/tags | Change labels of forms |
| GET | /api/v1/tenants/{tenant}/forms/{form_id} | Get a form |
| PATCH | /api/v1/tenants/{tenant}/forms/{form_id} | Update a form |
| DELETE | /api/v1/tenants/{tenant}/forms/{form_id} | Delete a form |
| POST | /api/v1/tenants/{tenant}/forms/{form_id}/copy | Copy a form |
| GET | /api/v1/tenants/{tenant}/forms/{form_id}/embed | Get the embed code of a form |
| GET | /api/v1/tenants/{tenant}/forms/{form_id}/history | Change history of a form |
| GET | /api/v1/tenants/{tenant}/forms/{form_id}/welcome | Get the e-mail after a sign-up (the form's own automation) |
| PUT | /api/v1/tenants/{tenant}/forms/{form_id}/welcome | Switch the e-mail after a sign-up on or off |
Imports and exports
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/tenants/{tenant}/export-fields | Fields an export can contain |
| GET | /api/v1/tenants/{tenant}/exports | List exports |
| POST | /api/v1/tenants/{tenant}/exports | Start a CSV export |
| GET | /api/v1/tenants/{tenant}/exports/{export_id} | Get an export |
| GET | /api/v1/tenants/{tenant}/exports/{export_id}/download | Download an export (CSV) |
| GET | /api/v1/tenants/{tenant}/imports | List imports |
| POST | /api/v1/tenants/{tenant}/imports | Start an import |
| POST | /api/v1/tenants/{tenant}/imports/drafts | Start an import draft (wizard) |
| GET | /api/v1/tenants/{tenant}/imports/drafts/{import_id} | Get an import draft |
| PUT | /api/v1/tenants/{tenant}/imports/drafts/{import_id} | Save an import draft |
| POST | /api/v1/tenants/{tenant}/imports/files | Upload a CSV file for import |
| POST | /api/v1/tenants/{tenant}/imports/preview | Preview an import: mapping, counts, problems |
| GET | /api/v1/tenants/{tenant}/imports/{import_id} | Get an import with its progress and result |
| DELETE | /api/v1/tenants/{tenant}/imports/{import_id} | Delete an import record |
Orders, feeds and coupons
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/tenants/{tenant}/coupon-stacks | List coupon stacks |
| POST | /api/v1/tenants/{tenant}/coupon-stacks | Create a coupon stack |
| GET | /api/v1/tenants/{tenant}/coupon-stacks/{stack_id} | Get a coupon stack |
| DELETE | /api/v1/tenants/{tenant}/coupon-stacks/{stack_id} | Delete a coupon stack |
| POST | /api/v1/tenants/{tenant}/coupon-stacks/{stack_id}/assign | Give a coupon of a stack to a contact |
| POST | /api/v1/tenants/{tenant}/coupon-stacks/{stack_id}/codes | Add coupon codes to a stack |
| GET | /api/v1/tenants/{tenant}/coupon-stacks/{stack_id}/coupons | List coupons of a stack |
| POST | /api/v1/tenants/{tenant}/coupon-stacks/{stack_id}/used | Mark coupons as used |
| GET | /api/v1/tenants/{tenant}/feed-articles | Search articles of the article feeds |
| GET | /api/v1/tenants/{tenant}/feed-products | Search products of the product feeds |
| GET | /api/v1/tenants/{tenant}/feeds | List feeds |
| POST | /api/v1/tenants/{tenant}/feeds | Create a feed |
| GET | /api/v1/tenants/{tenant}/feeds/{feed_id} | Get a feed |
| PATCH | /api/v1/tenants/{tenant}/feeds/{feed_id} | Update a feed |
| DELETE | /api/v1/tenants/{tenant}/feeds/{feed_id} | Delete a feed |
| POST | /api/v1/tenants/{tenant}/feeds/{feed_id}/import | Import a feed file by upload |
| GET | /api/v1/tenants/{tenant}/feeds/{feed_id}/items | List items of a feed |
| GET | /api/v1/tenants/{tenant}/feeds/{feed_id}/preview | Preview a feed (first items, detected fields) |
| POST | /api/v1/tenants/{tenant}/feeds/{feed_id}/refresh | Download and process a feed now |
| GET | /api/v1/tenants/{tenant}/order-states | Get the order state mapping |
| PUT | /api/v1/tenants/{tenant}/order-states | Replace the order state mapping |
| GET | /api/v1/tenants/{tenant}/orders | List orders |
| POST | /api/v1/tenants/{tenant}/orders | Create or update an order |
| POST | /api/v1/tenants/{tenant}/orders/paid-at | Maintenance: fill empty dates of payment of orders (SmartEmailing data) |
| GET | /api/v1/tenants/{tenant}/orders/{order_id} | Get an order |
Statistics
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/tenants/{tenant}/conversions | Conversions summary |
| GET | /api/v1/tenants/{tenant}/dashboard | Dashboard numbers |
| GET | /api/v1/tenants/{tenant}/stats/automations/{automation_id} | Statistics of an automation |
| GET | /api/v1/tenants/{tenant}/stats/automations/{automation_id}/activity | Activity of an automation over time |
| GET | /api/v1/tenants/{tenant}/stats/automations/{automation_id}/conversions | Conversions (orders) of an automation |
| GET | /api/v1/tenants/{tenant}/stats/automations/{automation_id}/heatmap | Click map of an automation |
| GET | /api/v1/tenants/{tenant}/stats/automations/{automation_id}/recipients | Recipients of an automation with their events (JSON or CSV) |
| GET | /api/v1/tenants/{tenant}/stats/automations/{automation_id}/report | Report of an automation (JSON or CSV) |
| GET | /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id} | Statistics of a campaign |
| GET | /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/activity | Activity of a campaign over time |
| GET | /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/conversions | Conversions (orders) of a campaign |
| GET | /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/heatmap | Click map of a campaign |
| GET | /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/recipients | Recipients of a campaign with their events (JSON or CSV) |
| GET | /api/v1/tenants/{tenant}/stats/campaigns/{campaign_id}/report | Report of a campaign (JSON or CSV) |
| GET | /api/v1/tenants/{tenant}/stats/emails | E-mail statistics of campaigns and automations |
Sending and deliverability
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/tenants/{tenant}/deliverability/dmarc | DMARC summary |
| GET | /api/v1/tenants/{tenant}/deliverability/dmarc/report | DMARC report detail |
| GET | /api/v1/tenants/{tenant}/deliverability/domains | List domains with their DNS state |
| POST | /api/v1/tenants/{tenant}/deliverability/domains | Add a domain |
| PATCH | /api/v1/tenants/{tenant}/deliverability/domains/{domain_id} | Update a domain |
| DELETE | /api/v1/tenants/{tenant}/deliverability/domains/{domain_id} | Delete a domain |
| POST | /api/v1/tenants/{tenant}/deliverability/domains/{domain_id}/check | Check the DNS records of a domain now |
| GET | /api/v1/tenants/{tenant}/deliverability/senders | Senders with their authentication state |
| GET | /api/v1/tenants/{tenant}/sending-defaults | Get the default settings of new campaigns (tracking parameters on or off) |
| PUT | /api/v1/tenants/{tenant}/sending-defaults | Set whether new campaigns start with tracking parameters |
| GET | /api/v1/tenants/{tenant}/sending-mode | Sending mode of the company (switch, limits) |
| POST | /api/v1/tenants/{tenant}/sending/domains | Add a sending domain |
| DELETE | /api/v1/tenants/{tenant}/sending/domains/{domain_id} | Delete a sending domain |
| POST | /api/v1/tenants/{tenant}/sending/domains/{domain_id}/check | Check a sending domain |
| POST | /api/v1/tenants/{tenant}/sending/senders | Add a sender |
| PATCH | /api/v1/tenants/{tenant}/sending/senders/{sender_id} | Update a sender |
| DELETE | /api/v1/tenants/{tenant}/sending/senders/{sender_id} | Delete a sender |
| POST | /api/v1/tenants/{tenant}/sending/senders/{sender_id}/check | Check whether a sender address is confirmed |
| POST | /api/v1/tenants/{tenant}/sending/senders/{sender_id}/resend | Send the confirmation e-mail of a sender address again |
| GET | /api/v1/tenants/{tenant}/sending/senders/{sender_id}/usage | Where a sender is used |
| GET | /api/v1/tenants/{tenant}/sending/setup | State of the sending setup (domains and senders) |
Account and settings
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/public/price-list | Public price list (no authentication) |
| GET | /api/v1/tenants/{tenant}/account-webhooks | List account webhooks and their events |
| POST | /api/v1/tenants/{tenant}/account-webhooks | Create an account webhook |
| PATCH | /api/v1/tenants/{tenant}/account-webhooks/{webhook_id} | Edit, switch off or on an account webhook |
| DELETE | /api/v1/tenants/{tenant}/account-webhooks/{webhook_id} | Delete an account webhook |
| POST | /api/v1/tenants/{tenant}/account-webhooks/{webhook_id}/test | Send a test call of an account webhook now |
| GET | /api/v1/tenants/{tenant}/billing | Tariff, usage and balance |
| GET | /api/v1/tenants/{tenant}/billing/cancel | What cancelling the tariff would mean |
| GET | /api/v1/tenants/{tenant}/billing/invoices | List invoices |
| GET | /api/v1/tenants/{tenant}/billing/invoices/{invoice_id}/pdf | Download an invoice (PDF) |
| GET | /api/v1/tenants/{tenant}/billing/invoices/{invoice_id}/qr.svg | QR payment code of an invoice (SVG) |
| GET | /api/v1/tenants/{tenant}/billing/payments | List payments |
| GET | /api/v1/tenants/{tenant}/billing/profile | Get the billing profile |
| GET | /api/v1/tenants/{tenant}/billing/quote | Price of a tariff |
| GET | /api/v1/tenants/{tenant}/company | Get the company data |
| PATCH | /api/v1/tenants/{tenant}/company | Update the company data |
| GET | /api/v1/tenants/{tenant}/consent-settings | Consent settings of every shop |
| PATCH | /api/v1/tenants/{tenant}/consent-settings/{shop_id} | Update the customer exception of a shop |
| GET | /api/v1/tenants/{tenant}/grid-tags | Labels used in a grid |
| GET | /api/v1/tenants/{tenant}/labels | List labels |
| POST | /api/v1/tenants/{tenant}/labels | Create a label |
| PATCH | /api/v1/tenants/{tenant}/labels/{label_id} | Update a label |
| DELETE | /api/v1/tenants/{tenant}/labels/{label_id} | Delete a label |
| POST | /api/v1/tenants/{tenant}/labels/{label_id}/assign | Assign a label to objects |
| POST | /api/v1/tenants/{tenant}/maintenance/phone-landline-mobile | Maintenance: move landline-stored mobile numbers to mobile (dry run unless apply) |
| POST | /api/v1/tenants/{tenant}/maintenance/se-backfill-contacts | Maintenance: fill empty contact fields from a SmartEmailing backup (dry run unless apply) |
| POST | /api/v1/tenants/{tenant}/maintenance/shop-enrich | Maintenance: fill empty contact fields from the e-shop feeds (dry run unless apply) |
| POST | /api/v1/tenants/{tenant}/maintenance/shop-lists | Maintenance: rebuild the e-shop lists (dry run unless apply) |
| GET | /api/v1/tenants/{tenant}/notifications | List notifications |
| POST | /api/v1/tenants/{tenant}/notifications/delete | Delete notifications |
| POST | /api/v1/tenants/{tenant}/notifications/read | Mark notifications as read |
| POST | /api/v1/tenants/{tenant}/notifications/unread | Mark notifications as unread |
| GET | /api/v1/tenants/{tenant}/onboarding | State of the onboarding wizard |
| PATCH | /api/v1/tenants/{tenant}/onboarding | Save the onboarding wizard |
| GET | /api/v1/tenants/{tenant}/rfm | State of the RFM analysis |
| POST | /api/v1/tenants/{tenant}/rfm/enable-request | Ask to enable the RFM analysis |
| GET | /api/v1/tenants/{tenant}/running-actions | Running background actions (imports, exports ...) |
| GET | /api/v1/tenants/{tenant}/shop-enrich | Whether order feed imports fill empty contact fields |
| PUT | /api/v1/tenants/{tenant}/shop-enrich | Turn the ongoing contact data enrichment on or off |
| GET | /api/v1/tenants/{tenant}/shop-settings | Sending company data of every shop |
| PATCH | /api/v1/tenants/{tenant}/shop-settings/{shop_id} | Update the sending company data of a shop |
| GET | /api/v1/tenants/{tenant}/shops | List shops (e-shops) of the company |
| POST | /api/v1/tenants/{tenant}/shops | Create a shop |
| GET | /api/v1/tenants/{tenant}/shops/{shop_id} | Get a shop |
| PATCH | /api/v1/tenants/{tenant}/shops/{shop_id} | Update a shop |
| GET | /api/v1/tenants/{tenant}/shops/{shop_id}/brand | Get the brand settings of a shop |
| PUT | /api/v1/tenants/{tenant}/shops/{shop_id}/brand | Replace the brand settings of a shop |
| PUT | /api/v1/tenants/{tenant}/shops/{shop_id}/contact-language | Set the default language of new contacts of a shop |
| POST | /api/v1/tenants/{tenant}/shops/{shop_id}/disable | Switch a shop off |
| POST | /api/v1/tenants/{tenant}/shops/{shop_id}/enable | Switch a shop on |
| GET | /api/v1/tenants/{tenant}/site-script | Every shop's one script line and connection state |
| PATCH | /api/v1/tenants/{tenant}/site-script/{shop_id} | Switch the checkout newsletter box of a shop |
| POST | /api/v1/tenants/{tenant}/site-script/{shop_id}/check | Test whether the script is on the shop's homepage |
| GET | /api/v1/tenants/{tenant}/smartemailing | State of the SmartEmailing migration |
| GET | /api/v1/tenants/{tenant}/smartemailing/migrations/{migration_id} | Get one SmartEmailing migration run |
| GET | /api/v1/tenants/{tenant}/web-tracking | Web tracking state of every shop |
| GET | /api/v1/tenants/{tenant}/web-tracking/events | List web tracking events |
| PATCH | /api/v1/tenants/{tenant}/web-tracking/{shop_id} | Switch web tracking of a shop |
SmartEmailing compatible API v3
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/v3/account-info | Account info (guid = tenant id for API v1) |
| GET | /api/v3/check-credentials | Check the credentials |
| POST | /api/v3/check-credentials | Check the credentials |
| GET | /api/v3/contactlists | List contact lists |
| GET | /api/v3/contactlists/{list_id} | Get a contact list |
| GET | /api/v3/contacts | List contacts |
| GET | /api/v3/contacts/{contact_id} | Get a contact |
| GET | /api/v3/customfields | List custom fields |
| GET | /api/v3/ping | Ping (no authentication) |
| GET | /api/v3/web-hooks | List account webhooks |
| POST | /api/v3/web-hooks | Register an account webhook |
| DELETE | /api/v3/web-hooks/{webhook_id} | Delete an account webhook |
SmartEmailing compatible CSV statistics
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/csv/list-contacts | Members of a list (CSV) |
| GET | /api/csv/statistics/email/automation-email-statistic-id | E-mail statistic ids of automation e-mail nodes |
| GET | /api/csv/statistics/email/automation-email-statistic-id/{automation_id} | E-mail statistic ids of automation e-mail nodes of one automation |
| GET | /api/csv/statistics/email/{kind}-detail/{sid} | Per-contact events of an e-mail statistic id (sent, opened, clicked, bounced, unsubscribed) |
MCP server for AI assistants
| Metoda | Cesta | Popis |
|---|---|---|
| POST | /mcp | MCP JSON-RPC endpoint (Streamable HTTP, stateless) |
OAuth 2.1 for AI assistants
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /.well-known/oauth-authorization-server | Authorization server metadata (RFC 8414) |
| GET | /.well-known/oauth-authorization-server/mcp | Authorization server metadata (RFC 8414) |
| GET | /.well-known/oauth-protected-resource | Protected resource metadata (RFC 9728) |
| GET | /.well-known/oauth-protected-resource/mcp | Protected resource metadata (RFC 9728) |
| GET | /oauth/authorize | Authorization (browser redirect to the consent page) |
| POST | /oauth/register | Dynamic client registration (RFC 7591, at most 20 an hour per address) |
| POST | /oauth/revoke | Revoke a token (RFC 7009) |
| POST | /oauth/token | Tokens: authorization_code or refresh_token (access pso_... 1 hour, refresh psr_... 30 days, rotated) |
This document
| Metoda | Cesta | Popis |
|---|---|---|
| GET | /api/openapi.json | This OpenAPI document |