Account and settings

Shops (e-shops) of the company, company data, consent settings, notifications, labels, web tracking, billing (read), SmartEmailing migration state.

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

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

Operace

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

Public price list (no authentication)

GET /api/v1/public/price-list

Bez přihlášení.

The active tiers and the settings of the calculator (public, as SmartEmailing's price list on its web).

Odpovědi

200 OK: application/json PriceList

List account webhooks and their events

GET /api/v1/tenants/{tenant}/account-webhooks

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

{items, events, silentEvents, limit}: the company's account webhooks (oldest first), the events a webhook can listen to (SmartEmailing's 11) and those accepted for compatibility that never fire yet.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json AccountWebhooks

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Create an account webhook

POST /api/v1/tenants/{tenant}/account-webhooks

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

{url, event, basicAuth?: {login, password}} -> 201 the webhook. Only what happens after the registration is sent. 400 validation url | event | basicAuth, 409 conflict url (the same address and event) | limit.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

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

Pole	Typ	Povinné	Popis
`url`	string	ne
`event`	one of: `new_contact`, `updated_contact`, `unsubscribed_contact`, `email_delivery_started`, `delivery_status`, `sent_email`, `email_open`, `email_click`, `scoring_result_changed`, `engagement_level_changed`, `sms_delivery_status`	ne
`active`	boolean	ne
`basicAuth`	object or null	ne	null removes the credentials; password '' keeps the stored password (edit only).

Odpovědi

201 Created: application/json AccountWebhook

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Edit, switch off or on an account webhook

PATCH /api/v1/tenants/{tenant}/account-webhooks/{webhook_id}

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

{url?, event?, active?, basicAuth?}: basicAuth null removes the credentials, {login, password: ''} keeps the password. A changed event starts at the newest item; switching on again clears the errors.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`webhook_id`	path	string	ano	Id of the webhook (string of digits).

Tělo požadavku (application/json)

Pole	Typ	Povinné	Popis
`url`	string	ne
`event`	one of: `new_contact`, `updated_contact`, `unsubscribed_contact`, `email_delivery_started`, `delivery_status`, `sent_email`, `email_open`, `email_click`, `scoring_result_changed`, `engagement_level_changed`, `sms_delivery_status`	ne
`active`	boolean	ne
`basicAuth`	object or null	ne	null removes the credentials; password '' keeps the stored password (edit only).

Odpovědi

200 OK: application/json AccountWebhook

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Delete an account webhook

DELETE /api/v1/tenants/{tenant}/account-webhooks/{webhook_id}

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`webhook_id`	path	string	ano	Id of the webhook (string of digits).

Odpovědi

204 No content

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Send a test call of an account webhook now

POST /api/v1/tenants/{tenant}/account-webhooks/{webhook_id}/test

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

Sends one test call now (a fictional contact test@example.com, "test": true, header X-Postarna-Test: 1): {ok, status, ms, error} with error scheme | dns | address | deadline | network | status. Moves nothing.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`webhook_id`	path	string	ano	Id of the webhook (string of digits).

Odpovědi

200 OK: application/json AccountWebhookTest

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Tariff, usage and balance

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

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json BillingOverview

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

What cancelling the tariff would mean

GET /api/v1/tenants/{tenant}/billing/cancel

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json CancelInfo

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

List invoices

GET /api/v1/tenants/{tenant}/billing/invoices

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`from`	query	string	ne	Start of the period (YYYY-MM-DD local day, or ISO time where noted).
`page`	query	integer	ne	Page number, from 1. default `1`, min 1
`pageSize`	query	integer	ne	Items per page, 1 to 100. default `25`, min 1, max 100
`q`	query	string	ne	Search text (case and diacritics insensitive). max 200 chars
`sort`	query	string	ne	Sort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).
`status`	query	string	ne	Status filter.
`to`	query	string	ne	End of the period (YYYY-MM-DD local day, or ISO time where noted).
`type`	query	string	ne

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	currency, q, sort, status, type
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Download an invoice (PDF)

GET /api/v1/tenants/{tenant}/billing/invoices/{invoice_id}/pdf

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`invoice_id`	path	string	ano	Id of the invoice (string of digits).

Odpovědi

200 OK: application/pdf string (binary)

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

QR payment code of an invoice (SVG)

GET /api/v1/tenants/{tenant}/billing/invoices/{invoice_id}/qr.svg

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`invoice_id`	path	string	ano	Id of the invoice (string of digits).

Odpovědi

200 OK: image/svg+xml string

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

List payments

GET /api/v1/tenants/{tenant}/billing/payments

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`page`	query	integer	ne	Page number, from 1. default `1`, min 1
`pageSize`	query	integer	ne	Items per page, 1 to 100. default `25`, min 1, max 100

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Get the billing profile

GET /api/v1/tenants/{tenant}/billing/profile

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json BillingProfile

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Price of a tariff

GET /api/v1/tenants/{tenant}/billing/quote

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`currency`	query	string	ne
`period`	query	string	ne
`tierId`	query	string	ne

Odpovědi

200 OK: application/json BillingQuote

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Get the company data

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

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

The company holding the account: legal name, IČO, DIČ / IČ DPH (settings Firma).

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json AccountCompany

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Update the company data

PATCH /api/v1/tenants/{tenant}/company

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

Pole	Typ	Povinné
`name`	string	ne
`companyId`	string	ne
`vatId`	string	ne

Odpovědi

200 OK: application/json AccountCompany

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

GET /api/v1/tenants/{tenant}/consent-settings

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

Customer exception (soft opt-in) months per shop.

The customer exception (soft opt-in) of every e-shop: a Slovak shop follows the law's own 12 months unless the tenant sets its own number for it (months); any other shop is off unless the tenant turns it on.

Poznámky kontraktu: Zákaznická výjimka (soft opt-in) každého e-shopu: kolik měsíců po poslední dokončené objednávce kontaktu může e-shop ještě posílat obchodní sdělení bez jiného právního důvodu (modul settings: čtení GET, plný přístup PATCH). { "items": [ { "shopId": "12", "code": "sk", "language": "sk", "months": 12, "isDefault": true } ] }. months je účinná hodnota (null = vypnuto); isDefault true = platí zákonná výchozí hodnota e-shopu (slovenský e-shop 12 měsíců podle zákona č. 452/2021 Z. z. § 116 odst. 16, jiný e-shop vypnuto), false = tenant si nastavil vlastní počet (i výslovnou nulu). PATCH tělo { "months": 6 } (celé číslo 0 až 120, 0 = výslovně vypnuto) nebo { "months": null } (vrátí e-shopu jeho zákonnou výchozí hodnotu); jiná hodnota nebo neznámý e-shop = 400 validation s months, e-shop jiného tenanta 404.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

PATCH /api/v1/tenants/{tenant}/consent-settings/{shop_id}

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

Sets the customer exception months of a shop (0 to 120, 0 = off, null = legal default).

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

Tělo požadavku (application/json)

Pole	Typ	Povinné	Popis
`months`	number or null	ano

Odpovědi

200 OK: application/json ConsentSettings

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	months
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Labels used in a grid

GET /api/v1/tenants/{tenant}/grid-tags

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

Labels used in one grid (?grid=lists|segments|campaigns|automations), for the Štítky filter.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`grid`	query	string	ne

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	grid
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

List labels

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

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Create a label

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

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

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

Pole	Typ	Povinné	Popis
`name`	string	ano
`color`	string	ano

Odpovědi

201 Created: application/json Label

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Update a label

PATCH /api/v1/tenants/{tenant}/labels/{label_id}

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`label_id`	path	string	ano	Id of the label (string of digits).

Tělo požadavku (application/json)

Pole	Typ	Povinné	Popis
`name`	string	ne
`color`	string	ne

Odpovědi

200 OK: application/json Label

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Delete a label

DELETE /api/v1/tenants/{tenant}/labels/{label_id}

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`label_id`	path	string	ano	Id of the label (string of digits).

Odpovědi

204 No content

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Assign a label to objects

POST /api/v1/tenants/{tenant}/labels/{label_id}/assign

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

{lists?, segments?, campaigns?, automations?: [ids]} get the label (each kind needs full rights in its module).

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`label_id`	path	string	ano	Id of the label (string of digits).

Tělo požadavku (application/json)

Pole	Typ	Povinné
`lists`	array of string	ne
`segments`	array of string	ne
`campaigns`	array of string	ne
`automations`	array of string	ne

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Maintenance: move landline-stored mobile numbers to mobile (dry run unless apply)

POST /api/v1/tenants/{tenant}/maintenance/phone-landline-mobile

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

Owner, 13. 10. 2026: contacts whose phone (landline, "Pevná linka") in fact holds a mobile number (core/ phone.py classify_contact_field, from before that module existed) move it into mobile, only while mobile is still empty and nobody edited phone or mobile by hand; a true landline stays. Body {apply}, a dry run by default. 200 {checked, moved, keptLandline, keptEdited, applied}.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

Pole	Typ	Povinné	Popis
`apply`	any	ne

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	apply
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Maintenance: fill empty contact fields from a SmartEmailing backup (dry run unless apply)

POST /api/v1/tenants/{tenant}/maintenance/se-backfill-contacts

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

MG-01, AN-01 (core/se_backfill.run_records): body {contacts: [{email, column: value}] (records_to_json, a part of the export is fine), audienceFields: false, shopCustomers: false, apply}. Fills only empty fields; apply also recomputes the engagement grades. A large backfill goes in parts with reach: false and recompute: false (both default true) on all but the last part, so each call stays far under the 60 s request limit. 200 {counts per field ..., automations, applied}.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

Pole	Typ	Povinné	Popis
`apply`	any	ne
`contacts`	any	ano

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	apply, contacts
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Maintenance: fill empty contact fields from the e-shop feeds (dry run unless apply)

POST /api/v1/tenants/{tenant}/maintenance/shop-enrich

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

Contact data from the e-shop feeds (core/shop_enrich.run): body {apply}. Fills only empty fields from the customer accounts, the delivery data and the shop's language, derives gender, name day and salutations; apply also turns on the ongoing enrichment of the feed imports (phones and billing addresses come with the next whole order export). 200 {contacts, matched, contactsChanged, fill, language, derived, keptEdited, automationReach: [{id, name, nameDay, before, after, new, newPerMonth, newNext30Days}] (mailable contacts that may enter each active repeat automation before and after), ongoingBefore, ongoing, applied}.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

Pole	Typ	Povinné	Popis
`apply`	boolean	ano

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	apply, reach
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Maintenance: rebuild the e-shop lists (dry run unless apply)

POST /api/v1/tenants/{tenant}/maintenance/shop-lists

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

SZ-09, KK-09 (core/shop_lists.sync): body {seBackup: {lists: {se id: name}, members: {se id: [[address, state]]}} (optional), apply}. 200 {counts, lists: [{name, kind, action, members}], automations: active scenarios reading what changes, applied}.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

Pole	Typ	Povinné	Popis
`apply`	any	ne
`seBackup`	any	ne

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	apply
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

List notifications

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

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

Notifications of the account (import finished, campaign sent or paused, automation paused...), newest first, with the unread count.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json NotificationList

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Delete notifications

POST /api/v1/tenants/{tenant}/notifications/delete

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

{ids: [...]} removes those notifications, {all: true} every notification of the tenant (SE "Smazat vše").

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

object

Odpovědi

204 No content

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	ids
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Mark notifications as read

POST /api/v1/tenants/{tenant}/notifications/read

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

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

Pole	Typ	Povinné	Popis
`ids`	array of string	ano

Odpovědi

204 No content

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	ids
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Mark notifications as unread

POST /api/v1/tenants/{tenant}/notifications/unread

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

SE "Označit jako nepřečtené": {ids: [...]}.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

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

Pole	Typ	Povinné	Popis
`ids`	array of string	ano

Odpovědi

204 No content

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	ids
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

State of the onboarding wizard

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

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

The onboarding wizard's state (core/onboarding.py).

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json OnboardingState

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Save the onboarding wizard

PATCH /api/v1/tenants/{tenant}/onboarding

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

Pole	Typ	Povinné
`step`	one of: `domain`, `shop`, `script`, `feeds`, `contacts`, `done`	ne
`shopId`	string	ne
`skip`	one of: `domain`, `shop`, `script`, `feeds`, `contacts`, `done`	ne
`unskip`	one of: `domain`, `shop`, `script`, `feeds`, `contacts`, `done`	ne
`complete`	boolean	ne
`dismiss`	boolean	ne

Odpovědi

200 OK: application/json OnboardingState

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

State of the RFM analysis

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

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

SE GET rfm-analysis/model: Poštárna has no RFM model yet; whether the tenant asked for it.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json RfmState

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Ask to enable the RFM analysis

POST /api/v1/tenants/{tenant}/rfm/enable-request

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

SE "Zapnout RFM analýzu": records the request (once), switches nothing on.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

object

Odpovědi

200 OK: application/json RfmState

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Running background actions (imports, exports ...)

GET /api/v1/tenants/{tenant}/running-actions

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

SE "Probíhající akce": background work of the tenant that runs or waits to run (core/jobs.running_actions).

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Whether order feed imports fill empty contact fields

GET /api/v1/tenants/{tenant}/shop-enrich

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

{ongoing}: whether the order feed imports fill empty contact fields as they come (core/shop_enrich.SETTING; off until a member runs the enrichment or turns it on). Nastavení › E-shopy, Údaje kontaktů z e-shopu.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Turn the ongoing contact data enrichment on or off

PUT /api/v1/tenants/{tenant}/shop-enrich

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

Body {ongoing: bool}: turns the ongoing enrichment of the order feed imports on or off (audited). Nothing is filled now; the one-time fill is POST /maintenance/shop-enrich. 200 {ongoing}.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

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

Pole	Typ	Povinné	Popis
`ongoing`	boolean	ano

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	ongoing
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Sending company data of every shop

GET /api/v1/tenants/{tenant}/shop-settings

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

Sending company of each shop (name, address, IČO).

The sender company of every e-shop: name, IČO and registered office (footers of e-mails, pages and forms).

Poznámky kontraktu: Odesílající firma každého e-shopu (Nastavení › Firma, modul settings: čtení GET, plný přístup PATCH). { "items": [ { "shopId": "11", "code": "cz", "displayName": "Example CZ", "language": "cs", "companyName": "Example s.r.o.", "companyId": "12345678", "companyAddress": "Ukázková 1, 110 00 Praha 1" } ] }. Patička každé kampaně a automatizace e-mail označí jako obchodní sdělení firmy a jejího webu a na druhém řádku uvede firmu se sídlem (companyAddress) a IČO (companyId), jen když jsou vyplněné (občanský zákoník § 435); stejné údaje mají patičky veřejných stránek a formulářů. PATCH přijme kterákoli z polí companyName (povinný, nejvýš 200 znaků), companyId (písmena a číslice, nejvýš 20, mezery se vynechají), companyAddress (nejvýš 300 znaků); mezery se sloučí, znaky { } < > a konce řádků = 400 validation s názvem pole, neznámé pole taky. Vrací změněnou položku; e-shop jiného tenanta 404.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Update the sending company data of a shop

PATCH /api/v1/tenants/{tenant}/shop-settings/{shop_id}

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

Changes the sending company of a shop.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

Tělo požadavku (application/json)

Pole	Typ	Povinné
`companyId`	string	ne
`companyName`	string	ne
`companyAddress`	string	ne

Odpovědi

200 OK: application/json ShopSettings

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

List shops (e-shops) of the company

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

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

Shops (e-shops) of the account with id, code, domain, currency, language.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Create a shop

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

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

Pole	Typ	Povinné
`code`	string	ano
`displayName`	string	ano
`domain`	string	ano
`webDisplay`	string	ne
`language`	Lang	ano
`currency`	Currency	ano
`platform`	one of: `shoptet`, `woocommerce`, `prestashop`, `upgates`, `custom`	ne
`senderName`	string	ne
`senderEmail`	string	ne
`linkDomain`	string	ne
`companyName`	string	ano
`companyId`	string	ne
`companyAddress`	string	ne

Odpovědi

201 Created: application/json ShopDetail

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Get a shop

GET /api/v1/tenants/{tenant}/shops/{shop_id}

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

Odpovědi

200 OK: application/json ShopDetail

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Update a shop

PATCH /api/v1/tenants/{tenant}/shops/{shop_id}

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

Tělo požadavku (application/json)

Pole	Typ	Povinné
`companyId`	string	ne
`companyName`	string	ne
`currency`	one of: `CZK`, `EUR`	ne
`companyAddress`	string	ne
`displayName`	string	ne
`domain`	string	ne
`webDisplay`	string	ne
`language`	one of: `cs`, `sk`	ne
`platform`	one of: `shoptet`, `woocommerce`, `prestashop`, `upgates`, `custom`	ne
`senderName`	string	ne
`senderEmail`	string	ne
`linkDomain`	string	ne

Odpovědi

200 OK: application/json ShopDetail

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Get the brand settings of a shop

GET /api/v1/tenants/{tenant}/shops/{shop_id}/brand

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

{logoUrl, logoLink, logoWidth, primaryColor, secondaryColor, textColor, backgroundColor, fontFamily, headingFontFamily}: '' (logoWidth null) when unset; logoLink defaults to https:// and the shop's web address (web_display, else its domain) when unset.

Poznámky kontraktu: Grafická identita e-shopu (SE „Grafická identita“); blok Logo v Magic editoru se z ní předvyplní. GET (modul content, čtení) → { "logoUrl", "logoLink", "logoWidth", "primaryColor", "secondaryColor", "textColor", "backgroundColor", "fontFamily", "headingFontFamily" }, nenastavené = '' (logoWidth null); logoLink bez hodnoty = https:// a webová adresa e-shopu (webDisplay, jinak doména). PUT (modul settings, plný přístup) s libovolnou částí polí: chybějící pole zůstane, '' (u logoWidth null) ho smaže. logoUrl, logoLink = '' nebo adresa https; barvy '' nebo #rrggbb (ukládají se malými písmeny); logoWidth null nebo celé číslo 20 až 800; písma '' nebo text do 100 znaků bez < > { } ; ". Neznámé pole nebo špatná hodnota 400 validation s názvem pole, neznámý e-shop 404. Odpověď jako GET. Ukládá se do shops.settings.brand; vzhled veřejných stránek (logo stránek) se nemění. Audit shop_brand_changed jen s názvy polí.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

Odpovědi

200 OK: application/json ShopBrand

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Replace the brand settings of a shop

PUT /api/v1/tenants/{tenant}/shops/{shop_id}/brand

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

Body with any of the brand fields: a missing field is kept, '' (logoWidth null) clears it. logoUrl and logoLink '' or https, colours '' or #rrggbb (stored in lower case), logoWidth null or 20 to 800, fonts at most 100 characters without < > { } ; ". 400 validation <field>. Answers the brand like GET.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

Tělo požadavku (application/json)

Pole	Typ	Povinné	Popis
`logoUrl`	string	ne
`logoLink`	string	ne	Where the logo leads; defaults to the shop's web.
`logoWidth`	number or null	ne
`primaryColor`	string	ne
`secondaryColor`	string	ne
`textColor`	string	ne
`backgroundColor`	string	ne
`fontFamily`	string	ne
`headingFontFamily`	string	ne

Odpovědi

200 OK: application/json ShopBrand

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Set the default language of new contacts of a shop

PUT /api/v1/tenants/{tenant}/shops/{shop_id}/contact-language

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

SE's Nastavení aplikace › Výchozí jazyk kontaktu (UZ-02) of one shop: {language: cs | sk}; it applies to contacts added from now on by hand, over the API or by a sign-up (migration 0392). 400 validation language, 404 for another shop.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

Tělo požadavku (application/json)

Pole	Typ	Povinné	Popis
`language`	Lang	ano

Odpovědi

200 OK: application/json Shop

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	language
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Switch a shop off

POST /api/v1/tenants/{tenant}/shops/{shop_id}/disable

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

Odpovědi

200 OK: application/json ShopDetail

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Switch a shop on

POST /api/v1/tenants/{tenant}/shops/{shop_id}/enable

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

Odpovědi

200 OK: application/json ShopDetail

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Every shop's one script line and connection state

GET /api/v1/tenants/{tenant}/site-script

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

The shops with their one line and connection state (module notes).

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Switch the checkout newsletter box of a shop

PATCH /api/v1/tenants/{tenant}/site-script/{shop_id}

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

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

Pole	Typ	Povinné	Popis
`checkoutConsent`	boolean	ano

Odpovědi

200 OK: application/json SiteScriptShop

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	checkoutConsent
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Test whether the script is on the shop's homepage

POST /api/v1/tenants/{tenant}/site-script/{shop_id}/check

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

The Test button (module notes): {result, url, state, seenAt}.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

Odpovědi

200 OK: application/json SiteScriptCheck

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

State of the SmartEmailing migration

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

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

{connection (null before the first connect), migration (the latest run or null)}.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json SeState

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Get one SmartEmailing migration run

GET /api/v1/tenants/{tenant}/smartemailing/migrations/{migration_id}

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

Poznámky kontraktu: SeMigration = { id, status (queued, running, finished, failed), phase ('', fields, contacts, suppressions, apply, purposes, templates, automations, report), progress { read, planned, applied, done }, plan, counts, report, failed, stopped, failure, createdAt, startedAt, finishedAt }. UI se ptá každé 2 s, dokud běh nedoběhne. failure = druh chyby neúspěšného běhu (stopped, credentials, unavailable, answer, dataKey, connection, error; jinak prázdné), nikdy technický text; ten zůstává v databázi a v logu workeru (bez adres a klíčů). stopped = běh se přerušil, protože se zastavil worker (jeho úloha už neběží); POST /migrations se stejným plánem ho obnoví (stejné id, hotové fáze se přeskočí, kontakty pokračují za poslední uloženou dávkou), jiný plán založí nový běh.

report (SeReport, jen počty, nikdy adresa): rows (contacts, blacklisted, hardbounced, unsubscribed (odhlášení ze seznamů), listUnsubscribes (odhlášení ze seznamů, které se nepřenášejí, u kontaktů v Poštárně), customFields, purposes, consents, templates, automations: { key, se, postarna, created?, skipped?, archived?, imagesFailed?, failed? }), lists ({ id, name, role, seConfirmed, seUnsubscribed, postarnaConfirmed, postarnaUnsubscribed }; u role skip je postarnaUnsubscribed počet kontaktů, u kterých si Poštárna odhlášení z toho seznamu pamatuje), skipped (not_in_mapped_lists, invalid_address), merged { duplicate_address } (záznamy SE se stejnou adresou sloučené do jednoho kontaktu), problems ([{ code, count, blocking }], kódy blacklistMissing, hardbounceMissing, unsubscribeMissing, listUnsubscribeMissing, suppressionMissing blokují; duplicatesMerged, invalidWithOptOut, listUnsubscribeNotInPostarna, erased jen informují), suppressionDiff { seOnly, postarnaOnly } a readyToSend (blacklist, tvrdé bounce i odhlášení SE jsou všechny v Poštárně, osoba vymazaná na žádost se počítá jako zablokovaná, žádný blokující problém).

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`migration_id`	path	string	ano	Id of the migration (string of digits).

Odpovědi

200 OK: application/json SeMigration

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Web tracking state of every shop

GET /api/v1/tenants/{tenant}/web-tracking

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

Shops with the Používat switch, whether a scenario listens to their carts, and the script address.

Poznámky kontraktu: SE Datové zdroje › Webtracking (migrace 0151). GET (modul settings) { "items": [ { "shopId", "code", "name", "domain", "enabled", "listening", "scriptUrl" } ] }: enabled = přepínač Používat (výchozí zapnuto), listening = v e-shopu běží scénář se spouštěčem Změna v košíku, scriptUrl = adresa cart.js pro řádek do patičky. PATCH (plný přístup settings) {enabled: bool} → 204; vypnutý e-shop košíky z webu neukládá (web_tracking.record_cart → off). events (modul contacts, jen čtení): události cart, visit, custom kontaktů tenanta od nejnovější (filtr type přijímá i identification, typ SE Identifikace; Poštárna ho zatím nezapisuje), type, q (e-mail), shopId, stránkování (max 100); položka { "id", "type", "data", "at", "shopId", "source", "contactId", "email" }.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

List web tracking events

GET /api/v1/tenants/{tenant}/web-tracking/events

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

SE grid Identifikováni: ?type=visit|identification|cart|custom, ?q= (e-mail), ?shopId=, paging.

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`page`	query	integer	ne	Page number, from 1. default `1`, min 1
`pageSize`	query	integer	ne	Items per page, 1 to 100. default `25`, min 1, max 100
`q`	query	string	ne	Search text (case and diacritics insensitive). max 200 chars
`shopId`	query	string	ne
`type`	query	string	ne

Odpovědi

200 OK: application/json object

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	q, type
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429		429 rate_limited: wait Retry-After seconds.

Switch web tracking of a shop

PATCH /api/v1/tenants/{tenant}/web-tracking/{shop_id}

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

Parametry

Název	Kde	Typ	Povinné	Popis
`tenant`	path	string (uuid)	ano	Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
`shop_id`	path	string	ano	Id of the shop (string of digits).

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

Pole	Typ	Povinné	Popis
`enabled`	boolean	ano

Odpovědi

204 No content

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	enabled
401		401 unauthorized: missing, unknown, revoked, expired or idle API key.
403		403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404	`not_found`
429		429 rate_limited: wait Retry-After seconds.

Schémata

AccountCompany

The company holding the account (GET /tenants/{t}/company).

Pole	Typ	Povinné
`name`	string	ano
`companyId`	string	ano
`vatId`	string	ano

AccountWebhook

An account webhook (Nastavení › Datové zdroje › Webhooky; the same rows as API v3 /web-hooks).

Pole	Typ	Povinné	Popis
`id`	string	ano
`url`	string	ano
`event`	one of: `new_contact`, `updated_contact`, `unsubscribed_contact`, `email_delivery_started`, `delivery_status`, `sent_email`, `email_open`, `email_click`, `scoring_result_changed`, `engagement_level_changed`, `sms_delivery_status`	ano
`active`	boolean	ano	false = switched off (by hand, or by itself after errorsLimit errors in a row).
`silent`	boolean	ano	Accepted for compatibility, never fires yet.
`timeoutS`	number	ano
`basicLogin`	string or null	ano	HTTP Basic user name; the password is never answered.
`lastResponseCode`	number or null	ano
`lastCallAt`	string or null	ano
`errorsInRow`	number	ano
`errorsLimit`	number	ano
`viaApi`	boolean	ano	Registered with an API key (API v3).
`createdAt`	string	ano

AccountWebhookInput

Pole	Typ	Povinné	Popis
`url`	string	ne
`event`	one of: `new_contact`, `updated_contact`, `unsubscribed_contact`, `email_delivery_started`, `delivery_status`, `sent_email`, `email_open`, `email_click`, `scoring_result_changed`, `engagement_level_changed`, `sms_delivery_status`	ne
`active`	boolean	ne
`basicAuth`	object or null	ne	null removes the credentials; password '' keeps the stored password (edit only).

AccountWebhookTest

Pole	Typ	Povinné
`ok`	boolean	ano
`status`	number or null	ano
`ms`	number or null	ano
`error`	string	ano

AccountWebhooks

Pole	Typ	Povinné
`items`	array of AccountWebhook	ano
`events`	array of one of: `new_contact`, `updated_contact`, `unsubscribed_contact`, `email_delivery_started`, `delivery_status`, `sent_email`, `email_open`, `email_click`, `scoring_result_changed`, `engagement_level_changed`, `sms_delivery_status`	ano
`silentEvents`	array of one of: `new_contact`, `updated_contact`, `unsubscribed_contact`, `email_delivery_started`, `delivery_status`, `sent_email`, `email_open`, `email_click`, `scoring_result_changed`, `engagement_level_changed`, `sms_delivery_status`	ano
`limit`	number	ano

AppNotification

Pole	Typ	Povinné	Popis
`id`	string	ano
`type`	NotificationType	ano
`params`	map of string or number	ano	Values for the placeholders of notifications.type.<type>; numbers are formatted by the UI.
`important`	boolean	ano
`read`	boolean	ano
`createdAt`	string	ano

BankDetails

Pole	Typ	Povinné	Popis
`account`	string	ano
`iban`	string	ano

BillingBlock

one of: `, free_limit, unpaid`

BillingCurrency

one of: CZK, EUR

BillingOverview

Pole	Typ	Povinné	Popis
`subscription`	Subscription	ano
`priceList`	PriceList	ano
`profile`	BillingProfile	ano
`bank`	object	ano	null = the platform has not set that account yet ("nenastaveno").
`cardPayment`	`soon`	ano
`support`	object	ano

BillingPeriod

one of: monthly, annual

BillingProfile

Pole	Typ	Povinné	Popis
`firstName`	string	ano
`lastName`	string	ano
`billingEmail`	string	ano
`phone`	string	ano
`isCompany`	boolean	ano
`country`	string	ano
`companyName`	string	ano
`companyId`	string	ano
`vatId`	string	ano
`vatPayer`	boolean	ano
`street`	string	ano
`city`	string	ano
`zip`	string	ano
`currency`	BillingCurrency	ano
`saved`	boolean	ne
`complete`	boolean	ne
`vatCheck`	VatCheck	ne	The VIES check of the VAT ID (server only; never sent back on save).

BillingQuote

Pole	Typ	Povinné	Popis
`tier`	PriceTier	ano
`currency`	BillingCurrency	ano
`period`	BillingPeriod	ano
`monthly`	string	ano
`net`	string	ano
`vatRate`	string	ano
`vat`	string	ano
`total`	string	ano
`reverseCharge`	boolean	ano
`annualSaving`	string	ano
`beforeDiscount`	string or null	ano
`upgradeNet`	string or null	ano
`change`	one of: `new`, `upgrade`, `downgrade`, `same`	ano	new = a new subscription (first invoice below), upgrade now, downgrade from the next period, same tier.
`contacts`	number	ano
`fits`	boolean	ano	The contacts fit the tier now (a downgrade is refused otherwise).
`firstStart`	string or null	ano
`firstEnd`	string or null	ano
`firstNet`	string or null	ano
`firstVat`	string or null	ano
`firstTotal`	string or null	ano

BillingSlice

A period and its net price.

Pole	Typ	Povinné
`on`	string	ano
`start`	string	ano
`end`	string	ano
`net`	string	ano

CancelInfo

Pole	Typ	Povinné	Popis
`blockers`	array of one of: `trial`, `unpaid`, `profile`, `not_active`, `already`	ano
`reasons`	array of CancelReason	ano

CancelReason

one of: not_needed, complex, missing_features, bugs, price, communication, other_tool, other

ConsentSettings

The customer exception (soft opt-in) of one e-shop (GET /tenants/{t}/consent-settings): how many months after a contact's last completed order the shop may still mail it without another consent basis. months null = off. isDefault true = the shop's own law default (12 months for a Slovak shop, off otherwise, SK zákon č. 452/2021 Z. z. § 116 odst. 16), not a choice the tenant made; false = the tenant's own number (including an explicit 0).

Pole	Typ	Povinné
`shopId`	string	ano
`code`	string	ano
`language`	Lang	ano
`months`	number or null	ano
`isDefault`	boolean	ano

Currency

one of: CZK, EUR

Error

Pole	Typ	Povinné	Popis
`error`	object	ano

json

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

Invoice

Pole	Typ	Povinné	Popis
`id`	string	ano
`number`	string	ano
`kind`	one of: `invoice`, `credit_note`	ano
`purpose`	one of: `upgrade`, `subscription`, `overage`, `manual`, `credit`	ano
`currency`	BillingCurrency	ano
`net`	string	ano
`vat`	string	ano
`total`	string	ano
`vatRate`	string	ano
`reverseCharge`	boolean	ano
`paidAmount`	string	ano
`state`	one of: `cancelled`, `issued`, `paid`	ano
`status`	InvoiceStatus	ano
`issueDate`	string	ano
`dueDate`	string	ano
`paidAt`	string or null	ano
`sentAt`	string or null	ano
`periodStart`	string	ano
`periodEnd`	string	ano
`days`	number	ano	Days after the due date (overdue) or until it (unpaid).
`creditFor`	string or null	ano
`reminders`	number	ano
`hasQr`	boolean	ano
`buyerName`	string	ano
`tenant`	object	ne

InvoiceStatus

one of: cancelled, unpaid, credit, paid, partial, overdue, due_today

Label

SE Štítky: a label with its RGBA colour (#rrggbbaa) and how many records carry it.

Pole	Typ	Povinné
`id`	string	ano
`name`	string	ano
`color`	string	ano
`used`	number	ano
`createdAt`	string	ano

LabelTargets

Pole	Typ	Povinné
`lists`	array of string	ne
`segments`	array of string	ne
`campaigns`	array of string	ne
`automations`	array of string	ne

Lang

one of: cs, sk

NotificationList

Pole	Typ	Povinné	Popis
`items`	array of AppNotification	ano
`unread`	number	ano

NotificationType

one of: import_finished, campaign_sent, domain_verified, bounce_warning, export_ready, automation_paused, list_contacts_added, list_unsubscribed, campaign_paused, automation_notice, se_sync_problem, import_waiting, purpose_assigned_list, engagement_computed, contacts_bulk_done, list_merged, list_deleted

OnboardingPatch

Pole	Typ	Povinné
`step`	one of: `domain`, `shop`, `script`, `feeds`, `contacts`, `done`	ne
`shopId`	string	ne
`skip`	one of: `domain`, `shop`, `script`, `feeds`, `contacts`, `done`	ne
`unskip`	one of: `domain`, `shop`, `script`, `feeds`, `contacts`, `done`	ne
`complete`	boolean	ne
`dismiss`	boolean	ne

OnboardingState

Pole	Typ	Povinné	Popis
`visible`	boolean	ano	Shown on the dashboard (not finished, not closed; a company without a row only while it has no contact).
`step`	one of: `domain`, `shop`, `script`, `feeds`, `contacts`, `done`	ano
`skipped`	array of one of: `domain`, `shop`, `script`, `feeds`, `contacts`, `done`	ano
`completedAt`	string or null	ano
`dismissedAt`	string or null	ano
`shop`	object or null	ano
`steps`	object	ano	Done from the data itself.
`feeds`	object	ano
`contacts`	number	ano
`progress`	number	ano	Steps of the first five that are done or skipped.
`total`	number	ano

OverageDay

One day over the tier: (price of the tier that fits - price of the tier) / days of the month.

Pole	Typ	Povinné
`day`	string	ano
`contacts`	number	ano
`over`	number	ano
`fromMax`	number	ano
`toMax`	number	ano
`amount`	string	ano

Payment

Pole	Typ	Povinné
`id`	string	ano
`invoiceId`	string	ano
`invoiceNumber`	string	ano
`amount`	string	ano
`currency`	BillingCurrency	ano
`paidOn`	string	ano
`method`	one of: `bank`, `card`, `credit_note`, `manual`	ano

PriceList

Pole	Typ	Povinné
`tiers`	array of PriceTier	ano
`annualDiscountPct`	string	ano
`vatRate`	string	ano
`trialDays`	number	ano
`freeContacts`	number	ano
`freeEmailsMonth`	number	ano
`fairUseSends`	number	ano
`currencies`	array of BillingCurrency	ano

PriceTier

Pole	Typ	Povinné	Popis
`id`	string	ano
`maxContacts`	number	ano
`monthly`	string or null	ano	Net a month in the subscription's currency; null = individual price.
`monthlyCzk`	string or null	ano
`monthlyEur`	string or null	ne
`free`	boolean	ano
`active`	boolean	ano

RfmState

RFM analysis (SE GET rfm-analysis/model): no model in Poštárna yet; whether the company asked for it.

Pole	Typ	Povinné
`enabled`	boolean	ano
`requested`	boolean	ano
`requestedAt`	string or null	ano

RunningAction

Pole	Typ	Povinné
`id`	string	ano
`kind`	one of: `import_run`, `import_doi`, `export_run`, `feed_refresh`, `order_feed_refresh`, `se_discover`, `se_sync_suppressions`, `engagement_recompute`, `contacts_bulk`, `list_merge`, `list_delete`	ano
`status`	one of: `queued`, `running`	ano
`since`	string	ano

SeConnection

Pole	Typ	Povinné	Popis
`login`	string	ano
`keyHint`	string	ano	First three characters of the key (the key itself is never returned).
`accountId`	string or null	ano
`verifiedAt`	string	ano
`lists`	map of SeListChoice	ano
`options`	object	ano
`syncEnabled`	boolean	ano	Hourly sync of the parallel run.
`syncChangedAt`	string or null	ano
`lastSyncAt`	string or null	ano
`lastSync`	map of string or number	ano
`syncStatus`	one of: `ok`, `failed`, `skipped`, `late`	ne	ok, skipped (a switch run was queued or running), failed (syncProblem says why) or late (no sync for 3 hours).
`syncProblem`	string	ne	credentials, unavailable, dataKey, error, migration_running or no_sync.
`syncProblemAt`	string or null	ne

SeListChoice

Pole	Typ	Povinné	Popis
`role`	one of: `optin`, `member`, `unsub`, `skip`	ano
`shop`	string	ano	Shop code (cz, sk).
`name`	string	ano

SeMigration

Pole	Typ	Povinné	Popis
`id`	string	ano
`status`	one of: `queued`, `running`, `finished`, `failed`	ano
`phase`	one of: `, contacts`,` purposes`,` templates`,` automations`,` fields`,` suppressions`,` apply`,` report`	ano
`progress`	object	ano
`plan`	object	ano
`counts`	map of number	ano
`report`	SeReport or null	ano
`failed`	boolean	ano
`stopped`	boolean	ne	The worker stopped before the run finished; starting it again resumes it.
`failure`	one of: `, unavailable`,` error`,` stopped`,` credentials`,` answer`,` dataKey`,` connection`	ne	The kind of a failed run (SE_RUN_FAILURES), '' otherwise; never the technical text.
`createdAt`	string	ano
`startedAt`	string or null	ano
`finishedAt`	string or null	ano

SeProblem

Pole	Typ	Povinné	Popis
`code`	one of: `blacklistMissing`, `hardbounceMissing`, `unsubscribeMissing`, `listUnsubscribeMissing`, `suppressionMissing`, `duplicatesMerged`, `invalidWithOptOut`, `listUnsubscribeNotInPostarna`, `erased`	ano
`count`	number	ano
`blocking`	boolean	ano	true = Poštárna must not send yet (readyToSend false).

SeReport

Pole	Typ	Povinné	Popis
`rows`	array of SeReportRow	ano
`lists`	array of object	ano
`skipped`	map of number	ano	Contacts not taken over and why (not_in_mapped_lists, invalid_address).
`mapping`	map of number	ano
`merged`	object	ne	SmartEmailing records merged into one contact because their addresses are the same.
`problems`	array of SeProblem	ne
`suppressionDiff`	object	ano
`readyToSend`	boolean	ano	Blacklist, hard bounces and unsubscribes of SmartEmailing are all in Poštárna: Poštárna may send.

SeReportRow

One line of the reconciliation: SmartEmailing against Poštárna (counts only).

Pole	Typ	Povinné
`key`	one of: `unsubscribed`, `blacklisted`, `contacts`, `purposes`, `templates`, `automations`, `hardbounced`, `listUnsubscribes`, `customFields`, `consents`	ano
`se`	number	ano
`postarna`	number	ano
`created`	number	ne
`skipped`	number	ne
`archived`	number	ne
`imagesFailed`	number	ne
`failed`	number	ne

SeState

Pole	Typ	Povinné	Popis
`connection`	SeConnection or null	ano
`migration`	SeMigration or null	ano

Shop

Pole	Typ	Povinné	Popis
`id`	string	ano
`code`	string	ano	cz, sk (ShopSettings.code)
`displayName`	string	ano
`domain`	string	ano
`currency`	Currency	ano
`language`	Lang	ano
`active`	boolean	ne	false = switched off in settings E-shopy (hidden from the switcher and pickers); absent = active.
`contactLanguage`	one of: `cs`, `sk`	ne	SE's Výchozí jazyk kontaktu (UZ-02): the language of the shop's new contacts that come without one; until chosen (contactLanguageSet false) Czech for a .cz and Slovak for a .sk domain.
`contactLanguageSet`	boolean	ne

ShopBrand

Brand identity of an e-shop (SmartEmailing "Grafická identita"): the Logo element and predefined sections use it.

Pole	Typ	Povinné	Popis
`logoUrl`	string	ano
`logoLink`	string	ano	Where the logo leads; defaults to the shop's web.
`logoWidth`	number or null	ano
`primaryColor`	string	ano
`secondaryColor`	string	ano
`textColor`	string	ano
`backgroundColor`	string	ano
`fontFamily`	string	ano
`headingFontFamily`	string	ano

ShopConnector

The connector of orders and customers as the tenant sees it; the platform sets it (its key is the platform's).

Pole	Typ	Povinné	Popis
`host`	string	ano
`intervalS`	number	ano	Seconds between automatic runs; 0 = only by hand.

ShopDetail

Pole	Typ	Povinné	Popis
`webDisplay`	string	ano
`platform`	one of: `shoptet`, `woocommerce`, `prestashop`, `upgates`, `custom`	ano
`senderName`	string	ano
`senderEmail`	string	ano
`linkDomain`	string	ano	Own domain of tracking and unsubscribe links; '' = the platform's.
`companyName`	string	ano
`companyId`	string	ano
`companyAddress`	string	ano
`active`	boolean	ano	false = switched off in settings E-shopy (hidden from the switcher and pickers); absent = active.
`disabledAt`	string or null	ano
`createdAt`	string	ano
`connector`	ShopConnector or null	ano
`usage`	ShopUsage	ano
`locked`	boolean	ano	Language and currency are fixed once the shop has contacts, orders, feeds or a sent campaign.
`id`	string	ano
`code`	string	ano	cz, sk (ShopSettings.code)
`displayName`	string	ano
`domain`	string	ano
`currency`	Currency	ano
`language`	Lang	ano
`contactLanguage`	one of: `cs`, `sk`	ne	SE's Výchozí jazyk kontaktu (UZ-02): the language of the shop's new contacts that come without one; until chosen (contactLanguageSet false) Czech for a .cz and Slovak for a .sk domain.
`contactLanguageSet`	boolean	ne

ShopInput

POST /tenants/{t}/shops (code, displayName, domain, language, currency, companyName required) and PATCH (code fixed).

Pole	Typ	Povinné
`code`	string	ano
`displayName`	string	ano
`domain`	string	ano
`webDisplay`	string	ne
`language`	Lang	ano
`currency`	Currency	ano
`platform`	one of: `shoptet`, `woocommerce`, `prestashop`, `upgates`, `custom`	ne
`senderName`	string	ne
`senderEmail`	string	ne
`linkDomain`	string	ne
`companyName`	string	ano
`companyId`	string	ne
`companyAddress`	string	ne

ShopSettings

The sender company of one e-shop (settings Firma, GET /tenants/{t}/shop-settings): every campaign and automation e-mail names it in the standard footer, the public pages and forms in theirs. companyId (IČO) and companyAddress (registered office) are shown only when filled ('' = not filled).

Pole	Typ	Povinné
`shopId`	string	ano
`code`	string	ano
`displayName`	string	ano
`language`	Lang	ano
`companyName`	string	ano
`companyId`	string	ano
`companyAddress`	string	ano

ShopUsage

What a shop has (GET /tenants/{t}/shops/{id}).

Pole	Typ	Povinné
`contacts`	number	ano
`lists`	number	ano
`segments`	number	ano
`campaigns`	number	ano
`automationsActive`	number	ano
`feeds`	number	ano
`orders`	number	ano

SiteScriptCheck

The Test button (POST /tenants/{t}/site-script/{shop}/check): found = the line is on the homepage.

Pole	Typ	Povinné
`result`	one of: `found`, `not_found`, `unreachable`	ano
`url`	string or null	ano
`state`	one of: `live`, `quiet`, `waiting`	ano
`seenAt`	string or null	ano

SiteScriptShop

Pole	Typ	Povinné	Popis
`shopId`	string	ano
`code`	string	ano
`name`	string	ano
`domain`	string	ano
`webDisplay`	string	ano
`platform`	one of: `shoptet`, `woocommerce`, `prestashop`, `upgates`, `custom`	ano
`scriptUrl`	string	ano	The postarna.js address of the one line.
`snippet`	string	ano	The whole line for the shop's footer.
`state`	one of: `live`, `quiet`, `waiting`	ano	live = the script reported within 3 days, quiet = earlier, waiting = never.
`seenAt`	string or null	ano
`seenHost`	string	ano
`checkoutConsent`	boolean	ano	The script also reads the newsletter box of the checkout and the registration.
`popups`	number	ano	Active pop-up and slide-in forms the script shows; active classic forms it can place.
`embeds`	number	ano
`signups`	object	ano	Checkout newsletter boxes of the last 30 days by state.

Subscription

Pole	Typ	Povinné	Popis
`state`	SubscriptionState	ano
`inTrial`	boolean	ano
`trialEndsAt`	string or null	ano
`trialDaysLeft`	number	ano
`period`	BillingPeriod	ano
`currency`	BillingCurrency	ano
`tier`	PriceTier or null	ano
`manual`	boolean	ano
`customMonthly`	string or null	ano
`monthly`	string or null	ano
`periodNet`	string or null	ano
`annualMonthly`	string or null	ano
`annualSaving`	string or null	ano
`annualDiscountPct`	string	ano
`vatRate`	string	ano
`contacts`	number	ano
`limit`	number or null	ano
`overBy`	number	ano
`contactsChange30d`	number or null	ano
`sentMonth`	number	ano
`free`	boolean	ano
`freeEmailsMonth`	number or null	ano
`fairUseLimit`	number	ano
`fairUseSends`	number	ano
`nextInvoiceOn`	string or null	ano	Day the next invoice is issued: at once for the first one, the 2nd of the month for a renewal.
`nextPeriodOn`	string or null	ano	First day of the next (or the waiting) period: a planned lower tier and the renewal apply from it.
`daysToInvoice`	number or null	ano
`periodStart`	string or null	ano
`periodEnd`	string or null	ano
`cancelAt`	string or null	ano
`billingBlock`	BillingBlock	ano
`billingExempt`	boolean	ano
`sendingState`	string	ano
`paymentMethod`	one of: `bank`, `card`	ano
`overageTotal`	string or null	ano
`overageDays`	number	ano
`currentSpend`	string or null	ano
`unpaidInvoices`	number	ano
`overdueInvoices`	number	ano
`ordered`	boolean	ano	A paid tier is ordered (in the trial: it starts when the trial ends).
`dueDays`	number	ano
`firstInvoice`	BillingSlice or null	ano	A tier ordered in the trial: its first invoice on the day the trial ends, for the rest of that month (pro rata).
`nextTier`	PriceTier or null	ano	Snížit tarif: the lower tier planned from the next period (null = none).
`nextBilling`	object or null	ano	The next invoice of a running subscription: the tier (the planned lower one) and the overage of a monthly one.
`overageFrom`	string or null	ano	First day of the overage not billed yet (null outside a paid period).
`overage`	array of OverageDay	ano	Days over the tier since overageFrom (SE Příloha k faktuře), billed with the next invoice.

SubscriptionState

one of: trial, active, past_due, suspended, cancelled, expired

VatCheck

Pole	Typ	Povinné	Popis
`required`	boolean	ano	An EU company outside CZ that says it is a VAT payer: only then is the VAT ID checked.
`state`	VatCheckState	ano
`vatId`	string	ano
`checkedAt`	string or null	ano
`name`	string	ano	Name and address as VIES returned them; requestIdentifier = the consultation number (evidence).
`address`	string	ano
`requestIdentifier`	string	ano
`error`	string	ano
`lastValidAt`	string or null	ano
`fallbackUntil`	string or null	ano	Until when an unavailable VIES still allows reverse charge (last valid check + 30 days).
`reverseCharge`	boolean	ano

VatCheckState

one of: not_needed, unchecked, valid, invalid, unavailable

WebTrackingEvent

One row of the grid Identifikováni (a tracked event of a contact).

Pole	Typ	Povinné
`id`	string	ano
`type`	one of: `custom`, `visit`, `identification`, `cart`	ano
`data`	map of any	ano
`at`	string	ano
`shopId`	string or null	ano
`source`	string	ano
`contactId`	string	ano
`email`	string	ano

WebTrackingShop

SE Datové zdroje › Webtracking: a shop's Používat switch, whether a scenario listens to its carts, the script.

Pole	Typ	Povinné	Popis
`shopId`	string	ano
`code`	string	ano
`name`	string	ano
`domain`	string	ano
`enabled`	boolean	ano
`listening`	boolean	ano
`scriptUrl`	string	ano	The cart.js address for the one line in the shop's footer.

Account and settings

Operace#

Public price list (no authentication)#

List account webhooks and their events#

Create an account webhook#

Edit, switch off or on an account webhook#

Delete an account webhook#

Send a test call of an account webhook now#

Tariff, usage and balance#

What cancelling the tariff would mean#

List invoices#

Download an invoice (PDF)#

QR payment code of an invoice (SVG)#

List payments#

Get the billing profile#

Price of a tariff#

Get the company data#

Update the company data#

Consent settings of every shop#

Update the customer exception of a shop#

Labels used in a grid#

List labels#

Create a label#

Update a label#

Delete a label#

Assign a label to objects#

Maintenance: move landline-stored mobile numbers to mobile (dry run unless apply)#

Maintenance: fill empty contact fields from a SmartEmailing backup (dry run unless apply)#

Maintenance: fill empty contact fields from the e-shop feeds (dry run unless apply)#

Maintenance: rebuild the e-shop lists (dry run unless apply)#

List notifications#

Delete notifications#

Mark notifications as read#

Mark notifications as unread#

State of the onboarding wizard#

Save the onboarding wizard#

State of the RFM analysis#

Ask to enable the RFM analysis#

Running background actions (imports, exports ...)#

Whether order feed imports fill empty contact fields#

Turn the ongoing contact data enrichment on or off#

Sending company data of every shop#

Update the sending company data of a shop#

List shops (e-shops) of the company#

Create a shop#

Get a shop#

Update a shop#

Get the brand settings of a shop#

Replace the brand settings of a shop#

Set the default language of new contacts of a shop#

Switch a shop off#

Switch a shop on#

Every shop's one script line and connection state#

Switch the checkout newsletter box of a shop#

Test whether the script is on the shop's homepage#

State of the SmartEmailing migration#

Get one SmartEmailing migration run#

Web tracking state of every shop#

List web tracking events#

Switch web tracking of a shop#

Schémata#

AccountCompany#

AccountWebhook#

AccountWebhookInput#

AccountWebhookTest#

AccountWebhooks#

AppNotification#

BankDetails#

BillingBlock#

BillingCurrency#

BillingOverview#

BillingPeriod#

BillingProfile#

BillingQuote#

BillingSlice#

CancelInfo#

CancelReason#

ConsentSettings#

Currency#

Error#

Operace

Public price list (no authentication)

List account webhooks and their events

Create an account webhook

Edit, switch off or on an account webhook

Delete an account webhook

Send a test call of an account webhook now

Tariff, usage and balance

What cancelling the tariff would mean

List invoices

Download an invoice (PDF)

QR payment code of an invoice (SVG)

List payments

Get the billing profile

Price of a tariff

Get the company data

Update the company data

Consent settings of every shop

Update the customer exception of a shop

Labels used in a grid

List labels

Create a label

Update a label

Delete a label

Assign a label to objects

Maintenance: move landline-stored mobile numbers to mobile (dry run unless apply)

Maintenance: fill empty contact fields from a SmartEmailing backup (dry run unless apply)

Maintenance: fill empty contact fields from the e-shop feeds (dry run unless apply)

Maintenance: rebuild the e-shop lists (dry run unless apply)

List notifications

Delete notifications

Mark notifications as read

Mark notifications as unread

State of the onboarding wizard

Save the onboarding wizard

State of the RFM analysis

Ask to enable the RFM analysis

Running background actions (imports, exports ...)

Whether order feed imports fill empty contact fields

Turn the ongoing contact data enrichment on or off

Sending company data of every shop

Update the sending company data of a shop

List shops (e-shops) of the company

Create a shop

Get a shop

Update a shop

Get the brand settings of a shop

Replace the brand settings of a shop

Set the default language of new contacts of a shop

Switch a shop off

Switch a shop on

Every shop's one script line and connection state

Switch the checkout newsletter box of a shop

Test whether the script is on the shop's homepage

State of the SmartEmailing migration

Get one SmartEmailing migration run

Web tracking state of every shop

List web tracking events

Switch web tracking of a shop

Schémata

AccountCompany

AccountWebhook

AccountWebhookInput

AccountWebhookTest

AccountWebhooks

AppNotification

BankDetails

BillingBlock

BillingCurrency

BillingOverview

BillingPeriod

BillingProfile

BillingQuote

BillingSlice

CancelInfo

CancelReason

ConsentSettings

Currency

Error

Invoice