Sending and deliverability

Senders, sending domains (SPF, DKIM, DMARC), DMARC reports, sending mode.

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

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

Operace

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)

DMARC summary

GET /api/v1/tenants/{tenant}/deliverability/dmarc

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.

Odpovědi

200 OK: application/json DmarcSummary

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.

DMARC report detail

GET /api/v1/tenants/{tenant}/deliverability/dmarc/report

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

SE Statistiky › DMARC: ?from=&to= (calendar days of the tenant, both included; none = the whole history), ?domain= (sending domain id), ?reporter= (the provider's org name).

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.
`domain`	query	string	ne
`from`	query	string	ne	Start of the period (YYYY-MM-DD local day, or ISO time where noted).
`reporter`	query	string	ne
`to`	query	string	ne	End of the period (YYYY-MM-DD local day, or ISO time where noted).

Odpovědi

200 OK: application/json DmarcReport

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	to
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 domains with their DNS state

GET /api/v1/tenants/{tenant}/deliverability/domains

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.

Odpovědi

200 OK: application/json SendingDomainList

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.

Add a domain

POST /api/v1/tenants/{tenant}/deliverability/domains

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): Required by the server: domain.

Pole	Typ	Povinné	Popis
`domain`	string	ano
`dkimSelectors`	array of string	ne

Odpovědi

201 Created: application/json SendingDomain

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 domain

PATCH /api/v1/tenants/{tenant}/deliverability/domains/{domain_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.
`domain_id`	path	string	ano	Id of the domain (string of digits).

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

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

Odpovědi

200 OK: application/json SendingDomain

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 domain

DELETE /api/v1/tenants/{tenant}/deliverability/domains/{domain_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.
`domain_id`	path	string	ano	Id of the domain (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.

Check the DNS records of a domain now

POST /api/v1/tenants/{tenant}/deliverability/domains/{domain_id}/check

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.
`domain_id`	path	string	ano	Id of the domain (string of digits).

Odpovědi

200 OK: application/json SendingDomain

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.
503	`unavailable`	dns

Senders with their authentication state

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

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.

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.

Get the default settings of new campaigns (tracking parameters on or off)

GET /api/v1/tenants/{tenant}/sending-defaults

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

SE Nastavení › Rozesílky › Výchozí nastavení beyond what other routes keep (senders, test recipients, the default unsubscribe page): {utmDefaultOn} = new campaign drafts start with the tracking parameters 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.

Odpovědi

200 OK: application/json SendingDefaults

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.

Set whether new campaigns start with tracking parameters

PUT /api/v1/tenants/{tenant}/sending-defaults

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

Body {utmDefaultOn: bool} (SE UTM Parametry Nesledovat / Sledovat). Audited as setting_changed.

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: utmDefaultOn.

Pole	Typ	Povinné	Popis
`utmDefaultOn`	boolean	ano

Odpovědi

200 OK: application/json SendingDefaults

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	utmDefaultOn
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 mode of the company (switch, limits)

GET /api/v1/tenants/{tenant}/sending-mode

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

What leaves Poštárna for this tenant now (core/backends.mode_of): live (everything), test (only test e-mails to the test whitelist, POSTARNA_SES_LIVE=test), folder (development: files, nothing leaves) or off (nothing). testRecipients = how many addresses the test whitelist has. sendingEnabled = the tenant's kill switch (setting sending_enabled, python -m postarna.admin sending-switch): while it is off no sending tick runs, so no campaign goes out and no automation lets anybody in, whatever the mode says (test e-mails still go out). sendingState = the platform's approval of live sending (pending, live, paused, suspended; migration 0170) and sendingHold why a live tenant is held ('', platform, free_limit, unpaid).

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 SendingModeInfo

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.

Add a sending domain

POST /api/v1/tenants/{tenant}/sending/domains

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): Required by the server: domain.

Pole	Typ	Povinné	Popis
`domain`	string	ano

Odpovědi

201 Created: application/json SetupDomain

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.

Delete a sending domain

DELETE /api/v1/tenants/{tenant}/sending/domains/{domain_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.
`domain_id`	path	string	ano	Id of the domain (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.
429		429 rate_limited: wait Retry-After seconds.

Check a sending domain

POST /api/v1/tenants/{tenant}/sending/domains/{domain_id}/check

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.
`domain_id`	path	string	ano	Id of the domain (string of digits).

Odpovědi

200 OK: application/json SetupDomain

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.

Add a sender

POST /api/v1/tenants/{tenant}/sending/senders

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

Poznámky kontraktu: Přidání {shopId, email, name?, replyTo?, isDefault?} jen na ověřené doméně (400 validation / email, reason domain_not_verified nebo freemail; 409 conflict pro stejnou adresu v e-shopu). První adresa e-shopu je výchozí. Adresa, kterou účet dřív odebral, se stejným přidáním vrátí (stejné id, nové jméno a replyTo).

Úprava (PATCH) {name?, replyTo?, isDefault: true?} → SetupSender. name = jméno odesílatele (Od koho), nejvýš 100 znaků bez < > { } " a řádků (400 validation / name). replyTo = adresa pro odpovědi nebo "" (odpovědi pak přijdou na adresu odesílatele); co není adresa, odmítne 400 validation / replyTo (nikdy se tiše nevyprázdní). Samotnou adresu email změnit nejde (patří k ověřené doméně): jiná hodnota než uložená = 400 validation / email s reason read_only.
Odebrání (DELETE) 204. Odmítne 409 conflict / id s reason default (výchozí adresa e-shopu) nebo in_use (adresu používá kampaň ve stavu scheduled, sending nebo paused, nebo krok E-mail automatizace ve stavu active nebo paused). Koncepty a skončené kampaně odebrání nebrání. Řádek zůstává (senders.removed_at, migrace 0096): skončené kampaně a automatizace si odkaz na odesílatele ponechají, ze všech seznamů a výběrů (GET …/sending/setup, GET /tenants/{t}/senders, výběr v kampani a automatizaci, schválení) adresa zmizí; koncept s odebranou adresou schválení odmítne 400 validation / senderId. Další PATCH nebo DELETE odebrané adresy = 404 not_found.
Modul settings full, změny zapisují audit (sender_added, sender_updated s názvy polí, sender_deleted).

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: email, shopId.

Pole	Typ	Povinné
`shopId`	string	ano
`email`	string	ano
`name`	string	ne
`replyTo`	string	ne
`isDefault`	boolean	ne

Odpovědi

201 Created: application/json SetupSender

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 sender

PATCH /api/v1/tenants/{tenant}/sending/senders/{sender_id}

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

Úprava (PATCH) {name?, replyTo?, isDefault: true?} → SetupSender. name = jméno odesílatele (Od koho), nejvýš 100 znaků bez < > { } " a řádků (400 validation / name). replyTo = adresa pro odpovědi nebo "" (odpovědi pak přijdou na adresu odesílatele); co není adresa, odmítne 400 validation / replyTo (nikdy se tiše nevyprázdní). Samotnou adresu email změnit nejde (patří k ověřené doméně): jiná hodnota než uložená = 400 validation / email s reason read_only.
Odebrání (DELETE) 204. Odmítne 409 conflict / id s reason default (výchozí adresa e-shopu) nebo in_use (adresu používá kampaň ve stavu scheduled, sending nebo paused, nebo krok E-mail automatizace ve stavu active nebo paused). Koncepty a skončené kampaně odebrání nebrání. Řádek zůstává (senders.removed_at, migrace 0096): skončené kampaně a automatizace si odkaz na odesílatele ponechají, ze všech seznamů a výběrů (GET …/sending/setup, GET /tenants/{t}/senders, výběr v kampani a automatizaci, schválení) adresa zmizí; koncept s odebranou adresou schválení odmítne 400 validation / senderId. Další PATCH nebo DELETE odebrané adresy = 404 not_found.
Modul settings full, změny zapisují audit (sender_added, sender_updated s názvy polí, sender_deleted).

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.
`sender_id`	path	string	ano	Id of the sender (string of digits).

Tělo požadavku (application/json)

Pole	Typ	Povinné	Popis
`name`	string	ne	From name, at most 100 characters without < > { } " and line breaks.
`replyTo`	string	ne	Address for replies, '' = replies go to the sender address.
`isDefault`	`true`	ne

Odpovědi

200 OK: application/json SetupSender

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.

Delete a sender

DELETE /api/v1/tenants/{tenant}/sending/senders/{sender_id}

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

204; 409 conflict default / in_use; ?replacementId= (SE's Náhradní adresa, DO-03) first moves the shop's default, the unfinished campaigns and the automation e-mail steps to that sender of the same shop.

Úprava (PATCH) {name?, replyTo?, isDefault: true?} → SetupSender. name = jméno odesílatele (Od koho), nejvýš 100 znaků bez < > { } " a řádků (400 validation / name). replyTo = adresa pro odpovědi nebo "" (odpovědi pak přijdou na adresu odesílatele); co není adresa, odmítne 400 validation / replyTo (nikdy se tiše nevyprázdní). Samotnou adresu email změnit nejde (patří k ověřené doméně): jiná hodnota než uložená = 400 validation / email s reason read_only.
Odebrání (DELETE) 204. Odmítne 409 conflict / id s reason default (výchozí adresa e-shopu) nebo in_use (adresu používá kampaň ve stavu scheduled, sending nebo paused, nebo krok E-mail automatizace ve stavu active nebo paused). Koncepty a skončené kampaně odebrání nebrání. Řádek zůstává (senders.removed_at, migrace 0096): skončené kampaně a automatizace si odkaz na odesílatele ponechají, ze všech seznamů a výběrů (GET …/sending/setup, GET /tenants/{t}/senders, výběr v kampani a automatizaci, schválení) adresa zmizí; koncept s odebranou adresou schválení odmítne 400 validation / senderId. Další PATCH nebo DELETE odebrané adresy = 404 not_found.
Modul settings full, změny zapisují audit (sender_added, sender_updated s názvy polí, sender_deleted).

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.
`sender_id`	path	string	ano	Id of the sender (string of digits).
`replacementId`	query	string	ne

Odpovědi

204 No content

Chyby

Stav	Kód	Hodnoty `message`
400	`validation`	replacementId
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.

Check whether a sender address is confirmed

POST /api/v1/tenants/{tenant}/sending/senders/{sender_id}/check

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

Zkontrolovat of an address confirmed through SES (DO-03): reads the state of its identity.

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.
`sender_id`	path	string	ano	Id of the sender (string of digits).

Odpovědi

200 OK: application/json SetupSender

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.

Send the confirmation e-mail of a sender address again

POST /api/v1/tenants/{tenant}/sending/senders/{sender_id}/resend

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

Poslat znovu the confirmation e-mail of an address verified by e-mail (DO-03); 409 when it is verified already, 503 unavailable when no e-mail could go out.

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.
`sender_id`	path	string	ano	Id of the sender (string of digits).

Odpovědi

200 OK: application/json SetupSender

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`
409	`conflict`	verified
429		429 rate_limited: wait Retry-After seconds.
503	`unavailable`	email

Where a sender is used

GET /api/v1/tenants/{tenant}/sending/senders/{sender_id}/usage

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

Where a sender is used (SE "Použití odesílací adresy" before Smazat adresu): {items: [{type, id, name, status}]}, type default (its shop's default sender), campaign or automation.

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.
`sender_id`	path	string	ano	Id of the sender (string of digits).

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.

State of the sending setup (domains and senders)

GET /api/v1/tenants/{tenant}/sending/setup

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.

Odpovědi

200 OK: application/json SendingSetup

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.

Schémata

DmarcReport

Pole	Typ	Povinné
`totals`	object	ano
`domains`	array of object	ano
`days`	array of object	ano
`ips`	array of object	ano
`ipVersions`	object	ano
`reporters`	array of object	ano
`dispositions`	array of object	ano
`cases`	array of object	ano
`reporterChoices`	array of string	ano
`domainChoices`	array of object	ano

DmarcSummary

Pole	Typ	Povinné
`days`	number	ano
`domains`	array of object	ano
`sources`	array of object	ano
`reports`	array of object	ano
`complaints`	object	ano

Error

Pole	Typ	Povinné	Popis
`error`	object	ano

json

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

SenderAuth

Pole	Typ	Povinné
`id`	string	ano
`shopId`	string	ano
`name`	string	ano
`email`	string	ano
`replyTo`	string	ano
`domain`	string	ano
`domainId`	string or null	ano
`verified`	boolean	ano
`isDefault`	boolean	ano
`freemail`	boolean	ano
`spf`	one of: `ok`, `invalid`, `error`, `unknown`, `missing`	ano
`dkim`	one of: `ok`, `invalid`, `error`, `unknown`, `missing`	ano
`dmarc`	one of: `ok`, `invalid`, `error`, `unknown`, `missing`	ano
`usableAsSender`	boolean	ano

SenderUsage

One use of a sender (GET /sending/senders/{id}/usage). type default: the default sender of shop id.

Pole	Typ	Povinné
`type`	one of: `campaign`, `automation`, `default`	ano
`id`	string	ano
`name`	string	ano
`status`	string	ano

SendingDefaults

GET/PUT /tenants/{t}/sending-defaults (SE Výchozí nastavení, DO-07): utmDefaultOn = new drafts start with the tracking parameters utm_source newsletter and utm_medium email.

Pole	Typ	Povinné	Popis
`utmDefaultOn`	boolean	ano

SendingDomain

Pole	Typ	Povinné	Popis
`id`	string	ano
`domain`	string	ano
`dkimSelectors`	array of string	ano
`spf`	object	ano
`dkim`	object	ano
`dmarc`	object	ano
`issues`	array of string	ano	Codes, texts in the catalogs (deliverability.issue.<code>).
`checkedAt`	string or null	ano
`createdAt`	string	ano

SendingDomainInput

Pole	Typ	Povinné	Popis
`domain`	string	ano
`dkimSelectors`	array of string	ne

SendingDomainList

Pole	Typ	Povinné	Popis
`items`	array of SendingDomain	ano
`suggestions`	array of string	ano	Domains of sender addresses without a sending domain yet.

SendingMode

one of: live, test, folder, off

SendingModeInfo

Pole	Typ	Povinné	Popis
`mode`	SendingMode	ano
`testRecipients`	number	ano	How many addresses the tenant's test list has.
`sendingEnabled`	boolean	ne	The tenant's kill switch: off = no campaign goes out and no automation lets anybody in (tests still go out).
`sendingState`	one of: `suspended`, `pending`, `live`, `paused`	ne	The platform's approval (B4): anything but live keeps the tenant to test e-mails.
`sendingHold`	one of: `, free_limit`,` unpaid`,` platform`	ne	Why a live tenant is held: the platform switch or billing (free tier used up, unpaid invoice).

SendingSetup

Pole	Typ	Povinné	Popis
`managed`	boolean	ano	The tenant sends through the platform account (Poštárna creates the identity).
`platformReady`	boolean	ano	false = the platform still has to finish its part (no identity credential).
`domains`	array of SetupDomain	ano
`suggestions`	array of string	ano
`shops`	array of object	ano
`senders`	array of SetupSender	ano
`advanced`	object	ne	Platform admins only.

SetupDnsRecord

Pole	Typ	Povinné	Popis
`kind`	one of: `dkim`, `spf`, `dmarc`	ano
`type`	one of: `CNAME`, `TXT`	ano
`host`	string	ano	Name without the domain (what most DNS hosts ask for); '@' = the domain itself.
`name`	string	ano	Full name.
`value`	string	ano
`required`	boolean	ano
`status`	SetupRecordStatus	ano

SetupDomain

Pole	Typ	Povinné	Popis
`id`	string	ano
`domain`	string	ano
`state`	SetupDomainState	ano
`records`	array of SetupDnsRecord	ano
`checkedAt`	string or null	ano
`createdAt`	string	ano
`advanced`	object	ne	Platform admins only.

SetupDomainState

one of: pending, failed, verified, setup

SetupRecordStatus

one of: ok, unknown, missing

SetupSender

Pole	Typ	Povinné	Popis
`id`	string	ano
`shopId`	string	ano
`name`	string	ano
`email`	string	ano
`replyTo`	string	ano
`isDefault`	boolean	ano
`verified`	boolean	ano
`domainVerified`	boolean	ano
`verifyMethod`	one of: `domain`, `email`	ne	DO-03: domain = verified by the DKIM of its domain, email = confirmed (or waiting for) a confirmation e-mail.
`verificationSentAt`	string or null	ne	When the last confirmation e-mail went out; null = none could be sent.
`freemail`	boolean	ne	An address of a free mailbox service (its provider's DMARC fails for e-mails sent through Poštárna).

SetupSenderInput

Pole	Typ	Povinné
`shopId`	string	ano
`email`	string	ano
`name`	string	ne
`replyTo`	string	ne
`isDefault`	boolean	ne

SetupSenderPatch

Edit of an existing sender. The address itself never changes (it belongs to a verified domain; server 400 validation email, reason read_only).

Pole	Typ	Povinné	Popis
`name`	string	ne	From name, at most 100 characters without < > { } " and line breaks.
`replyTo`	string	ne	Address for replies, '' = replies go to the sender address.
`isDefault`	`true`	ne

Sending and deliverability

Operace#

DMARC summary#

DMARC report detail#

List domains with their DNS state#

Add a domain#

Update a domain#

Delete a domain#

Check the DNS records of a domain now#

Senders with their authentication state#

Get the default settings of new campaigns (tracking parameters on or off)#

Set whether new campaigns start with tracking parameters#

Sending mode of the company (switch, limits)#

Add a sending domain#

Delete a sending domain#

Check a sending domain#

Add a sender#

Update a sender#

Delete a sender#

Check whether a sender address is confirmed#

Send the confirmation e-mail of a sender address again#

Where a sender is used#

State of the sending setup (domains and senders)#

Schémata#

DmarcReport#

DmarcSummary#

Error#

SenderAuth#

SenderUsage#

SendingDefaults#

SendingDomain#

SendingDomainInput#

SendingDomainList#

SendingMode#

SendingModeInfo#

SendingSetup#

SetupDnsRecord#

SetupDomain#

SetupDomainState#

SetupRecordStatus#

SetupSender#

SetupSenderInput#

SetupSenderPatch#

Operace

DMARC summary

DMARC report detail

List domains with their DNS state

Add a domain

Update a domain

Delete a domain

Check the DNS records of a domain now

Senders with their authentication state

Get the default settings of new campaigns (tracking parameters on or off)

Set whether new campaigns start with tracking parameters

Sending mode of the company (switch, limits)

Add a sending domain

Delete a sending domain

Check a sending domain

Add a sender

Update a sender

Delete a sender

Check whether a sender address is confirmed

Send the confirmation e-mail of a sender address again

Where a sender is used

State of the sending setup (domains and senders)

Schémata

DmarcReport

DmarcSummary

Error

SenderAuth

SenderUsage

SendingDefaults

SendingDomain

SendingDomainInput

SendingDomainList

SendingMode

SendingModeInfo

SendingSetup

SetupDnsRecord

SetupDomain

SetupDomainState

SetupRecordStatus

SetupSender

SetupSenderInput

SetupSenderPatch