NG Emailing API dokumentace
API v1 · 0.974.0Stáhnout OpenAPI ↓
PRO VÝVOJÁŘE

Dokumentace API

Kontakty, kampaně a transakční e-maily přímo z vašeho systému. Vše potřebné od prvního požadavku po konkrétní operace.

REST API v1JSONTestovací režim109 operací

Co je nového v API

Verze je verze produktu, ve které změna vyšla; aktuální verzi ukazuje hlavička dokumentace. Adresa API /api/integrations/v1 se nemění. Položky označené Změna kontraktu mohou vyžadovat úpravu integrace.

  1. 0.932.0 19. 11. 2026

    • Integraci jde v aplikaci omezit na povolené IP adresy (API a integrace → integrace → Povolené IP adresy). Požadavek z jiné adresy vrátí 403 ip_not_allowed a neubírá z limitu požadavků. Integrace bez seznamu se nemění.
Starší změny (21 verzí)
  1. 0.890.0 16. 11. 2026

    • Zprávu se seznamem položek jde po přijetí přečíst i odeslat. Dřív GET /transactional/messages/{messageId}, výpis zpráv i detail dávky vracely 503 transactional_detail_unavailable, jakmile integrace měla zprávu se seznamem.
    • Chyby tvaru seznamu (víc než 50 položek, víc než 16 údajů, položka, která není objekt, seznam uvnitř údaje) vracejí 422 transactional_inputs_invalid s jedinou cestou a větou s limitem místo validation_error s obecnou větou.
    • null a prázdný řetězec u nepovinného pole, údaje položky nebo seznamu znamenají nevyplněno, stejně jako vynechaný klíč. Dřív vracely 422. U povinného pole hlásí „chybí“.
    • Deklarace verze má request_fields.lists s hodnotou input_schema.lists. Textová verze zprávy s tabulkou odděluje buňky mezerou.
    • Řešení problémů popisuje krátkou nedostupnost při nasazení: brána může asi minutu vracet 502, 504 i 404 s prostým textem. Zápis zopakujte se stejným Idempotency-Key.
  2. 0.855.0 14. 11. 2026

    • Transakční šablona může mít seznamy položek, například pojištěné osoby na jedné smlouvě. V inputs je hodnotou seznamu pole objektů, u jedné zprávy i u každého příjemce dávky. Deklarace verze a katalog je vracejí v input_schema.lists.
    • Šablona má nejvýše 8 seznamů, seznam nejvýše 50 položek a položka nejvýše 16 údajů bez dalšího vnoření. Chyba v položce vrací cestu k místu, například /inputs/pojistene_osoby/1/karticka_url nebo /recipients/0/inputs/pojistene_osoby/1/karticka_url.
  3. 0.782.0 9. 11. 2026 Změna kontraktu

    • Vlastní HTML (schemaVersion: 3) smí mít zdroj až 200 000 bajtů UTF-8 a kontroluje se pravidly v2: projdou podmíněné komentáře pro Outlook, VML, CSS url(https://…) a značka s náhradní hodnotou {{pole|"text"}}. Pravidla v2 platí od 0.730.0; uložení přes POST /templates a PUT /templates/{templateId} ale před 0.782.0 končilo zhruba u 58 kB.
    • Odmítnutá šablona vrací v fields konkrétní pole a důvod, například /document/html s porušeným pravidlem a číslem řádku, velikostí nebo neznámou značkou, místo obecného /content. Kód campaign_email_template_invalid se nemění. HTML delší než 200 000 znaků vrací 422 validation_error s /document/html místo „Neznámé pole“.
    • Publikace transakční šablony s odkazem na doménu NG e-mailingu vrátí 422 transactional_inputs_invalid s polem /document. Odeslání dřív publikované takové šablony hlásí vadu u /template_id místo /inputs.
  4. 0.751.0 5. 11. 2026 Změna kontraktu

    • Šablony znovu vracejí čísla verzí: katalog current_published_version.version a published_version_numbers, deklarace a konkrétní revize version, výpis a detail šablony publishedVersion (verze k odeslání) a version (aktuální revize, posílá se jako expectedVersion při úpravě a archivaci). Pole přibyla, žádné neubylo; template_version při odeslání zůstává nepovinná.
    • Automatická odpověď příjemce, kterou poskytovatel hlásí jako neurčené vrácení, už nevytvoří transactional.bounced; zpráva zůstává doručená. Skutečné vrácení nese v reason typ permanent nebo transient.
    • transactional.sending_state přijde jen při změně viditelného stavu; každá zpráva má nově jedno sent. Stav requires_attention se opakuje, když se změní důvod. Týká se webhooků i GET /transactional/events.
  5. 0.722.0 3. 11. 2026

    • Výběr transakčních zpráv z fronty k odeslání už nezpomaluje s délkou fronty. Velká rozesílka se předává Amazonu rychleji a stejným tempem od začátku do konce. Kontrakt API, pořadí zpráv ani pravidla pozastavení, zrušení a platnosti se nemění.
  6. 0.721.0 3. 11. 2026

    • Příjem zprávy a dávky už nevrací 409 event_ingest_not_ready ani 409 transport_worker_not_ready, když po nasazení krátce chybí tep odesílacích služeb. Zpráva čeká ve frontě do expires_at a odejde, jakmile jsou služby připravené. Globální vypnutí odesílání a trvalé brány se nemění.
    • Kontrola technických blokací adres v dávce běží dvěma dotazy místo dvou na každou adresu, takže dávka 50 zpráv odpoví rychleji. Důvody blokace a jejich pořadí se nemění.
  7. 0.720.0 3. 11. 2026

    • Souběžné dávky téže integrace se kontrolují a vykreslují paralelně; zámek integrace drží jen kapacitu, frontu a zápis. Kontrakt ani pořadí chyb se nemění, jen uzavřená reference se nahlásí až po kontrole dat příjemců.
    • GET /transactional/events už nevrací prázdnou stránku jen proto, že na pozici čekají události jiné integrace nebo režimu téhož projektu. Prázdná stránka teď znamená, že nové události nejsou.
    • Kapitola Výběr verze šablony popisuje, kde zjistit číslo pevné template_version, když ho katalog nevrací. Řešení problémů uvádí, že víc než 50 příjemců vrací 422 validation_error.
  8. 0.719.0 3. 11. 2026 Změna kontraktu

    • Čtení šablon vrací systémovou category s hodnotou marketing nebo transactional místo vlastní kategorie knihovny. Týká se GET /templates, detailu, stažení obsahu, transakčního katalogu i deklarace verze. Zápis šablony vlastní kategorii přijímá dál.
    • Výpisy, detail, katalog a deklarace šablon už nevracejí čísla verzí (version, publishedVersion, current_published_version.version, published_version_numbers, unpublished_edit_version). Historie GET /templates/{templateId}/versions a výběr template_version při odeslání fungují beze změny.
  9. 0.707.0 2. 11. 2026 Změna kontraktu

    • Integrace může mít explicitní přístup do dalších projektů stejné organizace, s oddělenými oprávněními. Klíče se nemění; limity jsou společné. Správa probíhá v domovském projektu v aplikaci.
    • GET /context nově obsahuje projects s dostupnými projekty a jejich scopes. Operace i idempotence zůstávají v cílovém projektu. Odebraný projekt nepřijímá další volání; již přijaté zprávy pokračují.
  10. 0.643.0 26. 10. 2026

    • Kapitola 10 MB / 10 000 řádků popisuje rozdělení zdrojového souboru do JSON dávek, menší a větší dávky, oddělené časy příjmu, importu a odesílání i předpoklady odhadů. Limity API se nemění; historická měření nejsou garancí výkonu.
    • Katalog GET /transactional/templates a deklarace verze zahrnují i šablony převzaté v projektu integrace. Nepovinné shared_from uvádí původ. template_id se nemění; bez template_version se použije přesně převzatá verze.
    • Převzatá šablona podporuje náhled vstupů i odeslání zprávy nebo dávky. Odesílatel a Reply-To jsou z profilu cílového projektu vybraného při převzetí; sender_profile_id vynechte. Jiný profil se odmítne. Obrázky se použijí až po dokončení kopie do cíle. Samotné sdílení bez převzetí přístup přes API nepovoluje.
  11. 0.617.0 23. 10. 2026

    • Víc než 1 000 kontaktů v POST /contacts/bulk vrátí 422 contact_batch_too_large s limitem a odeslaným počtem (dřív obecný validation_error).
    • Tělo nad 1 MiB vrátí 413 request_too_large s limitem v bajtech; převedené kontakty nad 750 000 znaků také s limitem.
    • Meze počtu a délky (maxItems, minItems, maxLength, minLength) mají ve fields text s limitem, například „Nejvýše 50 položek v jednom požadavku.“. Kódy chyb se nemění.
    • Nové kapitoly Limity a výkon v číslech (velikost požadavků, kapacita integrace, stropy tarifů, naměřená rychlost a vliv zatížení) a Hromadné nahrání kontaktů, k tomu tento přehled Co je nového v API.
  12. 0.609.0 22. 10. 2026 Změna kontraktu

    • Publikovanou transakční šablonu nelze upravit (PUT /templates/{templateId}) ani v ní publikovat jinou verzi: 409 template_published_locked. Opakovaná publikace téže verze zůstává povolená.
    • Nová operace POST /templates/{templateId}/duplicate vytvoří nepublikovanou kopii s novým template_id (name a source_version nepovinné).
    • Při blokaci odesílání API nejdřív ověří data požadavku: chybná data vrátí 422 s polem, blokace přijde jako 409 bez fields.sender_profile_id.
    • Webhooky se doručují souběžně, pomalý cíl nezdrží ostatní.
  13. 0.608.0 22. 10. 2026 Změna kontraktu

    • POST /contacts/{contactId}/permission s action: revoke zapíše globální marketingové odhlášení: kontakt se odhlásí ze všech marketingových e-mailů. Tvar odpovědi a chybové kódy se nemění.
  14. 0.604.0 22. 10. 2026 Změna kontraktu

    • Cesta k chybnému poli ve fields je JSON Pointer (/recipients/0/email, dřív recipients.0.email).
    • Nové operace: zrušení čekající zprávy POST /transactional/messages/{messageId}/cancel, řízení rozesílky se společnou referencí POST /transactional/requests/control a GET /transactional/reference.
    • Jeden Idempotency-Key platí společně pro /transactional/messages i /transactional/batches.
    • Tělo jiného typu než JSON vrátí 415 unsupported_media_type, klíč v nepovoleném tvaru 422 idempotency_key_invalid.
    • Kurzor událostí je šifrovaný a neprůhledný; upravený nebo cizí kurzor vrátí 422 invalid_event_cursor.
    • Čtení má vlastní limit požadavků, vyčerpané čtení nezablokuje odesílání.
    • POST /suppressions/check s adresou v těle; trvalé nedoručení, stížnost a zákaz SES blokují adresu v celé organizaci; GET /transactional/sending-control vrací dispatch_limit.
  15. 0.594.0 21. 10. 2026

    • Parametr q u GET /templates nerozlišuje diakritiku ani velikost písmen a hledá všechna zadaná slova.
  16. 0.593.0 21. 10. 2026

    • GET /templates vrací effectiveLimit a productLimit až do 1 000; placený tarif bez limitu má productLimit: null.
  17. 0.592.0 21. 10. 2026

    • Hlavičky X-RateLimit-* nesou limit integrace; GET /suppressions/check čte i registr adres; chyba jmenuje neznámé pole v těle; schéma bearer nezávisí na velikosti písmen.
    • Automatická odpověď příjemce (vrácení typu Undetermined) už zprávu neoznačí jako vrácenou.
  18. 0.591.0 21. 10. 2026

    • Nová publikace transakční šablony vyžaduje inputSchema.defaultSender, jinak 422. Dřív publikované verze bez odesílatele přijímají požadavky se sender_profile_id.
  19. 0.590.0 21. 10. 2026

    • Nepovinné inputSchema.unsubscribeUrl; publikace marketingové revize vyžaduje adresu a odkaz na ni v HTML i textové části. Odkaz se neměří ani nepřepisuje.
  20. 0.589.0 21. 10. 2026

    • Nepovinné inputSchema.messageKind (service / marketing); katalog transakčních šablon vrací message_kind.
  21. 0.587.0 20. 10. 2026

    • Ochrana proti sériím odmítnutých požadavků: po 20 odmítnutích platného klíče za 5 minut nebo 30 neplatných klíčích z jedné IP za 10 minut vrací API na 15 minut 429.

Úvod a první požadavek

Základní adresa: https://my.ngemailing.cz/api/integrations/v1. V aplikaci otevřete API a integrace → API přístupy. Vlastník nebo administrátor vytvoří klíč v domovském projektu. V nastavení integrace může výslovně povolit další projekty stejné organizace, každý s vlastními oprávněními. Celé tajemství se zobrazí jednou.

Do proměnné prostředí NG_TEST_API_KEY vložte svůj testovací API klíč. První požadavek načte kontext vaší integrace a projektu:

curl 'https://my.ngemailing.cz/api/integrations/v1/context' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY"

Identifikátory přebírejte celé z odpovědí API. Nové objekty používají například prj_ pro projekt, tpl_ pro šablonu, cnt_ pro kontakt a grp_ pro skupinu. API integrace používá api_. Dřívější ID zůstávají platná; jejich prefix sami nepřepisujte.

Přihlášení a testovací režim

Požadavky používají Authorization: Bearer <API_KEY>. Klíč nikdy neposílejte v URL. Integraci jde v aplikaci omezit na povolené IP adresy; požadavek odjinud pak vrátí 403 ip_not_allowed. ID projektu musí být domovský nebo výslovně povolený projekt integrace. Role a stav projektu se ověřují při každém požadavku.

Testovací integrace ověří zápisy podle stejných pravidel jako produkční režim, ale nezmění skutečná data. Výsledek má mode: test a simulated: true. Simulované transakční přijetí má trvalý výsledek ve vlastním testovacím režimu: ID zprávy/dávky lze číst přes výsledky, statistiky a události. Neexistuje odesílací pokus ani čerpání ostré kapacity; výsledek má důvod simulation_only (nebo původní blokaci) a žádné potvrzení doručení. Ostatní simulovaně založená ID nejsou trvalé objekty a nelze je použít v navazujícím požadavku; pro náhled nebo simulaci návaznosti použijte existující objekty vlastního projektu. Ostrá integrace může zapisovat data v přiděleném rozsahu. Cookies prohlížeče nejsou přihlášením do API.

Při rotaci vytvořte nový klíč, bezpečně jej uložte a přepněte integraci. Potom zrušte původní klíč. Limit ani identita integrace se nemění. Platnost klíče je nejvýše 366 dnů.

Napojení CRM krok za krokem

  1. Vytvořte projektový přístup. Vlastník nebo administrátor v API a integrace vytvoří samostatný testovací a produkční přístup pro odpovídající projekty. Pro čtení šablon a transakční odesílání zvolte project:read, templates:read, transactional:send a results:read; čtení odesílatelů navíc vyžaduje senders:read. Správu provozu a webhooky povolte, jen pokud je integrace používá. Oprávnění lze později změnit v detailu přes Upravit oprávnění; po uložení platí pro všechny klíče integrace. Označit vše vybírá jen dostupná oprávnění, není to doporučený výchozí rozsah.
  2. Načtěte kontext. GET /context potvrdí domovský projekt, režim a aktuální limity. Pole projects uvádí dostupné projekty (project_id, name, scopes). Limity jsou společné pro celou integraci. Odebrání projektu odmítne další přístup, ale již přijaté zprávy pokračují. Sdílení nepřebírá šablony ani data z jiného projektu. Následující projektové cesty začínají /projects/{projectId}. Testovací klíč simuluje přijetí a neodesílá do SES; skutečný doručovací test vyžaduje produkční klíč a schválené adresy.
  3. Vyberte šablonu. GET /projects/{projectId}/templates ukazuje vlastní knihovnu včetně marketingových šablon. Pro transakční odesílání načtěte GET /projects/{projectId}/transactional/templates: vlastní i převzaté publikované revize, jejich template_id, name, description, purpose, used_variables a current_published_version. Při čtení šablony obsahuje category systémový typ marketing nebo transactional, shodně s purpose. Číslo verze k odeslání je v current_published_version.version, všechny publikované verze v published_version_numbers; celou historii vrací GET /templates/{templateId}/versions.
  4. Převezměte přesnou deklaraci. GET /projects/{projectId}/transactional/templates/{templateId}/versions/{version} vrátí konkrétní publikovanou verzi, vstupy a obecná pole požadavku. used_variables jsou deduplikované značky skutečně použité v předmětu, úvodním textu, textu a dokumentu této revize; input_schema.fields je jejich deklarace včetně typů a povinnosti a může obsahovat i nepoužitá pole. Novější nepublikovaný návrh seznam značek publikované revize nezmění. Pro stažení obsahu běžné vlastní šablony použijte GET /projects/{projectId}/templates/{templateId}/versions/{version}, kde je seznam značek pojmenovaný usedVariables.
  5. Rozlište účel a odhlášení. Knihovní purpose rozlišuje marketing a transactional. U transakční verze message_kind: service znamená servisní zprávu bez požadovaného marketingového odhlášení. message_kind: marketing znamená marketingovou zprávu posílanou transakční frontou, s externím odhlašovacím odkazem input_schema.unsubscribeUrl v těle, zapsaným přímo nebo značkou {{unsubscribe_form_url}}. Výběr příjemců a zpracování tohoto odhlášení řídí CRM. Není to klasická marketingová kampaň nad kontakty.
  6. Ověřte vstupy a odešlete malou zkoušku. POST /projects/{projectId}/templates/{templateId}/versions/{version}/preview ověří inputs bez odesílání. Před skutečným testem musí být připravený výchozí odesílatel, Reply-To a klientské domény. Poté pošlete jednu zprávu nebo malou dávku s pevnou verzí, vlastní referencí a jedinečným Idempotency-Key. Stejný požadavek po nejasné odpovědi opakujte se stejným klíčem a tělem; nikdy automaticky neposílejte novou zprávu.
  7. Dohledávejte výsledek. Uložte batch_id, message_id a svoji referenci. Průběh kontrolujte v Transakčních e-mailech a přes výsledkové API; 202 znamená přijetí, nikoli doručení. Podle potřeby připojte podepsané webhooky. Rozesílku velkého objemu začněte až po dohodě kapacity, retencí, domén, provozních kontaktů a úspěšném koncovém testu CRM → fronta → SES → výsledky.

Bezpečné opakování zápisů

Zápisy vyžadují hlavičku Idempotency-Key (8 až 128 znaků, písmena, číslice, podtržítko, tečka, dvojtečka, pomlčka). Používejte nový unikátní klíč pro každou novou operaci. Stejný klíč a obsah v jedné integraci, cílovém projektu a operaci vrátí stejný výsledek. Jiná data vrátí 409 idempotency_conflict. Odeslání transakcí je jedna operace: POST /transactional/messages a POST /transactional/batches sdílejí klíče, takže klíč použitý u zprávy vrátí u dávky 409 idempotency_conflict a nikdy nevytvoří druhý e-mail. Chybějící hlavička vrátí 422 validation_error s polem idempotency-key, klíč s nepovoleným znakem (například mezerou) 422 idempotency_key_invalid. Výchozí lhůta výsledku je 7 dnů a ochranného otisku 90 dnů; provozovatel může pro nové požadavky přidělit jiné lhůty. Odpověď obsahuje idempotency.result_expires_at a idempotency.fingerprint_expires_at, které platí i po změně nastavení. Známý klíč po expiraci výsledku vrátí 409 idempotency_result_expired; neposílejte jej jako nový požadavek.

Limity, stránkování a chyby

Výchozí limit je 60 požadavků za minutu na integraci, sdílený napříč klíči a instancemi. Čtení (GET a kontroly bez změny dat) a zápisy mají každý vlastní počítadlo této výše, takže kontrola výsledků nezpomalí odesílání; hlavičky limitu popisují počítadlo, do kterého požadavek patří. Kapacitu přiděluje pouze provozovatel. Každá ověřená odpověď nese X-RateLimit-Limit, X-RateLimit-Remaining a X-RateLimit-Reset (sekundy do nové minuty) pro tento limit integrace; odpověď 429 rate_limited navíc Retry-After. GET /context a GET /project ukazují capacity.version a capacity.limits: HTTP požadavky/minutu, příjemce/minutu a den, maximum dávky a čekající fronty, její expiraci, obě lhůty idempotence a kapacitu webhooků. Rotace klíče počítadla nevynuluje. HTTP limit neurčuje rychlost SES; nadále platí podmínky odesílání, tarif a doménová připravenost. 429 a dočasná nedostupnost uvádějí Retry-After. Výpisy používají limit (1–100) a offset. Maximální JSON požadavek je 1 MiB.

Chyby mají typ application/problem+json, strojový code, status, request_id a případné konkrétní fields. Rozlišujte 401 přihlášení, 403 oprávnění, 404 objekt mimo rozsah, 409 konflikt, 413 velikost, 415 jiný typ těla než application/json (unsupported_media_type), 422 neplatná data, 429 limit a 503 nedostupnost. Klíče v fields jsou cesty JSON Pointer do těla nebo dotazu, například /recipients/0/email nebo /template_id, ať chybu najde schéma, nebo kontrola šablony; jen hlavička se jmenuje sama (idempotency-key).

U POST /transactional/messages se schémové i doménové chyby vztahují přímo k tělu jedné zprávy: /email nebo /inputs/cislo_smlouvy. U POST /transactional/batches zůstává index příjemce: /recipients/0/email nebo /recipients/0/inputs/cislo_smlouvy.

Limity a výkon v číslech

Celkovou dobu rozesílky ovlivňuje příjem i předávání fronty. Příjem omezuje HTTP kapacita, transakční příjemci za minutu/den a místo ve frontě (capacity.limits v GET /context). Předávání omezuje strop organizace podle tarifu (dispatch_limit v GET /transactional/sending-control), podíl na společné kapacitě a poskytovatel. Již přijatá fronta se může po obnovení odbavit rychleji než tempo jejího dřívějšího příjmu; příjemci/min integrace nejsou samostatný limit rychlosti workeru. Kapacita transakčních příjemců neomezuje počet importovaných kontaktů. Do příjmové kvóty zpráv patří i přijaté položky requires_attention, nikoli jen později úspěšně odeslané zprávy. Hodnoty vaší integrace jsou vždy v GET /context; vyšší kapacitu přiděluje provozovatel na žádost.

Velikost a tvar jednoho požadavku
CoLimitCo se stane nad limitem
Tělo HTTP požadavku1 048 576 bajtů (1 MiB)413 request_too_large
Příjemci v transakční dávce50 (nebo méně podle kapacity integrace)422 validation_error, celá dávka odmítnuta
Kontakty v POST /contacts/bulk1 000422 contact_batch_too_large
Převedené kontakty jednoho požadavku750 000 znaků413 request_too_large
CSV v JSON content pro /contact-imports5 000 datových řádků, 100 sloupců, 4 096 znaků na buňkuPlatí současně velikost těla, délka content, typové meze polí, tarif a provozní nastavení importu. Řádková/sloupcová/buňková mez parseru: 409 contact_import_limit_exceeded; délka content ve schématu nebo neplatný formát: 422.
Vstupní pole šablony (inputs)64 polí, hodnota do 2 000 znaků422 s cestou pole
Schéma vstupů šablony128 KiB422 u inputSchema
reference, external_customer_id, external_contract_id, batch_reference160 znaků422
E-mail příjemce320 znaků (kontakt 254)422
Idempotency-Key8–128 znaků: písmena bez diakritiky, číslice, _ . : -422 idempotency_key_invalid
expires_atnejdříve za 60 s, nejpozději podle čekání ve frontě422
Stránka výpisu (limit)1–100422
Kapacita integrace
CoVýchozíNejvyšší přidělitelnáPoznámka
HTTP požadavky za minutu6010 000Zvlášť pro čtení a pro zápisy. Nad limitem 429 rate_limited s Retry-After.
Transakční příjemci za minutu100100 000Limit příjmu zpráv. Nad ním 429 transactional_recipient_limit; opakujte stejnou dávku a klíč. Nejde o rychlost předání již přijaté fronty.
Transakční příjemci za den1 00010 000 000Příjem v pevném denním okně serveru; nejde o klouzavých 24 hodin ani o rychlost předání SES.
Příjemců v jedné dávce5050POST /transactional/batches.
Čekajících zpráv ve frontě1 000100 000Plná fronta vrátí 429 transactional_queue_limit; uvolňuje se odesíláním.
Nejdelší čekání zprávy (expires_at)1 den7 dníPak zpráva skončí jako zrušená, transactional_queue_expired.
Uchování výsledku opakování7 dní30 dníOpakovaný požadavek se stejným klíčem vrátí původní odpověď.
Ochrana klíče proti duplicitě90 dní365 dníPo vypršení výsledku klíč dál nedovolí druhou zprávu (idempotency_result_expired).
Pokusy o doručení webhooků za minutu601 000Všechny cíle integrace dohromady.
Cílů webhooků55
Pokusů o doručení jedné události66Prodlevy opakování: 30 s, 2 min, 10 min, 30 min, 2 h.
Uchování historie doručení webhooků7 dní7 dní

Nejvyšší přidělitelná hodnota je technický rozsah nastavení, nikoli garantovaná nebo právě volná kapacita serveru a poskytovatele. Limit těla 1 MiB ani horní hranici 50 příjemců či 1 000 kontaktů v uvedených dávkových operacích nelze zvýšit kapacitou integrace; větší vstup rozdělte. Nadále platí tarif, připravenost projektu a další provozní brány.

Příklad: zdrojový soubor 10 MB / 10 000 řádků

Veřejné API přijímá JSON, nemá endpoint pro upload CSV/XLSX souboru k rozeslání. Soubor rozparsuje klient a vytvoří dávky pro konkrétní operaci. 10 MB zde znamená 10 000 000 bajtů, 1 MiB je 1 048 576 bajtů. Jedno 10MB tělo se odmítne 413 request_too_large; jeho zpracování ani odesílání nezačne. Stejná mez platí pro HTTP přenos po částech (Transfer-Encoding: chunked); rozdělení dat znamená samostatné menší požadavky, každý s vlastním klíčem idempotence. Tělo typu CSV nebo multipart není podporovaný vstup těchto operací (415; při nadměrné velikosti může již proxy vrátit 413).

Velikost původního souboru neurčuje velikost JSON: mění ji názvy polí, uvozovky, escapování a UTF-8 (diakritika může zabrat více bajtů). Počítejte new TextEncoder().encode(JSON.stringify(body)).length, včetně obalu, evidence a všech polí. U kontaktů platí současně délka CSV převodu; i JSON pod 1 MiB může překročit 750 000 znaků. Prázdné sloupce a zdvojené uvozovky se do převodu také počítají.

Volba dávky pro 10 000 záznamů
ÚčelMenší dávkaVětší dávkaDalší omezení
Transakční zprávy10 příjemců → 1 000 požadavků50 příjemců → 200 požadavkůVždy nejvýše přidělené maximum a 1 MiB celého JSON.
Import kontaktů100 kontaktů → 100 úloh1 000 kontaktů → nejméně 10 úlohKaždý JSON do 1 MiB a převedené CSV do 750 000 znaků; delší řádky vyžadují menší dávku.

Use case A – import 10 000 kontaktů: použijte POST /contacts/bulk. Při průměru kolem 1 000 bajtů na řádek nelze automaticky předpokládat, že dávka 1 000 projde. Jako klientský výchozí návrh zvolte 500 kontaktů a přibližně 512 KiB JSON, při delších řádcích počet snižte; nejde o nový limit serveru. Ověřte i délku převedených kontaktů. Takový import tvoří nejméně 20 úloh, pokud se všechny vejdou. Předem ověřte volné místo přes GET /contacts → contactCapacity; nové unikátní adresy vyžadují odpovídající tarif. Každá dávka má vlastní stabilní Idempotency-Key. 202 poskytne job_id, nikoli hotový import. Sledujte GET /contact-imports/{job_id}/readiness až do konečného výsledku všech úloh, včetně vadných řádků a kapacitních chyb. Import sám neposílá e-maily a jeho dokončení se nepočítá jako odeslání 10 000 zpráv. Dále platí oprávnění, potvrzení původu dat a právní důvod, pravidla tarifu pro import a provozní kapacita importních úloh; mohou povolit menší rozsah než pevná horní hranice.

Pro vlastní mapování CSV lze použít také /contact-imports/analyze → /contact-imports/preview → POST /contact-imports → /contact-imports/{jobId}/commit. CSV se posílá jako text content uvnitř JSON, nejvýše 750 000 znaků a současně do 1 MiB celého těla; CSV parser navíc dovolí nejvýše 5 000 datových řádků, 100 sloupců a 4 096 znaků v buňce. Typové meze jednotlivých polí jsou přísnější (viz schémata operací); tarif a provozní nastavení mohou povolit méně. Nové vlastní pole v mapování má dataType text nebo number; u čísla platí stejné pravidlo jako v aplikaci a řádek s jinou hodnotou skončí jako neplatný. Odpověď analýzy nese v columnNumberChecks u každého sloupce počet vyplněných hodnot a kolik z nich by jako číslo neprošlo, bez samotných hodnot. Limit 1 000 kontaktů uvedený výše patří zjednodušené operaci /contacts/bulk. Výsledek i tohoto postupu sledujte přes readiness.

Jak dlouho trvá import: obecná garantovaná doba není stanovena. Závisí na počtu a délce polí, nových versus existujících adresách, duplicitách, kontrolách, kapacitě kontaktů a práci čekající před importem. Limit 60 HTTP požadavků/min neznamená 60 000 uložených kontaktů/min. Délku konkrétního importu měřte od první dávky po dokončení poslední úlohy; odděleně zaznamenejte čas přijetí všech dávek a čas práce na pozadí. Dobu přenosu souboru ani dobu importu nelze odvodit z níže uvedeného měření transakčního API. V readiness sledujte request.status (queued, processing, succeeded, failed, cancelled, source_expired), processedRows, createdContacts, updatedContacts a suppressedContacts. Počty neplatných a duplicitních vstupů vrací už přijetí. Stav succeeded sám neznamená, že každý řádek vytvořil nový kontakt.

Ukázka skutečného importu kontaktů (26. 10. 2026, produkce 0.637.0)
Profil a dávkaVzorkůJSONHTTP 202 p50 / p95Úloha p50
Krátký profil · 1 000 kontaktů1128 315 B290 ms / —68,9 s
Delší profil · 100 kontaktů3085 915 B347 / 586 ms56,4 s
Delší profil · 500 kontaktů6428 315 B411 / 615 ms6 min 31 s
Delší profil · 750 kontaktů2642 315 B577 / 601 ms9 min 42 s

HTTP čas zahrnuje síť a přijetí požadavku. Doba úlohy je rozdíl serverových completedAt a createdAt, včetně čekání ve frontě; není to samotný čas procesoru. Krátký profil měl e-mail a dvě krátká textová pole. Delší syntetický profil měl několik standardních textových polí blízko jejich mezí, přibližně 856 B JSON a 766 znaků CSV na kontakt. Vzorky pocházejí z jednoho projektu, postupného běhu a sdíleného provozu; stejné MB v jiných polích nemusí mít stejnou dobu. Malé vzorky nejsou SLA ani měření nejvyšší propustnosti.

Časový příklad pro import: 3 000 delších profilů v šesti dávkách po 500 se od vytvoření první úlohy do dokončení poslední zapsalo za 19 min 48 s, včetně čekání na kapacitu a opakování podle Retry-After. Přepočet na 10 000 stejných profilů v podobném provozu vychází zhruba na 66 minut; jde o model, nikoli naměřenou dobu libovolného 10MB souboru. Volba větší dávky šetří počet HTTP požadavků, sama nezvýší výkon zápisu na pozadí. Sledujte skutečné dokončení úloh.

Přesná hranice byla ověřena i v /contacts/bulk: JSON 838 248 B s převodem přesně 750 000 znaků byl přijat, JSON 838 339 B s převodem 750 001 znaků odmítnut 413. Obě těla byla pod 1 MiB. Počet kontaktů, který se vejde, závisí na jejich polích; položkové maximum 1 000 nezaručuje, že se vejde každá taková dávka.

Use case B – odeslání 10 000 personalizovaných zpráv: kontakty předem importovat nemusíte. Soubor převeďte na 200 dávek po 50 (nebo více menších), jednu společnou batch_reference, vlastní reference každé zprávy a vlastní idempotentní klíč dávky. Při průměru kolem 1 kB na příjemce má dávka 50 asi 50 kB plus obal; při 32 KiB na příjemce už dávka 50 překročí 1 MiB a musí být menší. Rozhoduje skutečně serializované tělo. Příjem šifruje a ukládá zprávy do fronty; odesílání běží průběžně souběžně s příjmem.

Model příjmu 10 000 transakčních zpráv při 60 zápisech/min
DávkaKapacita jen podle počtu HTTP požadavkůVýpočet objem / kapacita
10 příjemců600 příjemců/min16 min 40 s
50 příjemců3 000 příjemců/min3 min 20 s

Tabulka je výpočet plánovacího tempa, nikoli naměřený čas ani garantované minimum: minutová okna mohou dovolit počáteční dávku a jejich hranice čas změní. Nezahrnuje latenci, omezení příjemců, frontu, IP limit ani denní kvótu. Při výchozích 100 příjemcích/min je tempo příjmu nejvýše 100/min (objemový výpočet 100 min); výchozích 1 000/den však znamená, že 10 000 zpráv nelze přijmout v jednom denním okně. Pro tento scénář musí provozovatel předem přidělit odpovídající denní kapacitu. Rotace klíče kvótu neobchází.

Jak dlouho trvá odeslání: orientačně počet zbývajících zpráv / skutečně pozorované předání za minutu. Při historicky naměřených 1 260/min odpovídá 10 000 zpráv přibližně 8 minutám předávání, pouze pokud je stejně rychlý příjem, dostatečná kvóta a volná kapacita, bez pauz a závad. Při účinném tempu 100/min je objemový výpočet 100 min; skutečnost zhorší denní limit, již čekající práce a sdílené zatížení. Časy příjmu a odesílání se při souběhu nesčítají mechanicky. Ve výsledcích GET /transactional/statistics sledujte progress.estimated_seconds; null znamená, že spolehlivý odhad není k dispozici. sent potvrzuje předání, doručení dokládá až delivery: delivered; pro doručení do všech schránek pevná doba stanovena není.

Skutečný stupňovaný test odesílání (26. 10. 2026, malé servisní zprávy)
SadaPřijetí celé sadyVše předáno SES při kontrolePotvrzení SMTP doručení
1 000 zpráv · 20 dávek po 5020,5 sdo 64 sVšech 1 000 při kontrole za 24 min 11 s.
8 895 zpráv · nejvýše 50 v dávce3 min 13 sdo 6 min 58 sVšem nepotvrzeno; část zpráv skončila vrácením po dočasném selhání SMTP spojení.

Celý test měl 10 000 zpráv v 201 dávkách do vlastních schránek na jednom přijímacím serveru. Příjem poslední dávky nastal 31 min 54 s od prvního požadavku na odeslání, předání všech zpráv SES bylo potvrzené při kontrole za 35 min 39 s. Tyto celkové intervaly obsahují ověřovací přestávky mezi etapami; nejsou souvislým benchmarkem příjmu 10 000 zpráv. Časy v tabulce se počítají od začátku příslušné sady. Pro 199 plných dávek po 50 byla HTTP latence p50 900 ms, p95 1 021 ms. Součet jedinečných JSON těl činil 1 055 175 B (největší dávka 5 275 B), takže se zde neměřilo zpracování 10MB souboru ani velkých personalizačních vstupů.

Test oddělil rychlé přijetí a předání od neúspěšné doručitelnosti: ve skutečných schránkách byly ověřené příchozí kopie, ale u části zpráv SES hlásilo 421 4.4.1 Failed to establish connection a následné CustomTimeoutExceeded. Jedna kontrolní schránka hlásila Mailbox full. Diagnostika těchto vrácení uváděla doručovací lhůtu 1 440 s. expires_at řídí čekání před předáním z fronty aplikace; jeho prodloužení neprodlužuje pokusy SES po předání. Vzorek 107 detailů obsahoval 43 vrácených zpráv: rozdíl received_at − occurred_at měl p50 25 min 54 s, p95 58 min 1 s a maximum 1 h 14 min 42 s. Jde o tento omezený vzorek, nikoli maximum všech zpráv; ani výsledek po předání nemusí být v API okamžitě. Úplné konečné výsledky všech 10 000 zpráv bylo možné odečíst při kontrole za 2 h 19 min 39 s od prvního požadavku na odeslání, včetně přestávek mezi etapami, pokusů SES a prodlev událostí; to není doba úspěšného doručení všem. Zdroj této prodlevy není samotnými časy určený. Měření jednoho projektu a přijímacího serveru není maximální propustnost ani SLA; čas kompletního doručení 10 000 zpráv z něj nelze slíbit.

Ochrana počtu importních úloh: i sekvenční HTTP požadavky mohou naplnit rozpracované importy projektu, protože 202 nečeká na uložení kontaktů. Server pak vrací 503 contact_import_staging_unavailable, fields.blockers: active_job_limit_reached a Retry-After. Vyčkejte podle hlavičky a dokončení dříve přijatých úloh, potom opakujte stejné tělo a klíč; nový klíč ani další paralelní požadavky místo neuvolní. Jiné důvody v fields.blockers mohou znamenat nepřipravený worker nebo vypnutý import a vyžadují zásah provozovatele. Odečet provozního nastavení 26. 10. 2026: nejvýše 2 rozpracované úlohy na projekt, nejvýše 5 000 řádků na úlohu a platnost připraveného zdroje 60 minut. Lhůta běží každé úloze od jejího přijetí, nikoli celé sadě zdrojového souboru. Dokončená úloha místo uvolní. Provozovatel může nastavení změnit; tarif a pevné meze CSV mohou povolit méně. Tento počet a řádkový limit nejsou součástí capacity.limits API integrace. Pokud úloha nedoběhne do platnosti zdroje, může skončit jako source_expired. Dokud nemáte vlastní měření, bezpečná varianta je vždy dokončit jednu importní úlohu před další.

Kdy menší a kdy větší dávky

  • Menší dávky: menší latence jednotlivého požadavku, jemnější průběh a menší rozsah opravy při odmítnutí celé dávky; více HTTP požadavků a importních úloh.
  • Větší dávky: méně HTTP požadavků a režie; větší riziko překročení velikosti, delší odpověď a při chybě se opravuje celá dávka. Vždy respektujte menší z položkového, bajtového a přiděleného limitu.
  • Začněte souběhem 1. Souběh zvyšujte podle vlastního měření latence a 429, s čekáním podle Retry-After. Vedle limitu integrace platí 240 požadavků/min z jedné IP na proces API, společných s dalšími požadavky z této IP.
  • Po timeoutu může být práce přijata. Zopakujte stejné tělo se stejným klíčem. Timeout proxy 30 s není přislíbená doba zpracování ani pokyn poslat novou dávku pod jiným klíčem.
  • V testovacím režimu změříte validaci a simulované přijetí; rollback nenahrazuje měření skutečného zápisu kontaktů ani fronty a předávání SES.
Strop organizace podle tarifu (odečet 23. 10. 2026)
TarifKontaktůPříjemců / minPříjemců / denPříjemců / měsíc
Free10020100200
Kontakty 1 0001 0001 00010 00010 000
Kontakty 5 0005 0002 00050 00050 000
Kontakty 10 00010 0003 000100 000100 000
Kontakty 15 00015 0005 000150 000150 000
Kontakty 20 00020 0005 000200 000200 000
Kontakty 30 00030 0006 000300 000300 000
Kontakty 40 00040 0008 000400 000400 000
Kontakty 50 00050 00010 000500 000500 000
E-maily / kredity 1 000bez limitu5001 0001 000
E-maily / kredity 2 000bez limitu5002 0002 000
E-maily / kredity 5 000bez limitu1 0005 0005 000
E-maily / kredity 10 000bez limitu1 00010 00010 000
E-maily 25 000 / kredity 30 000bez limitu2 00025 00025 000
E-maily / kredity 50 000bez limitu2 00050 00050 000
E-maily / kredity 100 000bez limitu3 000100 000100 000
E-maily / kredity 200 000bez limitu5 000200 000200 000
E-maily / kredity 500 000bez limitu10 000500 000500 000

Kredity 30 000 mají za den i za měsíc 30 000. Tarify na míru mají stropy podle smlouvy; skutečný strop vaší organizace vrací GET /transactional/sending-control.

Jak se rychlost mění se zatížením

Platforma předává zprávy poskytovateli nejvýš 64 příjemců za sekundu (3 840 za minutu) pro všechny klienty dohromady: 80 % rychlosti, kterou poskytovatel povoluje, zbytek je rezerva (stav 23. 10. 2026). Kampaně i transakce všech klientů sdílejí tento strop. Když odesílá víc klientů zároveň, plánovač dělí kapacitu váženě podle stropu tarifu za minutu: klient s vyšším tarifem dostane větší podíl, ale nikdy víc, než dovoluje jeho tarif a kapacita integrace. Odesílá-li jen jeden klient, dostane celou volnou kapacitu až do svého stropu. Krátká špička jednoho klienta je nejvýš 1 000 příjemců, pak plánovač pustí ke slovu ostatní.

Měření produkce 19. 11. 2026 (verze 0.932.0–0.933.0, hodina nepřetržitého provozu)
OperaceVzorkůp50p95Poznámka
Přijetí jedné transakční zprávy (202)815 + 20179 ms236 msTestovací klíč; ostrý klíč p50 140 ms, p95 183 ms. Jednotlivé požadavky výjimečně do 4,3 s.
Přijetí dávky 20 příjemců33375 ms485 msJedna dávka 50 příjemců: 652 ms.
Opakování stejným Idempotency-Key20550 ms79 msVrátí původní odpověď, nic nevznikne podruhé.
Detail zprávy, výpis zpráv, události, statistiky75361–91 ms92–111 msOjediněle 1,3–2,3 s.
Výpis kontaktů (5), kampaní (5), šablon (5)296119–242 ms135–343 ms
Přijetí API → převzetí poskytovatelem200,88 s—Ostré zprávy na simulátor poskytovatele, malý objem.
Přijetí API → doručení na server příjemce201,49 s—Nejvýše 1,91 s; všech 20 doručeno.
10 souběžných požadavků jedním klíčem10——Vyřízeny postupně za sebou, 41–371 ms. Souběh jednoho klíče nezvyšuje propustnost, dávka ano.

Měřeno při asi 44 požadavcích za minutu na klíč, pod výchozím limitem 60, mimo dvě nasazení během té hodiny. Jde o latenci příjmu a čtení při malém objemu, ne o propustnost velké rozesílky; tu popisují měření a model níže. Testovací klíč kontroluje limity příjemců jen u jednotlivého požadavku: simulace se po kontrole vrací zpět, a proto se příjemci za minutu a za den mezi požadavky nesčítají (za hodinu 1 482 simulovaných příjemců při denním limitu 1 000 bez odmítnutí). Limit HTTP požadavků za minutu platí i pro testovací klíč. Ostrý klíč počítá příjemce do obou limitů.

Historická měření produkce (20.–23. 10. 2026, syntetické zprávy)
KrokNaměřenoCo z toho plyne
Přijetí jedné zprávy (202)p50 60 ms, p95 380 msČas odpovědi vzorku; čekání ve frontě se měří odděleně.
Přijetí dávky 50 příjemcůp50 0,7 s, p95 1,4 sČas odpovědi jedné dávky; neurčuje dobu dokončení celé rozesílky.
Předání poskytovateli, jeden klient sámprůměr 21 zpráv/s, špička 24/sAsi 1 260 zpráv za minutu, 75 000 za hodinu.
Předání → doručení na server příjemcep50 0,4–0,5 sZpoždění vzniká hlavně čekáním ve frontě.
Události o doručení při 1 300 zprávách/minzpracování 9–10/s, zpoždění nejvýš 35 sPři velkém objemu chodí výsledky s odstupem desítek sekund.

Jde o omezené historické vzorky s konkrétní šablonou a tehdejší kapacitou, nikoli SLA ani certifikované maximum současného serveru. p50 je medián, p95 čas, do kterého se vešlo 95 % požadavků vzorku. Simulátor poskytovatele neověřuje doručení do běžných schránek. Měření importu kontaktů ani scénář 10MB souboru tyto vzorky neobsahují.

Model doby předávání při 1 260 zprávách/min (bez záruky)
ObjemPři celém naměřeném tempuModel při polovičním tempu
10 000 zprávasi 8 minasi 16 min
100 000 zprávasi 1 h 20 minasi 2 h 40 min
500 000 zprávasi 6 h 40 minasi 13 h
1 000 000 zpráv měsíčněasi 13 h odesílání za měsícasi 26 h za měsíc

Odhady platí pro transakční zprávy, které se předávají po jedné. Když zároveň běží velká kampaň jiného klienta, prodlouží se úměrně jeho podílu. Velkou rozesílku proto rozložte v čase, dejte zprávám expires_at podle očekávané délky a řiďte tempo podle odpovědí 429 (viz Velké rozesílky).

Pojistka reputace projektu se vyhodnocuje za 24 hodin od 200 pokusů: varování při 2 % trvale nedoručených nebo 0,05 % stížností, pozastavení při 5 % nebo 0,1 %. Opakovaně odmítané požadavky (20 za 5 minut s platným klíčem, 30 neplatných klíčů za 10 minut z jedné adresy) vrací na 15 minut 429.

Po zveřejněné lhůtě ochranného otisku lze otisk fyzicky odstranit a záruka idempotence končí. Starý klíč znovu nepoužívejte ani po odstranění otisku. Při opakování původního požadavku platí jeho tehdejší výsledek, nikoli dnešní stav šablony či objektu.

Pozastavení a obnovení transakční rozesílky

Aktuální stav načtete přes GET /projects/{projectId}/transactional/sending-control s oprávněním results:read. Pro změnu použijte POST /projects/{projectId}/transactional/sending-control/status, oprávnění transactional:write, hlavičku Idempotency-Key a tělo {"action":"pause"} nebo {"action":"resume"}. Cesty navazují na základ /api/integrations/v1.

Řízení je společné s UI a platí pro celý projekt, včetně jiných integrací a ručních testů. Pozastavení drží odbavení čekající fronty; validní API zprávy se nadále přijímají s platnými limity a expirací. Ruční test během projektové pauzy nelze odeslat. Již zahájené předání může doběhnout. Expirace běží i během pauzy; obnovení nezruší limity ani další podmínky odesílání. Odpověď HTTP 200 vrací stav v result (paused, paused_at, version). Testovací klíč vrátí simulovaný výsledek a skutečný stav nezmění.

Každému novému příkazu přidělte nový Idempotency-Key. Při síťovém opakování zachovejte původní klíč a tělo: vrátí se původní výsledek a pozdější změna stavu se nepřepíše. Pro aktuální stav použijte GET. Odpověď obsahuje i dispatch_limit.recipients_per_minute: strop předání organizace podle tarifu a platformy. Rychleji zprávy neodcházejí, ani když integrace přijme víc; null znamená, že strop nelze určit.

Zrušení jedné zprávy

POST /transactional/messages/{messageId}/cancel bez těla, s oprávněním transactional:send a novým Idempotency-Key, zruší zprávu, dokud její předání Amazon SES nezačalo, například po stažení kartičky. Výsledek je {message_id, state: cancelled} a zpráva má stav cancelled s důvodem transactional_cancelled_by_user. Pokud předání už začalo nebo proběhlo, vrátí 409 transactional_cancel_not_possible: odeslaný e-mail nelze vzít zpět a nejistě předanou zprávu nejde bezpečně zastavit. Už zrušená zpráva vrátí 409 transactional_already_cancelled. Zrušení a předání se navzájem vylučují: po potvrzeném zrušení zpráva nikdy neodejde.

Pozastavení, obnovení a uzavření rozesílky

Rozesílku tvoří požadavky se stejnou batch_reference (napříč ostrými integracemi projektu) nebo jeden požadavek podle batch_id. POST /transactional/requests/control s oprávněním transactional:write, novým Idempotency-Key a tělem {"action":"pause"|"resume"|"cancel", "batch_reference":"…"} nebo {… "batch_id":"…"} (právě jedno z nich, jinak 422 transactional_request_target_invalid):

  • pause drží odbavení přijatých zpráv reference a i nové požadavky se stejnou referencí se přijímají a čekají; limity a platnost dál běží.
  • resume odbavení uvolní.
  • cancel je trvalý pokyn: na pozadí zruší všechny dosud nepředané zprávy a referenci uzavře. Další požadavek s ní vrátí 409 transactional_reference_closed.

Odpověď uvádí affected_requests, cancelled (zprávy čekající na zrušení) a skipped (už předané nebo ukončené). Konečný stav ukazují stavy zpráv a GET /transactional/reference?batch_reference=… s oprávněním results:read: stav řízení (active, paused, closed) a počty zpráv podle stavů. Jedna akce zasáhne nejvýše 10 000 požadavků (422 transactional_request_target_too_large). Pauza projektu (výše) zastaví všechno, pauza reference jen jednu rozesílku, zrušení zprávy jednu zprávu.

Velké rozesílky

Rozesílka statisíců zpráv se nepředává jedním HTTP požadavkem. Váš systém ji rozdělí na dávky po nejvýše capacity.limits.maximum_batch_size příjemcích (výchozí 50) a posílá je postupně:

  1. Celé rozesílce dejte jednu batch_reference, každé dávce vlastní Idempotency-Key odvozený z reference a pořadí dávky (například karta-2027-01:000123) a každé zprávě vlastní reference.
  2. Posílejte dávky za sebou nebo s malým souběhem. Odpověď 429 (rate_limited, transactional_recipient_limit, transactional_queue_limit) není chyba rozesílky: počkejte Retry-After sekund a pošlete stejnou dávku se stejným klíčem. Plná fronta (capacity.limits.maximum_queued_recipients) se uvolňuje průběžným odesíláním.
  3. Když spojení spadne nebo odpověď nepřijde, pošlete stejnou dávku se stejným klíčem a tělem: přijatá dávka vrátí původní výsledek, nepřijatá se přijme teď. Druhý e-mail nevznikne. Nikdy neposílejte stejné zprávy pod novým klíčem.
  4. Po přerušení pokračujte od první dávky, kterou nemáte potvrzenou odpovědí 202; dávky se opakují bezpečně. Odmítnutá dávka (422) se nepřijme celá a ostatní dávky neovlivní.
  5. Výsledky čtěte po dávkách (GET /transactional/batches/{batchId}), souhrnně přes GET /transactional/reference nebo průběžně přes události a webhook, ne dotazem na každou zprávu.

Tempo příjmu omezuje kapacita integrace (capacity.limits.recipients_per_minute a za den). Předávání již přijaté fronty omezuje strop organizace (dispatch_limit.recipients_per_minute v GET /transactional/sending-control), podíl na společné kapacitě a Amazon SES. Celková doba plynulé rozesílky závisí na obou fázích; již přijaté zprávy mohou odcházet rychleji, než byly přijímány. Například 500 000 zpráv při stropu 3 000 příjemců za minutu potřebuje přibližně 3 hodiny. Zprávy, které čekají déle než jejich expires_at, se neodešlou; u dlouhé rozesílky nastavte platnost podle očekávané délky. Rozesílku lze kdykoli pozastavit nebo uzavřít přes batch_reference (výše).

Hromadné nahrání kontaktů

Desítky a stovky tisíc kontaktů se nepředávají jedním HTTP požadavkem. POST /contacts/bulk přijme v jednom požadavku nejvýše 1 000 kontaktů a tělo nejvýše 1 MiB (1 048 576 bajtů); po převodu na importní řádky nesmí kontakty přesáhnout 750 000 znaků. Víc kontaktů vrátí 422 contact_batch_too_large s počtem, který jste poslali, větší tělo 413 request_too_large. V obou případech se nic nepřijme.

  1. Před nahráním ověřte kapacitu: GET /contacts vrací contactCapacity (limit podle tarifu, null bez omezení, a used). Adresa, kterou organizace už má, místo nezabírá.
  2. Rozdělte kontakty po nejvýše 1 000 a každé dávce dejte vlastní Idempotency-Key odvozený z importu a pořadí (například crm-2027-01:000123). Dlouhé hodnoty vlastních polí zmenšete nebo pošlete méně kontaktů v dávce.
  3. Posílejte dávky za sebou. Odpověď 202 vrací job_id; kontakty se zapisují na pozadí. Při 429 počkejte Retry-After sekund a pošlete stejnou dávku se stejným klíčem. Spadlé spojení řešte stejně: stejný klíč a tělo nevytvoří druhou úlohu.
  4. Postup a výsledek každé úlohy čtěte přes GET /contact-imports a GET /contact-imports/{job_id}/readiness: počty neplatných a duplicitních řádků, stav zpracování, případné blockers a failureReason.
  5. Když kapacita tarifu dojde, další dávka se nezpracuje: připravenost úlohy hlásí contact_capacity_exhausted, a dojde-li kapacita během zpracování, úloha skončí s failureReason: contact_limit_reached a zbytek jejích řádků se zahodí. Pokračujte až po navýšení tarifu, od první dávky, kterou nemáte potvrzenou jako zpracovanou.

Rychlost příjmu omezuje requests_per_minute integrace (například 60 požadavků po 1 000 kontaktech je nejvýše 60 000 kontaktů za minutu); zápis na pozadí může trvat déle než samotné přijetí. Import neuděluje marketingový souhlas a chráněné blokace adres zůstávají (viz Práce s kontakty).

Blokované kontakty ve výsledku importu

202 Accepted potvrzuje přijetí kontaktů, nikoli možnost na ně odesílat. Po dokončení importu načtěte GET /contact-imports/{jobId}/results?limit=25&offset=0; potřebujete contacts:read i suppressions:read. Stránkujte pomocí limit (1–100) a offset, dokud nepřečtete total zpracovaných řádků. Během zpracování počet roste; dokončení hlídá readiness.

Každá položka obsahuje source_row, contact_id, outcome (created, updated, suppressed) a result_code. Zdrojový řádek počítá hlavičku CSV; u JSON importu první kontakt odpovídá řádku 2. Adresy se znovu nevracejí, položku spárujte s původním vstupem. current_contact_status je stav uloženého kontaktu; current_suppression.marketing a transactional odděleně uvádějí blocked a reasons, například hard_bounce nebo dočasný soft_bounce.

Existující kontakt může mít výsledek suppressed, zatímco nový kontakt s blokací v registru adres může být created a současně blokovaný. Import blokaci neuvolňuje. suppression_basis: current_state_not_import_history a evaluated_at označují aktuální kontrolu; nejde o historický důvod při importu. Po změně e-mailu kontaktu se kontroluje jeho současná adresa; původní importovaná adresa tím není odblokována. U odstraněné, nejednoznačné nebo nedohledatelné identity je current_suppression: null, což neznamená povolení odesílat. Ani blocked: false nepotvrzuje marketingový souhlas nebo splnění dalších podmínek odeslání.

Oprávnění

Každá operace níže uvádí požadované oprávnění. Čtení a zápis se přidělují zvlášť; například templates:read neumožňuje vytvořit šablonu. Odeslání vyžaduje transactional:send, výsledky results:read. Pozastavení a obnovení celého projektu vyžaduje samostatné transactional:write; samotné oprávnění odesílat nestačí. Výmaz transakčních dat jednoho příjemce vyžaduje transactional:erase a ostrý klíč; je nevratný a bez adresy ve výsledku. Blokace mají oprávnění suppressions:read; webhooky oddělená oprávnění webhooks:read a webhooks:write.

Řešení problémů a chybové scénáře

Nejdříve rozlište odmítnutý požadavek, přijatou práci a nejistý výsledek. HTTP 202 potvrzuje přijetí do zpracování, nikoli odeslání nebo doručení e-mailu. Pro rozhodnutí použijte současně HTTP stav, code, fields a výsledek konkrétní zprávy.

Klíč nefunguje: 401, 403 nebo 404

401 invalid_api_key / api_key_expired: zkontrolujte hlavičku Authorization: Bearer <API_KEY>, platnost a zrušení klíče. Přihlášení v prohlížeči nestačí. Prošlý nebo zrušený klíč neopraví opakování požadavku; správce vytvoří náhradní klíč, který bezpečně uložíte do svého systému.

403 scope_required: klíč nemá oprávnění konkrétní operace. Porovnejte je s referencí níže. integration_permission_revoked znamená změnu oprávnění zakladatele, api_admission_revoked změnu přístupu před přijetím zápisu. Správce musí ověřit členství, roli, projekt a stav integrace; prosté opakování ani nový klíč stejné integrace nemusí pomoci.

404 project_not_found nebo chybějící objekt: zkontrolujte projekt přiřazený ke klíči a ID objektu. Cizí projekt se nezpřístupní změnou URL. U testovacího režimu nejsou běžně simulovaně založené objekty trvalé; transakční simulace má vlastní uchované výsledky. U starších výsledků může jít o vymazání po uplynutí lhůty uchování.

Neplatné pole, ID nebo dávka: 422, 413 a 415

422: opravte konkrétní položky v fields. ID běžného objektu má prefix a 32 hexadecimálních znaků; například vlastní text api_moje_integrace není platné ID. Používejte ID vrácené aplikací nebo API a schéma daného endpointu. Povinná pole, typy a rozsahy se nevynucují automatickým převodem řetězců na čísla.

U jednotlivé zprávy používá transactional_inputs_invalid cestu /email nebo /inputs/cislo_smlouvy. U dávky může ukázat například /recipients/0/email nebo konkrétní vstup šablony /recipients/0/inputs/cislo_smlouvy. U seznamu položek cesta pokračuje indexem položky od nuly a názvem údaje, například /inputs/pojistene_osoby/1/karticka_url. Neplatný vstup odmítne celou transakční dávku. Opravte data a odešlete opravenou operaci s novým Idempotency-Key, až když je původní odmítnutí jisté. Pokud odpověď chybí, postupujte podle scénáře nejistého přijetí níže.

Víc než 50 příjemců v jedné dávce odmítne kontrola schématu jako 422 validation_error s polem /recipients. transactional_batch_too_large znamená překročení nižšího limitu počtu položek integrace (capacity.limits.maximum_batch_size); 413 překročení velikosti HTTP těla (nejvýše 1 MiB). Rozdělte vstup do menších dávek podle aktuálního capacity.limits. Každá nová dávka má vlastní klíč opakování. Nezaměňujte limit požadavků s počtem příjemců.

415 unsupported_media_type: tělo nebylo odesláno jako JSON. Nastavte Content-Type: application/json. Požadavek nebyl přijat a nic nevzniklo; po opravě pošlete stejnou operaci se stejným klíčem.

Jak číst chybovou odpověď

API vrací chyby ve formátu application/problem+json. Následující ukázka odpovídá odmítnutí neplatné adresy v první položce transakční dávky; identifikátor požadavku je ukázkový.

HTTP 422
Content-Type: application/problem+json

{
  "type": "urn:ngemailing:problem:transactional_inputs_invalid",
  "title": "Zkontrolujte příjemce dávky.",
  "status": 422,
  "code": "transactional_inputs_invalid",
  "request_id": "ukazkovy-pozadavek-001",
  "fields": {
    "recipients.0.email": "Neplatná e-mailová adresa."
  }
}
  • status je HTTP stav; code je stabilní strojový důvod pro rozhodování ve vaší aplikaci.
  • title je vysvětlení pro člověka. Logiku aplikace nestavte na přesném znění této věty.
  • type identifikuje typ chyby; nejde o adresu stránky s návodem.
  • request_id slouží podpoře k dohledání konkrétního požadavku. Nenahrazuje Idempotency-Key.
  • Nepovinné fields mapuje vadná pole na vysvětlení. recipients.0.email označuje e-mail prvního příjemce (číslování začíná nulou). Ne každá chyba obsahuje fields.

V této ukázce se odmítá celá dávka. Opravte adresu a opravenou operaci odešlete s novým Idempotency-Key. Pokud místo této jednoznačné odpovědi spojení selhalo, postupujte podle pravidel pro nejistý výsledek níže.

Chyba serveru 500, 502, 503, 504 nebo vypršení času spojení

500 internal_error znamená, že API požadavek nedokázalo zpracovat běžným způsobem. Odpověď aplikace obsahuje request_id. Chyby 502 a 504 mohou vzniknout na síťové bráně; jejich odpověď nemusí být JSON ani obsahovat code či request_id. Při vypršení času spojení nemusíte obdržet žádnou odpověď. Vaše aplikace musí zvládnout i prázdné tělo nebo HTML chybovou stránku.

Krátká nedostupnost při nasazení. Při nasazení nové verze aplikace může API jednu až dvě minuty odpovídat chybou brány (při měření 19. 11. 2026 dvakrát 102 s a 88 s): nejdřív 502 nebo 504, potom i 404 s prostým textem 404 page not found místo JSON. Takovou odpověď poznáte podle toho, že nemá typ application/problem+json, code ani request_id. Nejde o neexistující operaci ani objekt: zápis zopakujte podle postupu níže se stejným tělem a původním Idempotency-Key. Skutečné 404 aplikace je vždy JSON s code, například operation_not_found nebo transactional_message_not_found. Při ověření 16. 11. 2026 vrátily dávky, které skončily 504, po opakování se stejným klíčem 202 a žádná zpráva nevznikla dvakrát. Při ověření 19. 11. 2026 zpráva, která při nasazení dostala 502, nevznikla vůbec; opakování ji teprve přijme.

Plný limit kontaktů tarifu. POST /contacts u organizace, která vyčerpala počet kontaktů tarifu, dnes vrací 503 contact_import_commit_unavailable s fields.blockers: contact_capacity_exhausted. Přestože jde o kód 503, nejde o dočasný výpadek: opakování neuspěje, dokud organizace neuvolní kontakty nebo nezmění tarif. Podle fields.blockers proto požadavek neopakujte automaticky.

  1. U zápisu nepředpokládejte, že se nic nestalo. Chyba spojení nebo serveru sama nepotvrzuje, že požadavek nebyl přijat. Máte-li ID zprávy nebo dávky, ověřte její výsledek čtecí operací.
  2. Je-li vrácena hlavička Retry-After, vyčkejte uvedenou dobu. U 503 přečtěte i code: například integration_paused potřebuje obnovení integrace, samotné čekání příčinu neodstraní.
  3. Bez pokynu serveru rozložte pokusy s rostoucí prodlevou a malou náhodnou odchylkou. Například 2, 4 a 8 sekund je doporučení pro klienta, nikoli garantovaná doba obnovy služby. Nastavte konečný počet pokusů a celkovou dobu čekání.
  4. Stejný zápis opakujte se stejnou metodou, cestou, tělem a původním Idempotency-Key. Nevytvářejte náhradní zprávu s novým klíčem jen kvůli chybě serveru. Při idempotency_result_expired další automatické opakování zastavte a dohledávejte původní výsledek.
  5. Při trvající chybě přerušte automatické pokusy, zachovejte vlastní evidenci požadavku a kontaktujte podporu s časem, stavem a dostupnými identifikátory. Neposílejte tajné klíče.

Spojení spadlo a nevíme, zda se požadavek přijal

Nevytvářejte nový klíč opakování jen kvůli chybě spojení. Zopakujte stejnou operaci se stejným tělem a původním Idempotency-Key. Pokud se první zápis potvrdil, vrátí se jeho uložený výsledek; nevznikne druhá zpráva. Uložte si request_id, batch_id, message_id a vlastní reference, pokud je už máte. Stav ověřte přes výsledky zpráv nebo dávky. Samotné čtení výsledku nic neodesílá.

Stejný klíč s jiným tělem vrací 409 idempotency_conflict; vraťte původní obsah nebo novou operaci oddělte až po zjištění výsledku původní. 409 idempotency_result_expired není pokyn k novému odeslání: původní výsledek už nelze přehrát. Dohledejte zprávy a vlastní evidenci, případně kontaktujte podporu. Nový klíč může vytvořit duplicitní zprávu. reference slouží k dohledání a nenahrazuje Idempotency-Key.

Požadavky nebo fronta narazily na limit: 429

rate_limited je limit HTTP požadavků, transactional_recipient_limit kapacita příjemců za minutu nebo den a transactional_queue_limit plná čekající fronta. Načtěte kapacitu přes GET /context nebo GET /projects/{projectId}/project. Dodržte Retry-After, omezte souběžnost a další pokusy rozložte v čase. Stejnou nezměněnou operaci opakujte s původním klíčem. Rotace API klíče limit nevynuluje.

Kapacita příjmu API není rychlost doručování. Zprávy přijaté s 202 dál podléhají minutovému limitu tarifu celé organizace, případnému nižšímu individuálnímu limitu a kapacitě SES. Například API může přijmout 100 příjemců za minutu, ale tarif předává jen 20 za minutu. Čas čekání proto odvozujte od skutečného odesílacího limitu, ne pouze od capacity.limits.

Do minutového limitu se počítají i odmítnuté požadavky. Když klíč během 5 minut 20krát požádá o cizí projekt nebo operaci bez oprávnění, další takové požadavky dostanou na 15 minut 429 rate_limited; požadavky na vlastní projekt klíče fungují dál. Po 30 neplatných klíčích z jedné IP adresy během 10 minut odmítá API na 15 minut další neplatné klíče z této adresy. Opravte projectId, oprávnění klíče nebo samotný klíč a dodržte Retry-After.

Přijetí požadavku a odeslání zprávy jsou samostatné kroky. Aktuální průběh sledujte ve výsledcích zpráv a statistikách. Pokud přidělená kapacita nevyhovuje vašemu provozu, kontaktujte podporu.

Pozastavená integrace není totéž co pozastavený projekt

Pauza integrace: zápis s jejím klíčem typicky vrací 503 integration_paused a Retry-After; při změně stavu během příjmu může být zápis odmítnut i jako konflikt nebo změna oprávnění. Čtecí operace mohou zůstat dostupné. Správce musí integraci obnovit, potom lze opakovat původní nezměněný požadavek se stejným klíčem opakování.

Pauza transakčního odesílání projektu: platné API zprávy se dál přijímají do fronty, ale neodbavují se. Ruční test v aplikaci je během pauzy blokovaný. Stav zjistíte přes GET /projects/{projectId}/transactional/sending-control; obnovení vyžaduje transactional:write. Expirace běží i během pauzy a již zahájené předání může doběhnout. Po obnovení stále platí ostatní podmínky a limity.

Dostali jsme 202, ale e-mail nedorazil

Otevřete GET /projects/{projectId}/transactional/messages/{messageId} nebo výsledek dávky a zkontrolujte samostatně odesílání, doručení, důvod a časovou osu. mode: test, simulated: true a důvod simulation_only znamenají simulaci bez skutečného e-mailu. V produkčním režimu ověřte pauzu, připravenost odesílacího profilu a domény i stav fronty.

Chráněná blokace příjemce může být položkovým výsledkem platné dávky; ostatní položky pokračují. Prověřte POST /projects/{projectId}/suppressions/check s adresou v těle. Blokaci po trvalém nedoručení nebo stížnosti neobcházejte novým kontaktem či klíčem. Potvrzení doručení serveru příjemce nezaručuje umístění do hlavní doručené pošty; příjemce může mít zprávu ve spamu.

Výsledky SES a selhání po přijetí

Dočasně nedoručitelnou zprávu (například plnou schránku) zkouší Amazon SES doručit nejvýše 12 hodin. Potom ji vrátí jako dočasné nedoručení a adresa se v projektu na 72 hodin zablokuje; uvolněná schránka zprávu dodatečně nedostane. Když Amazon zprávu do 15 minut od předání nepotvrdí ani nevrátí a není u ní zaznamenané otevření ani proklik, má doručení hodnotu delayed, i když událost o zdržení nepřišla. Webhook transactional.delayed přijde jen s událostí od Amazonu.

Výsledek nebo důvodCo znamená a jak postupovat
queued / retry_waitZpráva čeká na dostupnou kapacitu, konec pauzy nebo plánovaný pokus. Sledujte stáří fronty, expires_at, tarif a stav odesílání. Nevytvářejte druhou zprávu.
sent bez deliveredSES zprávu přijal, událost doručení zatím není potvrzená. Vyčkejte a ověřte události; při plošném výpadku řeší podpora příjem událostí. Samotná absence události nepovoluje opětovné odeslání.
deliveredPříjem potvrdil cílový poštovní server. Nejde o důkaz přečtení ani umístění do hlavní doručené pošty.
bounceRozlište trvalé a dočasné nedoručení podle události. U trvalého nedoručení adresu dále nepoužívejte a respektujte blokaci. Dočasné problémy může dále zpracovávat SES; neposílejte vlastní duplicitní zprávu během nejistého doručování.
complaintPříjemce nahlásil spam. Zastavte další odesílání na adresu, zkontrolujte původ dat a respektujte blokaci i reputační ochrany.
requires_attention / transactional_recipient_blockedOvěřte konkrétní reason, detail a blokace. Takový výsledek není doručení; další položky dávky mohou mít jiný výsledek. Novým klíčem ochranu neobcházejte.
transactional_queue_expired / transactional_cancelled_by_user / transactional_integration_revokedČekající zpráva skončila před předáním. Expirace se neprodlužuje obnovením integrace. Případné nové odeslání musí vycházet z aktuálního obchodního záměru; již zahájené předání není odvolané.
TRANSIENT_FAILURE / ACCOUNT_THROTTLEDAutomatický pokus je dovolen jen při prokázaném nepřijetí položky bez providerMessageId. Server jej omezuje na nejvýše tři pokusy s prodlevou. Klient souběžně neposílá náhradní zprávu.
provider_call_refusedSES volání jistě odmítl dřív, než zprávu převzal (omezení rychlosti, nenavázané spojení, oprávnění). Zpráva se vrací do fronty a server předání sám opakuje s odkladem; duplicita nevznikne. Klient náhradní zprávu neposílá.
provider_handoff_ambiguous / provider_result_unalignableNení jisté, zda SES zprávu přijal, nebo nelze spolehlivě přiřadit výsledek. Automatické opakování předání je zakázané kvůli duplicitám. Ověřte události a předejte ID podpoře.
transactional_render_failed / transactional_batch_unreadable / transactional_crypto_unavailable / transactional_dispatch_unavailableSelhalo sestavení, integrita podkladů, šifrování nebo zpracování. Zachovejte ID zprávy a request_id, ověřte detail a kontaktujte podporu. Již přijatý obsah neměňte novým publikováním šablony a neposílejte klíče ani personalizační vstupy do logů.
transactional_route_changed / transactional_transport_unavailable / odesílací bránaPodpora ověří trasu, region a provoz služby; vlastník stav domény a tarifu. Některé překážky vracejí práci do fronty s odkladem. Oprava konfigurace nenahrazuje sledování konečného výsledku a expirace.

Odpověď výsledkové čtecí operace může být HTTP 200 i pro nedoručenou zprávu: HTTP stav popisuje úspěšné načtení. Stav zprávy, doručení a stížnost vyhodnocujte odděleně. Počty celé dávky nenahrazují kontrolu jednotlivých položek.

Chybí šablona, odesílatel nebo správné vstupy

transactional_template_unpublished: vyberte publikovanou transakční revizi ve stejném projektu. Uložený koncept nestačí. transactional_sender_required: doplňte sender_profile_id nebo výchozí profil publikované šablony. Vstupy ověřte podle deklarace konkrétní verze a přes její náhled. Nové publikování samo neopravuje obsah už přijaté zprávy: ten je vázaný na původní revizi.

Expirace, zrušení a nejisté předání

transactional_expiry_invalid odmítá neplatné či příliš krátké nebo dlouhé expires_at; řiďte se konkrétní mezí v fields. Zpráva, která vyprší ve frontě, se po obnovení pauzy automaticky neodešle. Nové odeslání je nové vědomé rozhodnutí, nikoli bezpečné opakování původní operace.

Zrušení integrace zneplatní její klíče a ruší čekající práci před předáním. Již zahájené nebo nejisté předání nelze považovat za odvolané. Při nejistém výsledku nevytvářejte náhradní zprávu naslepo: ověřte detail a události, případně předejte ID podpoře. Nejisté předání se automaticky neopakuje. Zrušenou integraci nelze obnovit.

Jednu čekající zprávu zrušíte přes POST /transactional/messages/{messageId}/cancel, celou rozesílku přes POST /transactional/requests/control s action: cancel. 409 transactional_cancel_not_possible znamená, že předání SES už začalo: zprávu považujte za odeslanou a výsledek sledujte v detailu. Zrušení nikdy neruší už doručený e-mail.

Mezitím někdo upravil stejný objekt: 409

U operací s expectedVersion nebo expected_version načtěte aktuální objekt a znovu vyhodnoťte změnu. Nepřepisujte novější obsah slepým opakováním staré verze. Pro upravené tělo použijte nový klíč opakování; nezaměňujte tento konflikt s idempotency_conflict.

Webhook nedorazil, přišel vícekrát nebo chybí tajemství

Nejdříve zkontrolujte seznam doručovacích pokusů a jejich HTTP výsledek. Váš endpoint musí být veřejně dostupný přes HTTPS, bez přesměrování na jinou adresu a bez soukromých či zakázaných síťových cílů. Ověřte podpis původního těla podle popisu webhooků; starší doručení používají původní verzi URL a tajemství.

Odpověď vašeho endpointu 2xx potvrzuje převzetí webhooku. U 408, 429, 5xx a chyby spojení se doručení omezeně opakuje, nejvýše šest pokusů celkem (provozovatel může přidělit méně). Ostatní HTTP chyby jsou konečné. Ukládejte event_id a opakované události zpracujte idempotentně. Výpadek webhooku nikdy sám neposílá další e-mail.

Po ztrátě odpovědi na vytvoření nebo rotaci opakování se stejným klíčem vrátí cíl bez tajemství (secret: null). Nevytvářejte duplicitní cíl; proveďte rotaci a bezpečně uložte nové tajemství. Ruční opakování doručení vyžaduje výslovné potvrzení a zachovává původní událost i přidělený limit pokusů.

Výsledek nebo kurzor už není dostupný: 410 / 404

event_cursor_expired vyžaduje nové čtení událostí a dorovnání podle zachovaných výsledků zpráv; starý kurzor neupravujte. transactional_detail_expired znamená konec dostupnosti detailu, po fyzickém odstranění může následovat 404. Lhůta detailu, událostí a idempotence jsou odlišné. Vypršení historie není důkaz, že zpráva nebyla odeslána.

Co předat podpoře

Uveďte čas včetně časového pásma, HTTP metodu a cestu, stav, code, request_id, ID integrace/projektu a dostupné ID zprávy nebo dávky. Přiložte anonymizovaný obsah fields, přijaté Retry-After a popis posledního úspěšného kroku. Neposílejte API klíč, podpisové tajemství webhooku ani celé personalizační vstupy. Při 503 respektujte vrácené Retry-After; při trvající nedostupnosti kontaktujte provozovatele místo neomezeného opakování.

Katalog chybových kódů

Každá položka uvádí známý kód, HTTP stav při odmítnutí, nápravu a pravidlo opakování. Kód vyhledejte vyhledáváním v záhlaví. Stejný seznam je ve stažitelném OpenAPI v x-error-catalog.

Rozsah odlišuje veřejné požadavky od správy přístupů v přihlášené aplikaci a následného zpracování. Sdílené doménové kontroly platí podle konkrétní operace, stavu a oprávnění; seznam nezpřístupňuje nové endpointy. U následného zpracování uvedený stav odpovídá bráně při přijetí, pokud je stejná kontrola prováděna synchronně; přijatá zpráva má svůj výsledek, nikoli dodatečnou HTTP chybu původního požadavku.

202 potvrzuje přijetí, nikoli doručení. Sledujte stav, důvod, pokusy a události zprávy. Nedoručení, stížnost, blokace, expirace a nejisté předání poskytovateli vyžadují různé postupy uvedené v řešení problémů. Cesta mimo zveřejněný základ API v1 může vrátit obecnou odpověď 404 mimo tento formát. Proxy, přerušené spojení nebo nedostupný server mohou vrátit neúplnou odpověď či jiný formát; klient musí zvládnout i chybu bez code. Rozšiřitelné pole code není uzavřený enum: neznámý kód zpracujte podle HTTP stavu, uchovejte request_id a při nejasném výsledku neposílejte zprávu znovu s novou identitou.

address_registry_blocked

Veřejné API · HTTP 409

Situace: Účinná ochrana příjemce blokuje odeslání.

Řešení: Ověřte důvod ve výsledku zprávy a kontrole blokací. Trvalé nedoručení, stížnost ani zákaz neobcházejte novým kontaktem či klíčem.

Opakování: Blokovanému příjemci automaticky neposílejte znovu.

admin_reauthentication_required

Správa API přístupu v aplikaci · HTTP 403

Situace: Pro změnu kapacity se znovu přihlaste.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

allowed_ips_conflict

Správa API přístupu v aplikaci · HTTP 409

Situace: Povolené adresy mezitím někdo změnil. Obnovte integraci a změnu zopakujte.

Řešení: Načtěte aktuální detail, readiness a povolené akce příslušného objektu. Rozlište rozpracovaný, již ukončený a změněný stav; při trvajícím konfliktu předejte code a request_id podpoře.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

api_admission_revoked

Veřejné API · HTTP 403

Situace: Aktuální role, členství nebo stav přístupu operaci nepovolují.

Řešení: Vlastník zkontroluje roli zakladatele, ověření e-mailu, členství a stav organizace, projektu i integrace. Nový klíč stejné integrace nemusí pomoci.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

api_key_expired

Veřejné API · HTTP 401

Situace: Chybí platný strojový přístup, klíč byl zrušený nebo mu skončila platnost.

Řešení: Ověřte Authorization: Bearer, správnou integraci a platnost klíče. Vlastník nebo administrátor jej nahradí; klíč neposílejte v URL ani podpoře.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

api_plan_required

Veřejné API · HTTP 403

Situace: Tarif organizace nemá funkci API a integrace.

Řešení: Vlastník organizace přejde na tarif, který API obsahuje (v aplikaci Nastavení organizace → Tarif a fakturace). Klíč zůstává platný a po změně tarifu začne fungovat bez výměny.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

audience_member_ineligible_at_snapshot

Veřejné API · HTTP 409

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

audience_snapshot_unavailable

Veřejné API · HTTP 409

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_block_idempotency_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný klíč nebo identita operace označují jiný vstup.

Řešení: Dohledejte původní výsledek. Pro opakování vraťte přesně původní metodu, cestu a tělo; změněný záměr oddělte novým klíčem až po vyjasnění původního.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_block_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_block_limit_reached

Sdílená doménová kontrola · HTTP 409

Situace: Byla dosažena kapacita operace nebo objektů.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_block_mutation_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_block_name_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný název nebo identita už v daném rozsahu existují.

Řešení: Vyhledejte existující objekt a podle záměru jej použijte nebo upravte s aktuální verzí. Pro nový objekt zvolte odlišnou identitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_block_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_block_version_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_dry_run_capability_required

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_observation_already_active

Sdílená doménová kontrola · HTTP 409

Situace: Automatizace už má aktivní sledování.

Řešení: Načtěte současné sledování a použijte jeho ID. Nový start není potřebný; změnu nebo ukončení proveďte podporovanou akcí nad aktuální revizí.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_observation_baseline_timeout

Sdílená doménová kontrola · HTTP 503

Situace: Potřebný runtime, klíč nebo výpočet není nyní dostupný.

Řešení: Respektujte Retry-After a předejte podpoře čas, code a request_id. Provozovatel ověří službu, routování událostí a klíče; tajemství neposílejte. U časového limitu zmenšete požadovaný rozsah.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

automation_observation_baseline_too_large

Sdílená doménová kontrola · HTTP 409

Situace: Byla dosažena kapacita operace nebo objektů.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_observation_capability_required

Sdílená doménová kontrola · HTTP 503

Situace: Potřebná služba nebo podklad nejsou nyní dostupné.

Řešení: Respektujte Retry-After a načtěte aktuální stav původního požadavku. Při trvajícím selhání předejte code a request_id podpoře; znovu založený objekt ani klíč výpadek služby neřeší.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

automation_observation_history_limit

Sdílená doménová kontrola · HTTP 409

Situace: Byla dosažena kapacita operace nebo objektů.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_observation_idempotency_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný klíč nebo identita operace označují jiný vstup.

Řešení: Dohledejte původní výsledek. Pro opakování vraťte přesně původní metodu, cestu a tělo; změněný záměr oddělte novým klíčem až po vyjasnění původního.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_observation_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_observation_lifecycle_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Potřebná služba nebo podklad nejsou nyní dostupné.

Řešení: Respektujte Retry-After a načtěte aktuální stav původního požadavku. Při trvajícím selhání předejte code a request_id podpoře; znovu založený objekt ani klíč výpadek služby neřeší.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

automation_observation_mutation_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_observation_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_observation_revision_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_observation_runtime_disabled

Sdílená doménová kontrola · HTTP 503

Situace: Potřebný runtime, klíč nebo výpočet není nyní dostupný.

Řešení: Respektujte Retry-After a předejte podpoře čas, code a request_id. Provozovatel ověří službu, routování událostí a klíče; tajemství neposílejte. U časového limitu zmenšete požadovaný rozsah.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

automation_observation_worker_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Potřebný runtime, klíč nebo výpočet není nyní dostupný.

Řešení: Respektujte Retry-After a předejte podpoře čas, code a request_id. Provozovatel ověří službu, routování událostí a klíče; tajemství neposílejte. U časového limitu zmenšete požadovaný rozsah.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

automation_observation_workspace_limit

Sdílená doménová kontrola · HTTP 409

Situace: Aktuální provozní nebo tarifní brána odeslání nepovoluje.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

automation_workflow_graph_simulation_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_workflow_graph_v3_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_workflow_idempotency_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný klíč nebo identita operace označují jiný vstup.

Řešení: Dohledejte původní výsledek. Pro opakování vraťte přesně původní metodu, cestu a tělo; změněný záměr oddělte novým klíčem až po vyjasnění původního.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_workflow_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_workflow_mutation_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_workflow_name_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný název nebo identita už v daném rozsahu existují.

Řešení: Vyhledejte existující objekt a podle záměru jej použijte nebo upravte s aktuální verzí. Pro nový objekt zvolte odlišnou identitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_workflow_no_change

Sdílená doménová kontrola · HTTP 409

Situace: Navržené uložení se neliší od aktuálního obsahu.

Řešení: Použijte současnou revizi. Pokud jste změnu zamýšleli, porovnejte načtený koncept a odesílaná pole; nový požadavek vytvořte až pro skutečně změněný obsah.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_workflow_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_workflow_observation_active

Sdílená doménová kontrola · HTTP 409

Situace: Aktuální stav objektu nesplňuje předpoklady operace.

Řešení: Načtěte aktuální detail, readiness a povolené akce příslušného objektu. Rozlište rozpracovaný, již ukončený a změněný stav; při trvajícím konfliktu předejte code a request_id podpoře.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_workflow_simulation_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

automation_workflow_version_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_ab_variant_ledger_contract_mismatch

Sdílená doménová kontrola · HTTP 409

Situace: Podklady A/B variant neodpovídají evidenci zpráv.

Řešení: Zastavte přípravu a předejte ID kampaně a request_id podpoře. Provozovatel musí ověřit integritu variant a evidence; nekopírujte kampaň za účelem vynucení odeslání.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_active_snapshot_limit

Sdílená doménová kontrola · HTTP 409

Situace: Byla dosažena kapacita operace nebo objektů.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_approval_already_decided

Sdílená doménová kontrola · HTTP 409

Situace: Schvalovací pravidla nebo podmínky přípravy kampaně nejsou splněné.

Řešení: Načtěte readiness a historii schválení. Ověřte režim, oprávněného schvalovatele a aktuální neměnné podklady. Změněný obsah potřebuje nové potvrzení; přísný režim nelze obejít běžným dokončením přípravy.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_approval_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Schvalovací pravidla nebo podmínky přípravy kampaně nejsou splněné.

Řešení: Načtěte readiness a historii schválení. Ověřte režim, oprávněného schvalovatele a aktuální neměnné podklady. Změněný obsah potřebuje nové potvrzení; přísný režim nelze obejít běžným dokončením přípravy.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_approval_governance_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Schvalovací pravidla nebo podmínky přípravy kampaně nejsou splněné.

Řešení: Načtěte readiness a historii schválení. Ověřte režim, oprávněného schvalovatele a aktuální neměnné podklady. Změněný obsah potřebuje nové potvrzení; přísný režim nelze obejít běžným dokončením přípravy.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_approval_prerequisite_not_ready

Sdílená doménová kontrola · HTTP 409

Situace: Schvalovací pravidla nebo podmínky přípravy kampaně nejsou splněné.

Řešení: Načtěte readiness a historii schválení. Ověřte režim, oprávněného schvalovatele a aktuální neměnné podklady. Změněný obsah potřebuje nové potvrzení; přísný režim nelze obejít běžným dokončením přípravy.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_approval_request_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Schvalovací pravidla nebo podmínky přípravy kampaně nejsou splněné.

Řešení: Načtěte readiness a historii schválení. Ověřte režim, oprávněného schvalovatele a aktuální neměnné podklady. Změněný obsah potřebuje nové potvrzení; přísný režim nelze obejít běžným dokončením přípravy.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_approval_required

Veřejné API · HTTP 409

Situace: Schvalovací pravidla nebo podmínky přípravy kampaně nejsou splněné.

Řešení: Načtěte readiness a historii schválení. Ověřte režim, oprávněného schvalovatele a aktuální neměnné podklady. Změněný obsah potřebuje nové potvrzení; přísný režim nelze obejít běžným dokončením přípravy.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_approval_self_decision_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Schvalovací pravidla nebo podmínky přípravy kampaně nejsou splněné.

Řešení: Načtěte readiness a historii schválení. Ověřte režim, oprávněného schvalovatele a aktuální neměnné podklady. Změněný obsah potřebuje nové potvrzení; přísný režim nelze obejít běžným dokončením přípravy.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_archive_blocked

Sdílená doménová kontrola · HTTP 409

Situace: Stav nebo vazby objektu nepovolují změnu, archivaci či odstranění.

Řešení: Ověřte aktivní schválení, dispatch a navazující použití. Použijte jen nabízenou akci zrušení před zahájením; systémové či publikované objekty nepřepisujte násilím.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_archive_mutation_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Stav nebo vazby objektu nepovolují změnu, archivaci či odstranění.

Řešení: Ověřte aktivní schválení, dispatch a navazující použití. Použijte jen nabízenou akci zrušení před zahájením; systémové či publikované objekty nepřepisujte násilím.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_archive_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_archive_revision_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_audience_definition_unsupported

Sdílená doménová kontrola · HTTP 409

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_audience_list_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_audience_refresh_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_audience_refresh_dispatch_active

Sdílená doménová kontrola · HTTP 409

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_audience_refresh_in_progress

Sdílená doménová kontrola · HTTP 409

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_audience_refresh_mutation_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_audience_segment_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_audience_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_bulk_mutation_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_bulk_selection_changed

Sdílená doménová kontrola · HTTP 409

Situace: Aktuální stav objektu nesplňuje předpoklady operace.

Řešení: Načtěte aktuální detail, readiness a povolené akce příslušného objektu. Rozlište rozpracovaný, již ukončený a změněný stav; při trvajícím konfliktu předejte code a request_id podpoře.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_bulk_selection_size_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_catalog_filter_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_content_capability_required

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_content_draft_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_content_draft_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_content_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_content_media_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Zdrojový obsah, šablona nebo používaný obrázek nejsou dostupné.

Řešení: Načtěte zdroj ve stejném projektu, ověřte jeho aktuální stav a dostupnost všech použitých souborů. Zvolte existující podporovaný zdroj, znovu vytvořte náhled a potvrďte aktualizované podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_content_review_quality_required

Sdílená doménová kontrola · HTTP 409

Situace: Potvrzení se nevztahuje k aktuálním podkladům kampaně.

Řešení: Znovu načtěte readiness a delivery-readiness. Použijte aktuální reviewPackage.id a expectedSourceInputHash o 64 malých hexadecimálních znacích; v běžném režimu dokončete přípravu, v přísném nové schválení.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_content_review_version_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_delete_blocked

Sdílená doménová kontrola · HTTP 409

Situace: Stav nebo vazby objektu nepovolují změnu, archivaci či odstranění.

Řešení: Ověřte aktivní schválení, dispatch a navazující použití. Použijte jen nabízenou akci zrušení před zahájením; systémové či publikované objekty nepřepisujte násilím.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_delivery_plan_already_decided

Sdílená doménová kontrola · HTTP 409

Situace: Aktuální provozní nebo tarifní brána odeslání nepovoluje.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

campaign_delivery_plan_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Aktuální provozní nebo tarifní brána odeslání nepovoluje.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

campaign_delivery_plan_mutation_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Aktuální provozní nebo tarifní brána odeslání nepovoluje.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

campaign_delivery_plan_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Aktuální provozní nebo tarifní brána odeslání nepovoluje.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

campaign_delivery_plan_prerequisite_not_ready

Sdílená doménová kontrola · HTTP 409

Situace: Aktuální provozní nebo tarifní brána odeslání nepovoluje.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

campaign_delivery_plan_self_decision_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Aktuální provozní nebo tarifní brána odeslání nepovoluje.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

campaign_delivery_plan_timing_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Navržený čas nebo rozložení odesílání nejsou přípustné.

Řešení: Zkontrolujte budoucí termín, časové pásmo a odmítnutí neexistujícího či nejednoznačného místního času. Stejný schedule_out_of_range může mít při zařazení 409 a při přeplánování 422.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_delivery_plan_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Aktuální provozní nebo tarifní brána odeslání nepovoluje.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

campaign_dispatch_approval_not_current

Veřejné API · HTTP 409

Situace: Potvrzení se nevztahuje k aktuálním podkladům kampaně.

Řešení: Znovu načtěte readiness a delivery-readiness. Použijte aktuální reviewPackage.id a expectedSourceInputHash o 64 malých hexadecimálních znacích; v běžném režimu dokončete přípravu, v přísném nové schválení.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_audience_empty

Veřejné API · HTTP 409

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_audience_invalid

Veřejné API · HTTP 409

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_audience_not_ready

Veřejné API · HTTP 409

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_campaign_not_found

Veřejné API · HTTP 404

Situace: Současné podmínky neumožňují zařazení kampaně.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_campaign_paused

Veřejné API · HTTP 409

Situace: Kampaň byla pozastavena operátorem.

Řešení: Načtěte aktuální stav kampaně a obnovte rozesílku v jejím detailu; nový požadavek pauzu neobchází.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_campaign_stopped

Veřejné API · HTTP 409

Situace: Zbývající rozesílka byla nevratně ukončena.

Řešení: Neopakujte požadavek jako pokus o obnovení; pro novou rozesílku vytvořte samostatnou kampaň.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_confirmation_required

Veřejné API · HTTP 409

Situace: Potvrzení se nevztahuje k aktuálním podkladům kampaně.

Řešení: Znovu načtěte readiness a delivery-readiness. Použijte aktuální reviewPackage.id a expectedSourceInputHash o 64 malých hexadecimálních znacích; v běžném režimu dokončete přípravu, v přísném nové schválení.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_delivery_plan_unavailable

Veřejné API · HTTP 409

Situace: Doručovací plán kampaně nejde nyní připravit. Důvody jsou ve fields.blocked_by.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

campaign_dispatch_idempotency_conflict

Veřejné API · HTTP 409

Situace: Stejný klíč nebo identita operace označují jiný vstup.

Řešení: Dohledejte původní výsledek. Pro opakování vraťte přesně původní metodu, cestu a tělo; změněný záměr oddělte novým klíčem až po vyjasnění původního.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_not_cancellable

Veřejné API · HTTP 409

Situace: Příprava nebo předání už začaly, případně je požadavek ukončený.

Řešení: Načtěte aktuální stav a povolené akce. Zrušení či přeplánování nelze vynutit nad rozpracovaným nebo již předaným požadavkem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_not_found

Veřejné API · HTTP 404

Situace: Požadavek nyní nelze přeplánovat. Ověřte současný stav a přípustný termín.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_not_reschedulable

Veřejné API · HTTP 409

Situace: Příprava nebo předání už začaly, případně je požadavek ukončený.

Řešení: Načtěte aktuální stav a povolené akce. Zrušení či přeplánování nelze vynutit nad rozpracovaným nebo již předaným požadavkem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_schedule_local_time_invalid

Veřejné API · HTTP 422

Situace: Navržený čas nebo rozložení odesílání nejsou přípustné.

Řešení: Zkontrolujte budoucí termín, časové pásmo a odmítnutí neexistujícího či nejednoznačného místního času. Stejný schedule_out_of_range může mít při zařazení 409 a při přeplánování 422.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_schedule_out_of_range

Veřejné API · HTTP 409, 422

Situace: Navržený čas nebo rozložení odesílání nejsou přípustné.

Řešení: Zkontrolujte budoucí termín, časové pásmo a odmítnutí neexistujícího či nejednoznačného místního času. Stejný schedule_out_of_range může mít při zařazení 409 a při přeplánování 422.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dispatch_source_changed

Sdílená doménová kontrola · HTTP 409

Situace: Potvrzení se nevztahuje k aktuálním podkladům kampaně.

Řešení: Znovu načtěte readiness a delivery-readiness. Použijte aktuální reviewPackage.id a expectedSourceInputHash o 64 malých hexadecimálních znacích; v běžném režimu dokončete přípravu, v přísném nové schválení.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_dry_run_capability_required

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_draft_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_idempotency_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný klíč nebo identita operace označují jiný vstup.

Řešení: Dohledejte původní výsledek. Pro opakování vraťte přesně původní metodu, cestu a tělo; změněný záměr oddělte novým klíčem až po vyjasnění původního.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_limit_reached

Sdílená doménová kontrola · HTTP 409

Situace: Byla dosažena kapacita operace nebo objektů.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_metadata_revision_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_metadata_revision_required

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_mutation_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_name_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný název nebo identita už v daném rozsahu existují.

Řešení: Vyhledejte existující objekt a podle záměru jej použijte nebo upravte s aktuální verzí. Pro nový objekt zvolte odlišnou identitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_no_change

Sdílená doménová kontrola · HTTP 409

Situace: Navržené uložení se neliší od aktuálního obsahu.

Řešení: Použijte současnou revizi. Pokud jste změnu zamýšleli, porovnejte načtený koncept a odesílaná pole; nový požadavek vytvořte až pro skutečně změněný obsah.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_preview_unavailable

Sdílená doménová kontrola · HTTP 422

Situace: Náhled se nepodařilo sestavit. Zkontrolujte obsah a délky vstupních polí.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_published_delete

Sdílená doménová kontrola · HTTP 409

Situace: Stav nebo vazby objektu nepovolují změnu, archivaci či odstranění.

Řešení: Ověřte aktivní schválení, dispatch a navazující použití. Použijte jen nabízenou akci zrušení před zahájením; systémové či publikované objekty nepřepisujte násilím.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_restore_source_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_email_template_version_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_governance_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_governance_permission_required

Sdílená doménová kontrola · HTTP 409

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_governance_support_context_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_governance_validation_error

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_governance_version_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_idempotency_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný klíč nebo identita operace označují jiný vstup.

Řešení: Dohledejte původní výsledek. Pro opakování vraťte přesně původní metodu, cestu a tělo; změněný záměr oddělte novým klíčem až po vyjasnění původního.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_name_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný název nebo identita už v daném rozsahu existují.

Řešení: Vyhledejte existující objekt a podle záměru jej použijte nebo upravte s aktuální verzí. Pro nový objekt zvolte odlišnou identitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_rename_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný název nebo identita už v daném rozsahu existují.

Řešení: Vyhledejte existující objekt a podle záměru jej použijte nebo upravte s aktuální verzí. Pro nový objekt zvolte odlišnou identitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_rename_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

Správa API přístupu v aplikaci · HTTP 404

Situace: Tento odkaz kampaň neměřila. Obnovte stránku a vyberte odkaz znovu.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_results_list_unmeasured

Sdílená doménová kontrola · HTTP 409, 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_rename_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_review_package_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Potvrzení se nevztahuje k aktuálním podkladům kampaně.

Řešení: Znovu načtěte readiness a delivery-readiness. Použijte aktuální reviewPackage.id a expectedSourceInputHash o 64 malých hexadecimálních znacích; v běžném režimu dokončete přípravu, v přísném nové schválení.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_review_package_prerequisite_not_ready

Sdílená doménová kontrola · HTTP 409

Situace: Potvrzení se nevztahuje k aktuálním podkladům kampaně.

Řešení: Znovu načtěte readiness a delivery-readiness. Použijte aktuální reviewPackage.id a expectedSourceInputHash o 64 malých hexadecimálních znacích; v běžném režimu dokončete přípravu, v přísném nové schválení.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_saved_section_idempotency_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný klíč nebo identita operace označují jiný vstup.

Řešení: Dohledejte původní výsledek. Pro opakování vraťte přesně původní metodu, cestu a tělo; změněný záměr oddělte novým klíčem až po vyjasnění původního.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_saved_section_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_saved_section_limit_reached

Sdílená doménová kontrola · HTTP 409

Situace: Byla dosažena kapacita operace nebo objektů.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_saved_section_name_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný název nebo identita už v daném rozsahu existují.

Řešení: Vyhledejte existující objekt a podle záměru jej použijte nebo upravte s aktuální verzí. Pro nový objekt zvolte odlišnou identitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_saved_section_no_change

Sdílená doménová kontrola · HTTP 409

Situace: Navržené uložení se neliší od aktuálního obsahu.

Řešení: Použijte současnou revizi. Pokud jste změnu zamýšleli, porovnejte načtený koncept a odesílaná pole; nový požadavek vytvořte až pro skutečně změněný obsah.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_saved_section_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_saved_section_version_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_sender_profile_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Odesílatel, ověřená doména nebo odesílací cesta nejsou připravené.

Řešení: Zkontrolujte sender_profile_id, projekt, připravenost odesílatele, DNS a stav odesílací cesty. Chybné či změněné nastavení řeší vlastník nebo podpora; připravenost neobcházejte.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

campaign_sender_selection_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Odesílatel, ověřená doména nebo odesílací cesta nejsou připravené.

Řešení: Zkontrolujte sender_profile_id, projekt, připravenost odesílatele, DNS a stav odesílací cesty. Chybné či změněné nastavení řeší vlastník nebo podpora; připravenost neobcházejte.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

campaign_sender_selection_support_context_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_source_campaign_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Zdrojový obsah, šablona nebo používaný obrázek nejsou dostupné.

Řešení: Načtěte zdroj ve stejném projektu, ověřte jeho aktuální stav a dostupnost všech použitých souborů. Zvolte existující podporovaný zdroj, znovu vytvořte náhled a potvrďte aktualizované podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_source_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_source_template_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Zdrojový obsah, šablona nebo používaný obrázek nejsou dostupné.

Řešení: Načtěte zdroj ve stejném projektu, ověřte jeho aktuální stav a dostupnost všech použitých souborů. Zvolte existující podporovaný zdroj, znovu vytvořte náhled a potvrďte aktualizované podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_standard_preparation_mode_required

Sdílená doménová kontrola · HTTP 409

Situace: Kampaň vyžaduje přísný režim schválení.

Řešení: Dokončení běžné přípravy nenahrazuje schválení oprávněnou druhou osobou. Načtěte readiness a review-history a projděte požadovaný schvalovací postup.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_standard_preparation_support_context_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_tag_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_tag_mutation_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_tag_parent_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_tag_revision_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_test_email_direct_access_required

Sdílená doménová kontrola · HTTP 409

Situace: Ruční test kampaně nemá použitelnou rezervaci nebo přímý oprávněný přístup.

Řešení: Ruční test otevřete ve vlastním přihlášeném účtu s právem spravovat kampaň a načtěte stav původní rezervace. Support ani veřejný klíč nepoužívejte jako náhradu přímého potvrzení; při nejistém výsledku nezakládejte další test.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_test_email_ledger_direct_access_required

Sdílená doménová kontrola · HTTP 409

Situace: Ruční test kampaně nemá použitelnou rezervaci nebo přímý oprávněný přístup.

Řešení: Ruční test otevřete ve vlastním přihlášeném účtu s právem spravovat kampaň a načtěte stav původní rezervace. Support ani veřejný klíč nepoužívejte jako náhradu přímého potvrzení; při nejistém výsledku nezakládejte další test.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_test_email_ledger_input_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Ruční test kampaně nemá použitelnou rezervaci nebo přímý oprávněný přístup.

Řešení: Ruční test otevřete ve vlastním přihlášeném účtu s právem spravovat kampaň a načtěte stav původní rezervace. Support ani veřejný klíč nepoužívejte jako náhradu přímého potvrzení; při nejistém výsledku nezakládejte další test.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_test_email_quota_exceeded

Sdílená doménová kontrola · HTTP 409

Situace: Ruční test kampaně nemá použitelnou rezervaci nebo přímý oprávněný přístup.

Řešení: Ruční test otevřete ve vlastním přihlášeném účtu s právem spravovat kampaň a načtěte stav původní rezervace. Support ani veřejný klíč nepoužívejte jako náhradu přímého potvrzení; při nejistém výsledku nezakládejte další test.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_test_email_reservation_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Ruční test kampaně nemá použitelnou rezervaci nebo přímý oprávněný přístup.

Řešení: Ruční test otevřete ve vlastním přihlášeném účtu s právem spravovat kampaň a načtěte stav původní rezervace. Support ani veřejný klíč nepoužívejte jako náhradu přímého potvrzení; při nejistém výsledku nezakládejte další test.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_test_email_reservation_idempotency_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný klíč nebo identita operace označují jiný vstup.

Řešení: Dohledejte původní výsledek. Pro opakování vraťte přesně původní metodu, cestu a tělo; změněný záměr oddělte novým klíčem až po vyjasnění původního.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_test_email_reservation_input_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Ruční test kampaně nemá použitelnou rezervaci nebo přímý oprávněný přístup.

Řešení: Ruční test otevřete ve vlastním přihlášeném účtu s právem spravovat kampaň a načtěte stav původní rezervace. Support ani veřejný klíč nepoužívejte jako náhradu přímého potvrzení; při nejistém výsledku nezakládejte další test.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_test_email_reservation_not_executable

Sdílená doménová kontrola · HTTP 409

Situace: Ruční test kampaně nemá použitelnou rezervaci nebo přímý oprávněný přístup.

Řešení: Ruční test otevřete ve vlastním přihlášeném účtu s právem spravovat kampaň a načtěte stav původní rezervace. Support ani veřejný klíč nepoužívejte jako náhradu přímého potvrzení; při nejistém výsledku nezakládejte další test.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_test_email_reservation_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Ruční test kampaně nemá použitelnou rezervaci nebo přímý oprávněný přístup.

Řešení: Ruční test otevřete ve vlastním přihlášeném účtu s právem spravovat kampaň a načtěte stav původní rezervace. Support ani veřejný klíč nepoužívejte jako náhradu přímého potvrzení; při nejistém výsledku nezakládejte další test.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_test_email_support_recipient_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Ruční test kampaně nemá použitelnou rezervaci nebo přímý oprávněný přístup.

Řešení: Ruční test otevřete ve vlastním přihlášeném účtu s právem spravovat kampaň a načtěte stav původní rezervace. Support ani veřejný klíč nepoužívejte jako náhradu přímého potvrzení; při nejistém výsledku nezakládejte další test.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

campaign_transactional_inputs_invalid

Veřejné API · HTTP 422

Situace: Zkontrolujte vstupní pole transakční šablony.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

capacity_version_conflict

Správa API přístupu v aplikaci · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_attestation_required

Veřejné API · HTTP 422

Situace: Potvrďte adresy a oprávněné zpracování kontaktů.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_audience_tag_merge_same_tag

Správa API přístupu v aplikaci · HTTP 409, 422

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_batch_too_large

Veřejné API · HTTP 422

Situace: POST /contacts/bulk dostal víc než 1 000 kontaktů. Nic nebylo přijato.

Řešení: Rozdělte kontakty do více požadavků po nejvýše 1 000, každý s vlastním Idempotency-Key. Postup pro desítky a stovky tisíc kontaktů popisuje kapitola Hromadné nahrání kontaktů.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

contact_audience_tag_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_audience_tag_name_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_audience_tag_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_audience_tag_parent_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_audience_tag_revision_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Publikum kampaně nebo jeho podklad nejsou použitelné.

Řešení: Načtěte readiness a aktuální publikum. Vyčkejte dopočtu, opravte skupinu či segment a ověřte skutečně oprávněné příjemce. Při aktivním dispatch neměňte jeho podklady.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

Sdílená doménová kontrola · HTTP 409

Situace: Chybí výslovné potvrzení oprávnění přihlásit kontakty k odběru.

Řešení: Před potvrzením hromadného přihlášení ověřte souhlas kontaktů a odešlete consentConfirmed: true. Bez doloženého souhlasu operaci nepotvrzujte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_bulk_operation_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Podklady, oprávnění nebo identita hromadné operace se změnily.

Řešení: Načtěte stav původní operace a aktuální náhled se stejným výběrem kontaktů. Ověřte oprávnění a dostupnost cílového odběru. Jiný rozsah či obsah musí mít novou identitu až po vyjasnění původního výsledku.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_bulk_permission_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Podklady, oprávnění nebo identita hromadné operace se změnily.

Řešení: Načtěte stav původní operace a aktuální náhled se stejným výběrem kontaktů. Ověřte oprávnění a dostupnost cílového odběru. Jiný rozsah či obsah musí mít novou identitu až po vyjasnění původního výsledku.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_bulk_permission_key_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Podklady, oprávnění nebo identita hromadné operace se změnily.

Řešení: Načtěte stav původní operace a aktuální náhled se stejným výběrem kontaktů. Ověřte oprávnění a dostupnost cílového odběru. Jiný rozsah či obsah musí mít novou identitu až po vyjasnění původního výsledku.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_bulk_permission_limit

Sdílená doménová kontrola · HTTP 409

Situace: Podklady, oprávnění nebo identita hromadné operace se změnily.

Řešení: Načtěte stav původní operace a aktuální náhled se stejným výběrem kontaktů. Ověřte oprávnění a dostupnost cílového odběru. Jiný rozsah či obsah musí mít novou identitu až po vyjasnění původního výsledku.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_bulk_preview_changed

Sdílená doménová kontrola · HTTP 409

Situace: Podklady, oprávnění nebo identita hromadné operace se změnily.

Řešení: Načtěte stav původní operace a aktuální náhled se stejným výběrem kontaktů. Ověřte oprávnění a dostupnost cílového odběru. Jiný rozsah či obsah musí mít novou identitu až po vyjasnění původního výsledku.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_bulk_scope_too_large

Sdílená doménová kontrola · HTTP 409

Situace: Podklady, oprávnění nebo identita hromadné operace se změnily.

Řešení: Načtěte stav původní operace a aktuální náhled se stejným výběrem kontaktů. Ověřte oprávnění a dostupnost cílového odběru. Jiný rozsah či obsah musí mít novou identitu až po vyjasnění původního výsledku.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_bulk_subscription_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Podklady, oprávnění nebo identita hromadné operace se změnily.

Řešení: Načtěte stav původní operace a aktuální náhled se stejným výběrem kontaktů. Ověřte oprávnění a dostupnost cílového odběru. Jiný rozsah či obsah musí mít novou identitu až po vyjasnění původního výsledku.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_channel_invalid

Veřejné API · HTTP 409

Situace: Kontaktní kanál není platný, byl vyřazený nebo kontakt není dostupný.

Řešení: Načtěte aktuální kontakt a jeho kanály ve vlastním projektu. Vyřazenou či rizikovou adresu nepoužívejte pro nové odesílání; případnou změnu proveďte podporovanou úpravou kontaktu s oprávněním a doloženým původem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_channel_retired

Veřejné API · HTTP 409

Situace: Kontaktní kanál není platný, byl vyřazený nebo kontakt není dostupný.

Řešení: Načtěte aktuální kontakt a jeho kanály ve vlastním projektu. Vyřazenou či rizikovou adresu nepoužívejte pro nové odesílání; případnou změnu proveďte podporovanou úpravou kontaktu s oprávněním a doloženým původem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_crypto_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Potřebný runtime, klíč nebo výpočet není nyní dostupný.

Řešení: Respektujte Retry-After a předejte podpoře čas, code a request_id. Provozovatel ověří službu, routování událostí a klíče; tajemství neposílejte. U časového limitu zmenšete požadovaný rozsah.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

contact_export_background_support_forbidden

Správa API přístupu v aplikaci · HTTP 403

Situace: Podpora může exportovat jen okamžitě, nejvýše 5 000 kontaktů.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_export_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_export_job_not_found

Správa API přístupu v aplikaci · HTTP 404

Situace: Export v tomto projektu není.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_export_job_not_ready

Správa API přístupu v aplikaci · HTTP 409

Situace: Soubor exportu není k dispozici. Mohl vypršet, selhat nebo se ještě připravuje.

Řešení: Načtěte aktuální detail, readiness a povolené akce příslušného objektu. Rozlište rozpracovaný, již ukončený a změněný stav; při trvajícím konfliktu předejte code a request_id podpoře.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_export_jobs_busy

Správa API přístupu v aplikaci · HTTP 409, 429

Situace: V projektu se už připravují tři exporty. Počkejte, až některý doběhne.

Řešení: Načtěte aktuální detail, readiness a povolené akce příslušného objektu. Rozlište rozpracovaný, již ukončený a změněný stav; při trvajícím konfliktu předejte code a request_id podpoře.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_export_recipient_unavailable

Správa API přístupu v aplikaci · HTTP 409, 503

Situace: Nejdřív si ověřte e-mailovou adresu účtu.

Řešení: Respektujte Retry-After a načtěte aktuální stav původního požadavku. Při trvajícím selhání předejte code a request_id podpoře; znovu založený objekt ani klíč výpadek služby neřeší.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

contact_export_too_large

Sdílená doménová kontrola · HTTP 409

Situace: Byla dosažena kapacita operace nebo objektů.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_field_in_use

Sdílená doménová kontrola · HTTP 409

Situace: Pole používá segment, formulář nebo automatizace. Nejprve vyřešte vazby.

Řešení: Ověřte aktivní schválení, dispatch a navazující použití. Použijte jen nabízenou akci zrušení před zahájením; systémové či publikované objekty nepřepisujte násilím.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_field_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Vlastní pole nebo podklad segmentu neodpovídají aktuálním datům.

Řešení: Znovu načtěte katalog polí, typ a aktuální stav kontaktu či segmentu. Opravte konkrétní field a jeho hodnotu; při nedostupném dopočtu vyčkejte a znovu vytvořte náhled před zápisem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_field_filter_invalid

Správa API přístupu v aplikaci · HTTP 422

Situace: Filtr podle pole už neplatí. Vyberte jiné pole nebo upravte hodnotu.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_field_limit_reached

Sdílená doménová kontrola · HTTP 409

Situace: Byla dosažena kapacita operace nebo objektů.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_field_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_field_unknown

Veřejné API · HTTP 422

Situace: Neznámé vlastní pole. Nejprve je založte v projektu.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_field_validation_failed

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_field_version_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_identity_exists

Sdílená doménová kontrola · HTTP 409

Situace: Stejný název nebo identita už v daném rozsahu existují.

Řešení: Vyhledejte existující objekt a podle záměru jej použijte nebo upravte s aktuální verzí. Pro nový objekt zvolte odlišnou identitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_address_attestation_required

Veřejné API · HTTP 422

Situace: Zkontrolujte aktuální náhled a vstupy importu.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_ambiguous_headers

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_capability_required

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_commit_unavailable

Veřejné API · HTTP 503

Situace: Import je nyní nedostupný.

Řešení: Respektujte Retry-After a načtěte aktuální stav původního požadavku. Při trvajícím selhání předejte code a request_id podpoře; znovu založený objekt ani klíč výpadek služby neřeší.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

contact_import_custom_field_conflict

Veřejné API · HTTP 422

Situace: Zkontrolujte aktuální náhled a vstupy importu.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_custom_field_limit

Veřejné API · HTTP 422

Situace: Zkontrolujte aktuální náhled a vstupy importu.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_empty

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_evidence_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_idempotency_conflict

Veřejné API · HTTP 409

Situace: Stejný klíč nebo identita operace označují jiný vstup.

Řešení: Dohledejte původní výsledek. Pro opakování vraťte přesně původní metodu, cestu a tělo; změněný záměr oddělte novým klíčem až po vyjasnění původního.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_invalid_csv

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_invalid_mapping

Sdílená doménová kontrola · HTTP 422

Situace: Import nemá použitelný aktuální náhled, mapování nebo doložený původ dat.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_limit_exceeded

Sdílená doménová kontrola · HTTP 409

Situace: Byla dosažena kapacita operace nebo objektů.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_mapping_corrupt

Veřejné API · HTTP 422

Situace: Zkontrolujte aktuální náhled a vstupy importu.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_mapping_template_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Import nemá použitelný aktuální náhled, mapování nebo doložený původ dat.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_mapping_template_name_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Import nemá použitelný aktuální náhled, mapování nebo doložený původ dat.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_no_eligible_rows

Veřejné API · HTTP 422

Situace: Zkontrolujte aktuální náhled a vstupy importu.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_not_found

Veřejné API · HTTP 404

Situace: Import nebyl nalezen v povoleném projektu.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_policy_limit_exceeded

Sdílená doménová kontrola · HTTP 409

Situace: Byla dosažena kapacita operace nebo objektů.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_preview_expired_or_missing

Veřejné API · HTTP 422

Situace: Zkontrolujte aktuální náhled a vstupy importu.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_preview_mismatch

Veřejné API · HTTP 422

Situace: Zkontrolujte aktuální náhled a vstupy importu.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_preview_recount_mismatch

Veřejné API · HTTP 422

Situace: Zkontrolujte aktuální náhled a vstupy importu.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_privacy_attestation_required

Veřejné API · HTTP 422

Situace: Zkontrolujte aktuální náhled a vstupy importu.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_source_too_large

Veřejné API · HTTP 422

Situace: Zkontrolujte aktuální náhled a vstupy importu.

Řešení: Zkontrolujte fields a konkrétní konec kódu: preview_mismatch znamená jiný otisk souboru; expired_or_missing vyžaduje nový náhled; mapping a recount opakovanou kontrolu; source_too_large menší soubor; attestation doložení pravosti a oprávnění. Nepřihlašujte kontakty k odběru bez podkladu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_staging_unavailable

Veřejné API · HTTP 503

Situace: Import je nyní nedostupný.

Řešení: Respektujte Retry-After a načtěte aktuální stav původního požadavku. Při trvajícím selhání předejte code a request_id podpoře; znovu založený objekt ani klíč výpadek služby neřeší.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

contact_import_subscription_selection_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_target_list_invalid

Veřejné API · HTTP 422

Situace: Zkontrolujte výběr skupiny importu.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_target_list_name_conflict

Veřejné API · HTTP 409

Situace: Stejný název nebo identita už v daném rozsahu existují.

Řešení: Vyhledejte existující objekt a podle záměru jej použijte nebo upravte s aktuální verzí. Pro nový objekt zvolte odlišnou identitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_import_target_list_not_found

Veřejné API · HTTP 404

Situace: Zkontrolujte výběr skupiny importu.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_intake_invalid

Veřejné API · HTTP 422

Situace: Kontakt obsahuje neplatná data.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_lifecycle_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_move_preview_changed

Správa API přístupu v aplikaci · HTTP 409

Situace: Aktuální stav objektu nesplňuje předpoklady operace.

Řešení: Načtěte aktuální detail, readiness a povolené akce příslušného objektu. Rozlište rozpracovaný, již ukončený a změněný stav; při trvajícím konfliktu předejte code a request_id podpoře.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_move_scope_changed

Správa API přístupu v aplikaci · HTTP 409

Situace: Aktuální stav objektu nesplňuje předpoklady operace.

Řešení: Načtěte aktuální detail, readiness a povolené akce příslušného objektu. Rozlište rozpracovaný, již ukončený a změněný stav; při trvajícím konfliktu předejte code a request_id podpoře.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_move_target_unavailable

Správa API přístupu v aplikaci · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_permission_evidence_too_large

Sdílená doménová kontrola · HTTP 409

Situace: Byla dosažena kapacita operace nebo objektů.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

Sdílená doménová kontrola · HTTP 422

Situace: Odkaz na preference je neplatný, vypršel nebo jeho cíl není dostupný.

Řešení: Příjemce potřebuje aktuální odkaz pro správný kontakt a odběr. Token neupravujte ani nepřenášejte mezi adresami. Oprávněný správce ověří stav odběru; starý odkaz neobnovujte slepým opakováním.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_preference_target_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Odkaz na preference je neplatný, vypršel nebo jeho cíl není dostupný.

Řešení: Příjemce potřebuje aktuální odkaz pro správný kontakt a odběr. Token neupravujte ani nepřenášejte mezi adresami. Oprávněný správce ověří stav odběru; starý odkaz neobnovujte slepým opakováním.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_preference_token_crypto_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Potřebný runtime, klíč nebo výpočet není nyní dostupný.

Řešení: Respektujte Retry-After a předejte podpoře čas, code a request_id. Provozovatel ověří službu, routování událostí a klíče; tajemství neposílejte. U časového limitu zmenšete požadovaný rozsah.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

contact_preference_token_expired

Sdílená doménová kontrola · HTTP 409

Situace: Odkaz na preference je neplatný, vypršel nebo jeho cíl není dostupný.

Řešení: Příjemce potřebuje aktuální odkaz pro správný kontakt a odběr. Token neupravujte ani nepřenášejte mezi adresami. Oprávněný správce ověří stav odběru; starý odkaz neobnovujte slepým opakováním.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_preference_token_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Odkaz na preference je neplatný, vypršel nebo jeho cíl není dostupný.

Řešení: Příjemce potřebuje aktuální odkaz pro správný kontakt a odběr. Token neupravujte ani nepřenášejte mezi adresami. Oprávněný správce ověří stav odběru; starý odkaz neobnovujte slepým opakováním.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_profile_field_rejected

Sdílená doménová kontrola · HTTP 409

Situace: Vlastní pole nebo podklad segmentu neodpovídají aktuálním datům.

Řešení: Znovu načtěte katalog polí, typ a aktuální stav kontaktu či segmentu. Opravte konkrétní field a jeho hodnotu; při nedostupném dopočtu vyčkejte a znovu vytvořte náhled před zápisem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_profile_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_recipient_field_editable_without_visible

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_recipient_field_unknown

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_search_query_too_short

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_segment_contradiction

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_segment_custom_field_reference_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_segment_fact_unavailable

Sdílená doménová kontrola · HTTP 503

Situace: Vlastní pole nebo podklad segmentu neodpovídají aktuálním datům.

Řešení: Znovu načtěte katalog polí, typ a aktuální stav kontaktu či segmentu. Opravte konkrétní field a jeho hodnotu; při nedostupném dopočtu vyčkejte a znovu vytvořte náhled před zápisem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_segment_in_use

Sdílená doménová kontrola · HTTP 409

Situace: Stav nebo vazby objektu nepovolují změnu, archivaci či odstranění.

Řešení: Ověřte aktivní schválení, dispatch a navazující použití. Použijte jen nabízenou akci zrušení před zahájením; systémové či publikované objekty nepřepisujte násilím.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_segment_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

Správa API přístupu v aplikaci · HTTP 422

Situace: Vybraný odkaz kampaň neměří. Vyberte jiný odkaz nebo podmínku upravte.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_segment_match_summary_timed_out

Sdílená doménová kontrola · HTTP 503

Situace: Potřebný runtime, klíč nebo výpočet není nyní dostupný.

Řešení: Respektujte Retry-After a předejte podpoře čas, code a request_id. Provozovatel ověří službu, routování událostí a klíče; tajemství neposílejte. U časového limitu zmenšete požadovaný rozsah.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

contact_segment_name_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný název nebo identita už v daném rozsahu existují.

Řešení: Vyhledejte existující objekt a podle záměru jej použijte nebo upravte s aktuální verzí. Pro nový objekt zvolte odlišnou identitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_segment_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_segment_preview_timed_out

Sdílená doménová kontrola · HTTP 503

Situace: Potřebný runtime, klíč nebo výpočet není nyní dostupný.

Řešení: Respektujte Retry-After a předejte podpoře čas, code a request_id. Provozovatel ověří službu, routování událostí a klíče; tajemství neposílejte. U časového limitu zmenšete požadovaný rozsah.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

contact_segment_static_list_reference_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_segment_system_immutable

Sdílená doménová kontrola · HTTP 403

Situace: Stav nebo vazby objektu nepovolují změnu, archivaci či odstranění.

Řešení: Ověřte aktivní schválení, dispatch a navazující použití. Použijte jen nabízenou akci zrušení před zahájením; systémové či publikované objekty nepřepisujte násilím.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_segment_version_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_static_list_assignment_query_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_subscription_mode_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_subscription_mutation_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_subscription_operation_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný klíč nebo identita operace označují jiný vstup.

Řešení: Dohledejte původní výsledek. Pro opakování vraťte přesně původní metodu, cestu a tělo; změněný záměr oddělte novým klíčem až po vyjasnění původního.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_subscription_type_in_use

Sdílená doménová kontrola · HTTP 409

Situace: Stav nebo vazby objektu nepovolují změnu, archivaci či odstranění.

Řešení: Ověřte aktivní schválení, dispatch a navazující použití. Použijte jen nabízenou akci zrušení před zahájením; systémové či publikované objekty nepřepisujte násilím.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_subscription_type_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_subscription_type_is_default

Sdílená doménová kontrola · HTTP 409

Situace: Akce není povolená nad aktuálním výchozím typem odběru.

Řešení: Načtěte katalog odběrů a respektujte výchozí nebo systémový typ. Případnou změnu výchozího typu proveďte podporovanou správou; jeho vazby nemažte násilím.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_subscription_type_name_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný název nebo identita už v daném rozsahu existují.

Řešení: Vyhledejte existující objekt a podle záměru jej použijte nebo upravte s aktuální verzí. Pro nový objekt zvolte odlišnou identitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_subscription_type_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_suppression_release_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Současné oprávnění nebo ochranná pravidla operaci nepovolují.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_transfer_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_unavailable

Veřejné API · HTTP 409

Situace: Kontaktní kanál není platný, byl vyřazený nebo kontakt není dostupný.

Řešení: Načtěte aktuální kontakt a jeho kanály ve vlastním projektu. Vyřazenou či rizikovou adresu nepoužívejte pro nové odesílání; případnou změnu proveďte podporovanou úpravou kontaktu s oprávněním a doloženým původem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_version_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

contact_write_forbidden

Sdílená doménová kontrola · HTTP 403

Situace: Aktuální role, členství nebo stav přístupu operaci nepovolují.

Řešení: Vlastník zkontroluje roli zakladatele, ověření e-mailu, členství a stav organizace, projektu i integrace. Nový klíč stejné integrace nemusí pomoci.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

domain_not_verified

Veřejné API · HTTP 409

Situace: Vlastnictví odesílací domény není ověřené.

Řešení: V nastavení domény doplňte požadované DNS záznamy a vyčkejte ověření. Zkontrolujte také SES identitu, odesílatele a skutečnou připravenost; samotné založení domény nestačí.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

enrollment_unavailable

Veřejné API · HTTP 409

Situace: Tarif organizace není aktivní, proto odesílání není povolené.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

event_cursor_expired

Veřejné API · HTTP 410

Situace: Vypršela dostupnost detailu nebo kurzoru událostí.

Řešení: Začněte nové čtení událostí a dorovnejte jej podle vlastní evidence a zachovaných výsledků. Po odstranění dat může následovat 404; lhůty detailu a idempotence jsou různé.

Opakování: Expirace historie není důkaz neodeslání. Automaticky neposílejte náhradní e-mail.

event_ingest_not_ready

Veřejné API · HTTP 409

Situace: Příjem událostí SES není provozně připravený.

Řešení: Příjem zpráv přes API na tento stav nečeká, zpráva čeká ve frontě. Kód vrací ruční test v aplikaci. Provozovatel ověří příjem událostí, jejich přiřazení a stav zpracovatele. Bez spolehlivých výsledků nezvyšujte objem ani neobcházejte odesílací bránu.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

global_dispatch_disabled

Veřejné API · HTTP 409

Situace: Aktuální odesílací brány nepovolují transakční zprávu.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

idempotency_conflict

Veřejné API · HTTP 409

Situace: Stejný klíč nebo identita operace označují jiný vstup.

Řešení: Dohledejte původní výsledek. Pro opakování vraťte přesně původní metodu, cestu a tělo; změněný záměr oddělte novým klíčem až po vyjasnění původního.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

idempotency_key_invalid

Veřejné API · HTTP 422

Situace: Idempotency-Key obsahuje nepovolený znak (například mezeru nebo diakritiku) nebo má nepovolenou délku.

Řešení: Vygenerujte klíč jen z písmen bez diakritiky, číslic a znaků _ . : - o délce 8–128, například UUID. Požadavek nebyl přijat, nic nevzniklo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

idempotency_key_required

Veřejné API · HTTP 422

Situace: Chybí správný klíč bezpečného opakování.

Řešení: Přidejte Idempotency-Key o 8–128 znacích: písmena, číslice, podtržítko, tečka, dvojtečka a pomlčka. Jeden klíč označuje jednu nezměněnou operaci.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

idempotency_result_expired

Veřejné API · HTTP 409, 410

Situace: Známá operace už nemá dostupný výsledek; ochranný otisk ještě brání nové práci.

Řešení: Dohledejte ID zprávy nebo dávky, vlastní evidenci a případně podporu. HTTP 409 patří opakování zápisu, 410 může patřit dohledání výsledku ručního testu.

Opakování: Zastavte automatické opakování. Nevytvářejte nový klíč jen kvůli expiraci výsledku.

integration_manager_required

Správa API přístupu v aplikaci · HTTP 403

Situace: Aktuální role, členství nebo stav přístupu operaci nepovolují.

Řešení: Vlastník zkontroluje roli zakladatele, ověření e-mailu, členství a stav organizace, projektu i integrace. Nový klíč stejné integrace nemusí pomoci.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

integration_not_active

Veřejné API · HTTP 409

Situace: Integrace je zrušená nebo není aktivní.

Řešení: Ověřte životní cyklus integrace. Zrušenou integraci nelze obnovit. Čekající a již předané zprávy posuzujte samostatně; nový klíč starou práci neodvolá.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

integration_not_found

Správa API přístupu v aplikaci · HTTP 404

Situace: Integrace nebyla nalezena.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

integration_paused

Veřejné API · HTTP 409, 503

Situace: Integrace, projekt nebo požadavek jsou pozastavené.

Řešení: Zjistěte rozsah pauzy. Pauza integrace odmítá nové zápisy; pauza transakčního projektu může dál přijímat do fronty. Obnovení musí provést oprávněný správce. Platnost fronty dál běží.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

integration_permission_revoked

Veřejné API · HTTP 403

Situace: Aktuální role, členství nebo stav přístupu operaci nepovolují.

Řešení: Vlastník zkontroluje roli zakladatele, ověření e-mailu, členství a stav organizace, projektu i integrace. Nový klíč stejné integrace nemusí pomoci.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

integration_revoked

Správa API přístupu v aplikaci · HTTP 409

Situace: Integrace je zrušená nebo není aktivní.

Řešení: Ověřte životní cyklus integrace. Zrušenou integraci nelze obnovit. Čekající a již předané zprávy posuzujte samostatně; nový klíč starou práci neodvolá.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

internal_error

Veřejné API · HTTP 500

Situace: Server požadavek nedokončil nebo jej odmítl mimo konkrétní doménovou chybu.

Řešení: Použijte HTTP status, request_id a dostupné fields. Při 5xx či ztrátě spojení ověřte výsledek; odpověď proxy nemusí být JSON. Opravte metodu či Content-Type při 4xx, trvající selhání předejte podpoře.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

invalid_allowed_ips

Správa API přístupu v aplikaci · HTTP 422

Situace: Zadejte adresy IPv4 nebo IPv6, případně rozsah jako 203.0.113.0/24. Nejvýše 20 položek.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_api_key

Veřejné API · HTTP 401

Situace: Chybí platný strojový přístup, klíč byl zrušený nebo mu skončila platnost.

Řešení: Ověřte Authorization: Bearer, správnou integraci a platnost klíče. Vlastník nebo administrátor jej nahradí; klíč neposílejte v URL ani podpoře.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_capacity_change

Správa API přístupu v aplikaci · HTTP 422

Situace: Načtěte aktuální verzi kapacity a změnu zopakujte.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_capacity_limits

Správa API přístupu v aplikaci · HTTP 422

Situace: Limit je mimo povolený rozsah.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_changed_since

Veřejné API · HTTP 422

Situace: Neplatné datum změny.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_contact_email

Veřejné API · HTTP 422

Situace: Zadejte platnou e-mailovou adresu.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_event_cursor

Veřejné API · HTTP 422

Situace: Kurzor neodpovídá integraci, projektu nebo režimu.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_event_limit

Veřejné API · HTTP 422

Situace: Neplatná velikost stránky.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_key_expiry

Správa API přístupu v aplikaci · HTTP 422

Situace: Platnost klíče musí být v budoucnu, nejvýše 366 dnů.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_mode

Správa API přístupu v aplikaci · HTTP 422

Situace: Vyberte ostrý nebo testovací režim.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_name

Správa API přístupu v aplikaci · HTTP 422

Situace: Zadejte název integrace.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_pagination

Veřejné API · HTTP 422

Situace: Neplatná velikost stránky.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_receipt_windows

Správa API přístupu v aplikaci · HTTP 422

Situace: Ochranný otisk musí zůstat déle než samotný výsledek.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_result_period

Veřejné API · HTTP 422

Situace: Konec období musí následovat po začátku.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_result_recipient

Veřejné API · HTTP 422

Situace: Neplatná adresa filtru.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_retention_change

Správa API přístupu v aplikaci · HTTP 422

Situace: Zadejte lhůtu v rozsahu 30 až 36500 dní.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_scopes

Správa API přístupu v aplikaci · HTTP 422

Situace: Vyberte platná oprávnění.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_webhook_events

Veřejné API · HTTP 422

Situace: Vyberte podporované jedinečné typy událostí.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_webhook_name

Veřejné API · HTTP 422

Situace: Zadejte název webhooku.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_webhook_state

Veřejné API · HTTP 422

Situace: Vyberte stav webhooku.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

invalid_webhook_url

Veřejné API · HTTP 422

Situace: Adresa webhooku nesplňuje pravidla veřejného HTTPS cíle nebo ji nelze bezpečně přeložit.

Řešení: Použijte veřejný HTTPS endpoint bez přesměrování a privátních síťových adres. Opravte DNS a dostupnost; nevypínejte ověřování TLS ani ochranu proti SSRF.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

ip_not_allowed

Veřejné API · HTTP 403

Situace: Požadavek přišel z adresy, která není v seznamu povolených IP adres integrace.

Řešení: Volejte API z povolené adresy, nebo ať vlastník či administrátor adresu doplní (v aplikaci API a integrace → integrace → Povolené IP adresy). Klíč zůstává platný.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

key_not_found

Správa API přístupu v aplikaci · HTTP 404

Situace: Klíč nebyl nalezen.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

load_test_key_restricted

Veřejné API · HTTP 403

Situace: Klíč zátěžového testu smí jen odeslat transakční zprávu.

Řešení: Klíč zátěžového testu vytváří a ruší aplikace sama pro noční běh na adresy simulátoru Amazon SES. Klientská integrace takový klíč nikdy nedostane; vlastní požadavky posílejte svým klíčem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

load_test_outside_night

Veřejné API · HTTP 403

Situace: Klíč zátěžového testu odesílá jen od 22:00 do 6:00 pražského času.

Řešení: Klíč zátěžového testu vytváří a ruší aplikace sama pro noční běh na adresy simulátoru Amazon SES. Klientská integrace takový klíč nikdy nedostane; vlastní požadavky posílejte svým klíčem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

load_test_recipient_not_simulator

Veřejné API · HTTP 422

Situace: Klíč zátěžového testu posílá jen na adresy simulátoru Amazon SES.

Řešení: Klíč zátěžového testu vytváří a ruší aplikace sama pro noční běh na adresy simulátoru Amazon SES. Klientská integrace takový klíč nikdy nedostane; vlastní požadavky posílejte svým klíčem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

delivery_test_key_restricted

Veřejné API · HTTP 403

Situace: Klíč testu doručení smí jen odeslat transakční zprávu.

Řešení: Klíč testu doručení vytváří a ruší aplikace sama pro test doručení do schránek z administrace. Klientská integrace takový klíč nikdy nedostane; vlastní požadavky posílejte svým klíčem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

delivery_test_recipient_not_mailbox

Veřejné API · HTTP 422

Situace: Klíč testu doručení posílá jen na uložené schránky testu doručení.

Řešení: Klíč testu doručení vytváří a ruší aplikace sama pro test doručení do schránek z administrace. Klientská integrace takový klíč nikdy nedostane; vlastní požadavky posílejte svým klíčem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

marketing_permission_required

Veřejné API · HTTP 409

Situace: Aktuální odesílací brány nepovolují transakční zprávu.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

operation_not_found

Veřejné API · HTTP 404

Situace: Operace nebyla nalezena.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

organization_closed

Veřejné API · HTTP 403

Situace: Projekt nyní nepovoluje správu integrací.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

organization_dispatch_disabled

Veřejné API · HTTP 409

Situace: Aktuální odesílací brány nepovolují transakční zprávu.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

organization_restricted

Veřejné API · HTTP 403

Situace: Projekt nyní nepovoluje správu integrací.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

organization_unavailable

Veřejné API · HTTP 409

Situace: Aktuální odesílací brány nepovolují transakční zprávu.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

platform_capacity_permission_required

Správa API přístupu v aplikaci · HTTP 403

Situace: Kapacitu přiděluje oprávněný správce platformy.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

product_policy_mismatch

Veřejné API · HTTP 409

Situace: Aktuální odesílací brány nepovolují transakční zprávu.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

product_sending_capability_required

Veřejné API · HTTP 409

Situace: Aktuální odesílací brány nepovolují transakční zprávu.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

production_contact_required

Veřejné API · HTTP 409

Situace: Operace vyžaduje skutečný použitelný kontakt, nikoli ukázkový podklad.

Řešení: Použijte existující kontakt vlastního projektu s doloženým původem a potřebnými odběry. Ukázková data nepřeznačujte na skutečné příjemce jen kvůli obejití kontroly.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

project_not_found

Veřejné API · HTTP 404

Situace: Projekt nebyl nalezen.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

project_scope_mismatch

Správa API přístupu v aplikaci · HTTP 403

Situace: Vyberte právě otevřený projekt.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

provider_route_not_ready

Veřejné API · HTTP 409

Situace: Aktuální odesílací brány nepovolují transakční zprávu.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

rate_limited

Veřejné API · HTTP 429

Situace: Byl dosažen limit požadavků, příjemců nebo čekající fronty.

Řešení: Rozlište HTTP limit od kapacity příjemců a tarifu. Respektujte Retry-After, snižte souběh, sledujte odbavení fronty a aktuální capacity.limits. Série cizích projektů či chybných klíčů vyžaduje opravu integrace.

Opakování: Po Retry-After opakujte stejnou operaci s původním klíčem a omezeným počtem pokusů. Rotace klíče limit nevynuluje.

reputation_paused

Veřejné API · HTTP 409

Situace: Aktuální odesílací brány nepovolují transakční zprávu.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

request_rejected

Veřejné API · HTTP 4xx (např. 400)

Situace: Server požadavek nedokončil nebo jej odmítl mimo konkrétní doménovou chybu.

Řešení: Použijte HTTP status, request_id a dostupné fields. Při 5xx či ztrátě spojení ověřte výsledek; odpověď proxy nemusí být JSON. Opravte metodu či Content-Type při 4xx, trvající selhání předejte podpoře.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

request_too_large

Veřejné API · HTTP 413

Situace: JSON tělo překročilo hranici 1 MiB (1 048 576 bajtů), nebo kontakty z POST /contacts/bulk po převodu přesáhly 750 000 znaků.

Řešení: Zmenšete obsah nebo rozdělte dávku při zachování limitu příjemců (transakce nejvýše 50, kontakty nejvýše 1 000 v jednom požadavku). Každá nová dávka má vlastní klíč. Vícebajtové znaky také spotřebovávají limit.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

retention_policy_unavailable

Veřejné API · HTTP 409, 503

Situace: Provozovatel nemá nastavenou platnou politiku uchování dat; odesílání čeká na nápravu u podpory.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

retention_version_conflict

Správa API přístupu v aplikaci · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

scope_required

Veřejné API · HTTP 403

Situace: Operace nebo události webhooku potřebují oprávnění, které integrace nemá.

Řešení: Porovnejte scope operace s oprávněními integrace. Správce přidělí jen potřebný přístup; změna URL ani opakování oprávnění nezíská.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

scope_unavailable

Správa API přístupu v aplikaci · HTTP 422

Situace: Toto oprávnění je zatím označené Připravujeme.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

scopes_conflict

Správa API přístupu v aplikaci · HTTP 409

Situace: Oprávnění mezitím někdo změnil. Obnovte integraci a změnu zopakujte.

Řešení: Načtěte aktuální detail, readiness a povolené akce příslušného objektu. Rozlište rozpracovaný, již ukončený a změněný stav; při trvajícím konfliktu předejte code a request_id podpoře.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

sending_clearance_required

Veřejné API · HTTP 409

Situace: Chybí požadované povolení k zahájení odesílání.

Řešení: Načtěte připravenost kampaně nebo zprávy a dokončete předepsané kontroly a potvrzení oprávněnou osobou. Pouhá existence šablony nebo API klíče povolení nezíská.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

sending_limits_missing

Veřejné API · HTTP 409

Situace: Aktuální odesílací brány nepovolují transakční zprávu.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

static_contact_list_bulk_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

static_contact_list_in_use

Sdílená doménová kontrola · HTTP 409

Situace: Stav nebo vazby objektu nepovolují změnu, archivaci či odstranění.

Řešení: Ověřte aktivní schválení, dispatch a navazující použití. Použijte jen nabízenou akci zrušení před zahájením; systémové či publikované objekty nepřepisujte násilím.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

static_contact_list_invalid

Sdílená doménová kontrola · HTTP 422

Situace: Vstup, podmínka nebo definice objektu neprošly validací.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

static_contact_list_name_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Stejný název nebo identita už v daném rozsahu existují.

Řešení: Vyhledejte existující objekt a podle záměru jej použijte nebo upravte s aktuální verzí. Pro nový objekt zvolte odlišnou identitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

static_contact_list_not_found

Sdílená doménová kontrola · HTTP 404

Situace: Objekt není dostupný v rozsahu tohoto projektu nebo už neexistuje.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

static_contact_list_revision_conflict

Sdílená doménová kontrola · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

support_not_allowed

Veřejné API · HTTP 403

Situace: Požadavek kombinuje veřejné API s kontextem podpory.

Řešení: Odeberte hlavičku x-ng-support-session. Použijte přímý projektový API klíč; support relace a cookies jej nenahrazují.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

suppression_active

Veřejné API · HTTP 409

Situace: Příjemce je blokovaný nebo nelze blokaci bezpečně ověřit.

Řešení: U aktivní blokace respektujte důvod a příslušný rozsah. Při nedostupnosti kontroly předejte request_id podpoře a vyčkejte obnovy; kontrolu nevypínejte a novým kontaktem ji neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

suppression_lookup_unavailable

Veřejné API · HTTP 503

Situace: Příjemce je blokovaný nebo nelze blokaci bezpečně ověřit.

Řešení: U aktivní blokace respektujte důvod a příslušný rozsah. Při nedostupnosti kontroly předejte request_id podpoře a vyčkejte obnovy; kontrolu nevypínejte a novým kontaktem ji neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

template_published_locked

Veřejné API · HTTP 409

Situace: Transakční šablona už má publikovanou verzi; úprava (PUT /templates/{templateId}) ani publikace jiné verze nejsou povolené, aby se ostré odesílání nezměnilo pod rukama.

Řešení: Vytvořte kopii přes POST /templates/{templateId}/duplicate (nové template_id, nepublikovaná), upravte ji přes PUT, publikujte a v integraci přejděte na nové template_id s pevnou template_version. Původní šablona a její verze dál odesílají beze změny.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_already_cancelled

Veřejné API · HTTP 409

Situace: Zpráva už je zrušená.

Řešení: Ověřte mode, simulated, reason a detail zprávy. Expirace, zrušení ani simulation_only se nepovažují za doručení.

Opakování: Automaticky nevytvářejte náhradní zprávu. Nové skutečné odeslání musí být nový vědomý záměr.

transactional_batch_not_found

Veřejné API · HTTP 404

Situace: Reference nebyla nalezena v tomto projektu.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_batch_too_large

Veřejné API · HTTP 422

Situace: Dávka překračuje povolený počet příjemců.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_batch_unreadable

Následné zpracování zprávy · Související odmítnutí HTTP 409

Situace: Rezervovanou transakční zprávu nelze bezpečně načíst.

Řešení: Zachovejte ID zprávy a předejte je s request_id podpoře. Provozovatel ověří obsah, šifrování a integritu evidence. Nové publikování šablony již přijatou zprávu neopraví a nový klíč může vytvořit duplicitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_cancel_not_possible

Veřejné API · HTTP 409

Situace: Příprava nebo předání už začaly, případně je požadavek ukončený.

Řešení: Načtěte aktuální stav a povolené akce. Zrušení či přeplánování nelze vynutit nad rozpracovaným nebo již předaným požadavkem.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_cancelled_by_user

Následné zpracování zprávy · Související odmítnutí HTTP 409

Situace: Požadavek byl zrušen před prvním předáním SES.

Řešení: Ověřte mode, simulated, reason a detail zprávy. Expirace, zrušení ani simulation_only se nepovažují za doručení.

Opakování: Automaticky nevytvářejte náhradní zprávu. Nové skutečné odeslání musí být nový vědomý záměr.

transactional_confirmation_required

Správa API přístupu v aplikaci · HTTP 422

Situace: Potvrďte skutečné odeslání na uvedenou adresu.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_control_version_conflict

Veřejné API · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_crypto_unavailable

Veřejné API · HTTP 503

Situace: Ruční test není dostupný.

Řešení: Respektujte Retry-After a předejte podpoře čas, code a request_id. Provozovatel ověří službu, routování událostí a klíče; tajemství neposílejte. U časového limitu zmenšete požadovaný rozsah.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

transactional_custom_limit_invalid

Správa API přístupu v aplikaci · HTTP 422

Situace: Vlastní limit musí být celé číslo v rozsahu přidělené kapacity.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_detail_expired

Veřejné API · HTTP 404, 410

Situace: Vypršela dostupnost detailu nebo kurzoru událostí.

Řešení: Začněte nové čtení událostí a dorovnejte jej podle vlastní evidence a zachovaných výsledků. Po odstranění dat může následovat 404; lhůty detailu a idempotence jsou různé.

Opakování: Expirace historie není důkaz neodeslání. Automaticky neposílejte náhradní e-mail.

transactional_detail_unavailable

Veřejné API · HTTP 503

Situace: Reference události není dostupná.

Řešení: Respektujte Retry-After a předejte podpoře čas, code a request_id. Provozovatel ověří službu, routování událostí a klíče; tajemství neposílejte. U časového limitu zmenšete požadovaný rozsah.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

transactional_erasure_busy

Veřejné API · HTTP 409

Situace: Některá zpráva příjemce se právě odesílá nebo zpracovává. Zkuste výmaz za chvíli zopakovat.

Řešení: Ověřte oprávnění transactional:erase, ostrý režim, přesnou adresu a předepsané potvrzení. Výmaz provádějte jen jako výslovně schválenou akci; při busy respektujte čekání.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_erasure_confirmation_mismatch

Veřejné API · HTTP 422

Situace: Adresy se neshodují. Nic nebylo smazáno.

Řešení: Ověřte oprávnění transactional:erase, ostrý režim, přesnou adresu a předepsané potvrzení. Výmaz provádějte jen jako výslovně schválenou akci; při busy respektujte čekání.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_erasure_forbidden

Veřejné API · HTTP 403

Situace: Aktuální role, členství nebo stav přístupu operaci nepovolují.

Řešení: Vlastník zkontroluje roli zakladatele, ověření e-mailu, členství a stav organizace, projektu i integrace. Nový klíč stejné integrace nemusí pomoci.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_erasure_invalid_address

Veřejné API · HTTP 422

Situace: Zadejte platnou e-mailovou adresu.

Řešení: Ověřte oprávnění transactional:erase, ostrý režim, přesnou adresu a předepsané potvrzení. Výmaz provádějte jen jako výslovně schválenou akci; při busy respektujte čekání.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_erasure_live_only

Veřejné API · HTTP 403

Situace: Výmaz dat příjemce vyžaduje ostrý klíč. Testovací klíč nic nemaže.

Řešení: Ověřte oprávnění transactional:erase, ostrý režim, přesnou adresu a předepsané potvrzení. Výmaz provádějte jen jako výslovně schválenou akci; při busy respektujte čekání.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_erasure_rate_limited

Veřejné API · HTTP 429

Situace: Projekt dosáhl hodinového limitu žádostí o výmaz. Zkuste to později.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_erasure_scope_not_found

Veřejné API · HTTP 404

Situace: Projekt nebyl nalezen.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_erasure_unavailable

Veřejné API · HTTP 503

Situace: Výmaz teď nelze bezpečně provést. Nic nebylo smazáno. Zkuste to později nebo kontaktujte podporu.

Řešení: Respektujte Retry-After a načtěte aktuální stav původního požadavku. Při trvajícím selhání předejte code a request_id podpoře; znovu založený objekt ani klíč výpadek služby neřeší.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

transactional_event_route_unavailable

Veřejné API · HTTP 503

Situace: Odesílání transakčních e-mailů zatím není zapnuté. Kontaktujte podporu.

Řešení: Zkontrolujte sender_profile_id, projekt, připravenost odesílatele, DNS a stav odesílací cesty. Chybné či změněné nastavení řeší vlastník nebo podpora; připravenost neobcházejte.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

transactional_expiry_invalid

Veřejné API · HTTP 422

Situace: expires_at není v povoleném intervalu.

Řešení: Nastavte čas nejméně 60 sekund v budoucnu a nejvýše podle capacity.limits.queue_expiry_seconds. Původně přijaté zprávě nová expirace neprodlouží platnost.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_inputs_invalid

Veřejné API · HTTP 422

Situace: Požadavek neodpovídá schématu nebo deklarovaným vstupům šablony.

Řešení: Opravte konkrétní fields podle OpenAPI a publikované verze šablony. Ověřte povinná pole a typy; při příjmu neplatné transakční dávky se odmítá celá dávka.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_integration_paused

Následné zpracování zprávy · Související odmítnutí HTTP 409

Situace: Integrace, projekt nebo požadavek jsou pozastavené.

Řešení: Zjistěte rozsah pauzy. Pauza integrace odmítá nové zápisy; pauza transakčního projektu může dál přijímat do fronty. Obnovení musí provést oprávněný správce. Platnost fronty dál běží.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

transactional_integration_revoked

Následné zpracování zprávy · Související odmítnutí HTTP 409

Situace: Integrace je zrušená nebo není aktivní.

Řešení: Ověřte životní cyklus integrace. Zrušenou integraci nelze obnovit. Čekající a již předané zprávy posuzujte samostatně; nový klíč starou práci neodvolá.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_manual_limit

Správa API přístupu v aplikaci · HTTP 429

Situace: Kapacita ručních testů je vyčerpaná.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_message_not_found

Veřejné API · HTTP 404, 410

Situace: Zpráva nebyla nalezena.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_preview_required

Správa API přístupu v aplikaci · HTTP 422

Situace: Odesílatel se od náhledu změnil. Znovu zkontrolujte náhled.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_queue_expired

Následné zpracování zprávy · Související odmítnutí HTTP 409

Situace: Zprávě ve frontě skončila platnost.

Řešení: Ověřte mode, simulated, reason a detail zprávy. Expirace, zrušení ani simulation_only se nepovažují za doručení.

Opakování: Automaticky nevytvářejte náhradní zprávu. Nové skutečné odeslání musí být nový vědomý záměr.

transactional_queue_limit

Veřejné API · HTTP 429

Situace: Byl dosažen limit požadavků, příjemců nebo čekající fronty.

Řešení: Rozlište HTTP limit od kapacity příjemců a tarifu. Respektujte Retry-After, snižte souběh, sledujte odbavení fronty a aktuální capacity.limits. Série cizích projektů či chybných klíčů vyžaduje opravu integrace.

Opakování: Po Retry-After opakujte stejnou operaci s původním klíčem a omezeným počtem pokusů. Rotace klíče limit nevynuluje.

transactional_read_forbidden

Veřejné API · HTTP 403

Situace: Aktuální role, členství nebo stav přístupu operaci nepovolují.

Řešení: Vlastník zkontroluje roli zakladatele, ověření e-mailu, členství a stav organizace, projektu i integrace. Nový klíč stejné integrace nemusí pomoci.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_recipient_blocked

Následné zpracování zprávy · Související odmítnutí HTTP 409

Situace: Účinná ochrana příjemce blokuje odeslání.

Řešení: Ověřte důvod ve výsledku zprávy a kontrole blokací. Trvalé nedoručení, stížnost ani zákaz neobcházejte novým kontaktem či klíčem.

Opakování: Blokovanému příjemci automaticky neposílejte znovu.

transactional_recipient_export_forbidden

Správa API přístupu v aplikaci · HTTP 403

Situace: Výpis dat příjemce stáhne jen vlastník nebo administrátor projektu, podpora jen s povolenými úpravami.

Řešení: Vlastník ověří roli, scope, režim a příslušnou funkci tarifu. Support režim nesmí překročit práva klienta; ochranu neobcházejte.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_recipient_limit

Veřejné API · HTTP 429

Situace: Byl dosažen limit požadavků, příjemců nebo čekající fronty.

Řešení: Rozlište HTTP limit od kapacity příjemců a tarifu. Respektujte Retry-After, snižte souběh, sledujte odbavení fronty a aktuální capacity.limits. Série cizích projektů či chybných klíčů vyžaduje opravu integrace.

Opakování: Po Retry-After opakujte stejnou operaci s původním klíčem a omezeným počtem pokusů. Rotace klíče limit nevynuluje.

transactional_reference_closed

Veřejné API · HTTP 409

Situace: Reference odkazuje na uzavřený nebo odlišný požadavek.

Řešení: Načtěte původní požadavek a jeho výsledky podle reference. Jiný obsah nespojujte se starou identitou; po dokončení či uzavření neposílejte automatickou náhradu bez ověření obchodního záměru.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_reference_conflict

Veřejné API · HTTP 503

Situace: Reference odkazuje na uzavřený nebo odlišný požadavek.

Řešení: Načtěte původní požadavek a jeho výsledky podle reference. Jiný obsah nespojujte se starou identitou; po dokončení či uzavření neposílejte automatickou náhradu bez ověření obchodního záměru.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_reference_key_unavailable

Veřejné API · HTTP 503

Situace: Klíč historického řízení referencí není dostupný. Obraťte se na podporu.

Řešení: Respektujte Retry-After a předejte podpoře čas, code a request_id. Provozovatel ověří službu, routování událostí a klíče; tajemství neposílejte. U časového limitu zmenšete požadovaný rozsah.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

transactional_render_failed

Následné zpracování zprávy · Související odmítnutí HTTP 409

Situace: Otisk neměnného obsahu neodpovídá uloženým podkladům.

Řešení: Zachovejte ID zprávy a předejte je s request_id podpoře. Provozovatel ověří obsah, šifrování a integritu evidence. Nové publikování šablony již přijatou zprávu neopraví a nový klíč může vytvořit duplicitu.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_reply_to_invalid

Veřejné API · HTTP 422

Situace: Adresa pro odpovědi u šablony není platná nebo patří platformě. Upravte ji v nastavení šablony.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_request_paused

Následné zpracování zprávy · Související odmítnutí HTTP 409

Situace: Integrace, projekt nebo požadavek jsou pozastavené.

Řešení: Zjistěte rozsah pauzy. Pauza integrace odmítá nové zápisy; pauza transakčního projektu může dál přijímat do fronty. Obnovení musí provést oprávněný správce. Platnost fronty dál běží.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

transactional_request_target_invalid

Veřejné API · HTTP 422

Situace: Vyberte jeden požadavek nebo jednu společnou referenci.

Řešení: Opravte fields podle schématu příslušné operace. U kontaktů zkontrolujte vlastní pole a právní podklad, u šablon deklarované inputs, u automatizací definici a vazby bloků.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_request_target_too_large

Veřejné API · HTTP 422

Situace: Referenci rozdělte na menší části.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_route_changed

Následné zpracování zprávy · Související odmítnutí HTTP 409

Situace: Uložená odesílací cesta již neodpovídá aktuální připravenosti.

Řešení: Zkontrolujte sender_profile_id, projekt, připravenost odesílatele, DNS a stav odesílací cesty. Chybné či změněné nastavení řeší vlastník nebo podpora; připravenost neobcházejte.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

transactional_sender_required

Veřejné API · HTTP 422

Situace: Zadejte odesílací profil, nebo ho nastavte jako výchozí u šablony.

Řešení: Zkontrolujte sender_profile_id, projekt, připravenost odesílatele, DNS a stav odesílací cesty. Chybné či změněné nastavení řeší vlastník nebo podpora; připravenost neobcházejte.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

transactional_sender_unavailable

Veřejné API · HTTP 422

Situace: Vyberte dostupný odesílací profil tohoto projektu.

Řešení: Zkontrolujte sender_profile_id, projekt, připravenost odesílatele, DNS a stav odesílací cesty. Chybné či změněné nastavení řeší vlastník nebo podpora; připravenost neobcházejte.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

transactional_sending_paused

Následné zpracování zprávy · Související odmítnutí HTTP 409

Situace: Integrace, projekt nebo požadavek jsou pozastavené.

Řešení: Zjistěte rozsah pauzy. Pauza integrace odmítá nové zápisy; pauza transakčního projektu může dál přijímat do fronty. Obnovení musí provést oprávněný správce. Platnost fronty dál běží.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

transactional_simulation_only

Následné zpracování zprávy · Související odmítnutí HTTP 409

Situace: Simulovaná zpráva nesmí být předána SES.

Řešení: Ověřte mode, simulated, reason a detail zprávy. Expirace, zrušení ani simulation_only se nepovažují za doručení.

Opakování: Automaticky nevytvářejte náhradní zprávu. Nové skutečné odeslání musí být nový vědomý záměr.

transactional_template_unpublished

Veřejné API · HTTP 422

Situace: Vybraná šablona nemá použitelnou publikovanou transakční revizi.

Řešení: Načtěte katalog transakčních šablon ve stejném projektu, vyberte publikovanou verzi a ověřte deklaraci inputs. Koncept nestačí.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_template_version_not_found

Veřejné API · HTTP 404

Situace: Publikovaná verze transakční šablony nebyla nalezena.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transactional_write_forbidden

Veřejné API · HTTP 403

Situace: Aktuální role, členství nebo stav přístupu operaci nepovolují.

Řešení: Vlastník zkontroluje roli zakladatele, ověření e-mailu, členství a stav organizace, projektu i integrace. Nový klíč stejné integrace nemusí pomoci.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

transport_worker_not_ready

Veřejné API · HTTP 409

Situace: Aktuální odesílací brány nepovolují transakční zprávu.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

unsupported_media_type

Veřejné API · HTTP 415

Situace: Tělo požadavku nemá Content-Type application/json.

Řešení: Pošlete tělo jako JSON s hlavičkou Content-Type: application/json (případně s charset=utf-8). Požadavek nebyl přijat, nic nevzniklo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

validation_error

Veřejné API · HTTP 422

Situace: Požadavek neodpovídá schématu nebo deklarovaným vstupům šablony.

Řešení: Opravte konkrétní fields podle OpenAPI a publikované verze šablony. Ověřte povinná pole a typy; při příjmu neplatné transakční dávky se odmítá celá dávka.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

webhook_archived

Veřejné API · HTTP 409

Situace: Webhook je archivovaný, vypnutý nebo se volá akce nepovolená v simulaci.

Řešení: Ověřte stav a režim cíle. Zapnutí, vytvoření nového cíle či použití ostrého režimu je vědomá správa integrace, nikoli automatický retry.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

webhook_crypto_unavailable

Veřejné API · HTTP 503

Situace: Nastavení webhooku nelze bezpečně přečíst.

Řešení: Respektujte Retry-After a předejte podpoře čas, code a request_id. Provozovatel ověří službu, routování událostí a klíče; tajemství neposílejte. U časového limitu zmenšete požadovaný rozsah.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

webhook_delivery_expired

Veřejné API · HTTP 410

Situace: Vypršela dostupnost detailu nebo kurzoru událostí.

Řešení: Začněte nové čtení událostí a dorovnejte jej podle vlastní evidence a zachovaných výsledků. Po odstranění dat může následovat 404; lhůty detailu a idempotence jsou různé.

Opakování: Expirace historie není důkaz neodeslání. Automaticky neposílejte náhradní e-mail.

webhook_delivery_not_found

Veřejné API · HTTP 404

Situace: Doručení webhooku nebylo nalezeno.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

webhook_disabled

Veřejné API · HTTP 409

Situace: Webhook je archivovaný, vypnutý nebo se volá akce nepovolená v simulaci.

Řešení: Ověřte stav a režim cíle. Zapnutí, vytvoření nového cíle či použití ostrého režimu je vědomá správa integrace, nikoli automatický retry.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

webhook_dns_unavailable

Veřejné API · HTTP 503

Situace: Adresa webhooku nesplňuje pravidla veřejného HTTPS cíle nebo ji nelze bezpečně přeložit.

Řešení: Použijte veřejný HTTPS endpoint bez přesměrování a privátních síťových adres. Opravte DNS a dostupnost; nevypínejte ověřování TLS ani ochranu proti SSRF.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

webhook_live_only

Veřejné API · HTTP 409

Situace: Webhook je archivovaný, vypnutý nebo se volá akce nepovolená v simulaci.

Řešení: Ověřte stav a režim cíle. Zapnutí, vytvoření nového cíle či použití ostrého režimu je vědomá správa integrace, nikoli automatický retry.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

webhook_not_found

Veřejné API · HTTP 404

Situace: Webhook nebyl nalezen.

Řešení: Zkontrolujte projekt klíče a ID z aktuálního výpisu. Simulovaně vytvořený běžný objekt není trvalý. Cizí ID ani změna URL přístup neposkytnou.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

webhook_retry_conflict

Veřejné API · HTTP 409

Situace: Doručení není v opakovatelném stavu, změnil se počet pokusů nebo je vyčerpaný jejich limit.

Řešení: Načtěte detail doručení a aktuální expected_attempt_count. Ruční opakování zachová event_id a přidělený limit; vytvoření nového e-mailu není řešení webhooku.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

webhook_scope_missing

Veřejné API · HTTP 409

Situace: Operace nebo události webhooku potřebují oprávnění, které integrace nemá.

Řešení: Porovnejte scope operace s oprávněními integrace. Správce přidělí jen potřebný přístup; změna URL ani opakování oprávnění nezíská.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

webhook_target_limit

Veřejné API · HTTP 429

Situace: Integrace vyčerpala přidělený počet webhooků.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

webhook_target_not_public

Veřejné API · HTTP 422

Situace: Adresa webhooku nesplňuje pravidla veřejného HTTPS cíle nebo ji nelze bezpečně přeložit.

Řešení: Použijte veřejný HTTPS endpoint bez přesměrování a privátních síťových adres. Opravte DNS a dostupnost; nevypínejte ověřování TLS ani ochranu proti SSRF.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

webhook_version_conflict

Veřejné API · HTTP 409

Situace: Objekt nebo jeho podklady se změnily od posledního načtení, případně už bylo rozhodnuto.

Řešení: Načtěte aktuální objekt, expectedVersion či expected_version a neměnné podklady. Znovu vyhodnoťte svůj záměr; nepřepisujte novější stav starými údaji.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

webhook_version_limit

Veřejné API · HTTP 409

Situace: Pro další nastavení založte nový webhook.

Řešení: Porovnejte konkrétní pole s OpenAPI, capacity.limits, tarifem a aktuálními počty. Zmenšete dávku, rozsah nebo souběh. Zvýšení kapacity řeší správce, rotace klíče nepomůže.

Opakování: Neopakujte automaticky. Nejdříve opravte uvedenou podmínku a ověřte, zda původní operace již neproběhla.

workspace_closed

Veřejné API · HTTP 403

Situace: Projekt nyní nepovoluje správu integrací.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

workspace_paused

Veřejné API · HTTP 403

Situace: Projekt nyní nepovoluje správu integrací.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

workspace_unavailable

Veřejné API · HTTP 409

Situace: Aktuální odesílací brány nepovolují transakční zprávu.

Řešení: Načtěte připravenost a její checks či blockedBy. Rozlište tarif bez odesílání, vyčerpaný objem, pozastavení organizace, doménu, reputaci a infrastrukturu. Vlastník řeší tarif; provozovatel runtime a ochranné brány. Nic nezapínejte naslepo.

Opakování: Po odstranění příčiny opakujte nezměněný zápis s původním Idempotency-Key. Při změně těla nejprve dohledávejte původní výsledek a teprve pak použijte nový klíč.

Příklady

Všechny hodnoty jsou syntetické. Nahraďte ID a proměnnou prostředí vlastním testovacím klíčem. Tato stránka nemá tlačítko pro ostré spuštění.

curl -X POST 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/groups' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: group-example-0001' \
  --data '{"name":"Zákazníci e-shopu"}'

Vytvoření kontaktu a dávka

POST /contacts přijímá contact a evidence, POST /contacts/bulk pole contacts (1–1000; větší objem po dávkách podle kapitoly Hromadné nahrání kontaktů). Obě operace vyžadují addressAttestation:true a privacyAttestation:true a vrátí 202 s identifikátorem importu job_id, trvalým request.id a počty řádků; kontakty se následně zpracují na pozadí. GET /contact-imports/{job_id}/readiness ukazuje postup, výsledek a případný vadný řádek. Stejný Idempotency-Key nevytvoří druhou práci. U dávky se vrátí počty neplatných a duplicitních řádků, u jediného neplatného kontaktu 422 bez práce.

evidence obsahuje processingBasis, marketingPermissionBasis a evidenceObservedAt, volitelně konkrétní doklad a zdroj. Marketingové none s doloženým contract/consent/legitimate_interests uloží pouze kontakt a podklad: nepřihlásí odběr ani nepřepíše existující oprávnění. Skupiny určují jen targetListIds. Vlastní pole musí být předem definovaná v projektu. Pro multiselect načtěte povolené options přes GET /contact-fields. Při vytvoření kontaktu nebo dávky posílejte například customFields: {"zajmy": ["Sport", "Cestování"]}; podporován je i dosavadní seznam zakódovaný v řetězci. Vybrané možnosti musí přesně odpovídat definici a nesmějí se opakovat. API z hodnot nové možnosti nevytváří. Prázdný seznam znamená nevyplněno. JSON seznam lze použít pouze pro typ multiselect. Odpověď kontaktu a PATCH profilu nadále používají JSON seznam zakódovaný v řetězci. Číselné vlastní pole přijme celé i desetinné číslo s tečkou nebo čárkou, se znaménkem a exponentem (12, 12,5, -3, 1e3); mezery uvnitř čísla, text a 0x10 neplatí, prázdná hodnota znamená bez hodnoty. Platí stejné pravidlo jako ve formuláři a v aplikaci. Neplatná hodnota udělá z řádku dávky neplatný řádek; jediný kontakt vrátí 422 contact_intake_invalid s chybou u pole, například "/contact/customFields/orders": "Hodnota není číslo.". Hodnotu z požadavku chyba neopakuje. Chráněná blokace přežije i nový import stejné adresy.

curl -X POST 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/contacts' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: contact-create-example-0001' \
  --data '{"contact":{"email":"synthetic@example.test","firstName":"Jana","lastName":"Ukázková"},"evidence":{"processingBasis":"contract","marketingPermissionBasis":"none","evidenceObservedAt":"2026-10-06T08:00:00Z","evidenceReference":"Syntetická objednávka TEST-100"},"addressAttestation":true,"privacyAttestation":true}'

Úprava kontaktu

Nejdříve načtěte detail a použijte jeho aktuální verzi. Profilový zápis nenahrazuje doložení oprávnění ani přihlášení k odběru.

curl -X PATCH 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/contacts/cnt_00000000000000000000000000000001/profile' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: contact-example-0001' \
  --data '{"expectedVersion":1,"firstName":"Jana","lastName":"Ukázková","locale":"cs-CZ","city":null,"company":null,"country":null,"customFields":{},"phone":null,"postalCode":null}'

Šablona ve společné knihovně

Počet aktivních šablon v projektu hlídá tarif. GET /templates vrací activeCount, productLimit a effectiveLimit. Placený tarif bez limitu má productLimit: null a effectiveLimit je technická pojistka 1000; bezplatný tarif má productLimit nejvýš 50. Archivované šablony ani revize se nepočítají. Po dosažení hranice vrátí vytvoření i návrat z archivu 409 campaign_email_template_limit_reached. Parametr q hledá bez ohledu na diakritiku a velikost písmen; šablona vyhoví, když každé slovo dotazu najde v názvu nebo ve štítku.

curl -X POST 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/templates' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: template-example-0001' \
  --data '{"name":"Ukázková šablona","category":"Ukázky","tags":[],"subjectTemplate":"Ukázková zpráva","previewTextTemplate":"Náhled","textTemplate":"Dobrý den {{first_name}}","document":{"schemaVersion":1,"settings":{"accentColor":"#178f5d","backgroundColor":"#f4f7f5","contentColor":"#ffffff","contentWidth":640,"textColor":"#17352a"},"blocks":[{"id":"text_example","type":"text","text":"Dobrý den {{first_name}}","tone":"default"}]}}'

Transakční šablona a vstupy

GET /templates/{templateId} vrací u transakční šablony také inputSchema.fields pro aktuální pracovní revizi. Každé pole obsahuje key, label, type, required a případná omezení a example; číselné a logické příklady zůstávají číslem a boolean hodnotou. Marketingová šablona transakční schéma nevrací. Přesnou revizi stáhnete přes GET /templates/{templateId}/versions/{version}. Pro ostré odesílání čtěte publikovaný katalog GET /transactional/templates a deklaraci GET /transactional/templates/{templateId}/versions/{version}: stejná definice polí je tam pod input_schema.fields, bez přimíchání novějšího konceptu.

Ve stejné knihovně nastavte purpose: transactional a inputSchema. Dostupné typy jsou text, number, boolean, date (RRRR-MM-DD), url (HTTPS) a email. Název URL pole může být libovolný platný klíč. Nejvýše 64 polí a 128 KiB schématu. Tělo JSON se nepřevádí mezi typy. Neznámé nebo prázdné/null hodnoty jsou neplatné; konkrétní pole vrací chyba 422.

Každá revize uchovává vlastní schéma. POST /templates/{templateId}/versions/{version}/preview přijímá {"inputs":{...}}, nic neposílá a nestahuje URL. POST /templates/{templateId}/versions/{version}/publish s Idempotency-Key publikuje přesnou aktuální uloženou revizi. Dokud transakční šablona nemá publikovanou verzi, editace vytvoří nový nepublikovaný návrh. Kopie ani obnova automaticky nepublikují. Samotná publikace není odeslání zprávy.

Publikovaná transakční šablona se nemění. Jakmile má transakční šablona publikovanou verzi, PUT /templates/{templateId} i publikace jiné verze vrátí 409 template_published_locked; opakovaná publikace téže verze zůstává povolená. Změnu vydejte jako kopii: POST /templates/{templateId}/duplicate (oprávnění templates:write, hlavička Idempotency-Key, tělo {"name":"…","source_version":2}, obě pole nepovinná) vrátí 201 s novou nepublikovanou šablonou s novým template_id. Zdrojem je source_version, jinak publikovaná verze, jinak aktuální. Kopie převezme obsah, vstupní pole, druh, odhlašovací adresu, výchozího odesílatele, měření a štítky; bez name dostane název „<název> (kopie)“, při obsazení „(kopie 2)“ atd. Kopii upravte, publikujte a v integraci přejděte na nové template_id s pevnou template_version. Původní šablona a její verze dál odesílají beze změny. Marketingové šablony a dosud nepublikované transakční šablony se upravují jako dřív.

Náhradní hodnota značky. Značka {{first_name|"zákazníku"}} dosadí text v uvozovkách, když údaj chybí, je prázdný nebo je jen z mezer; mezery kolem názvu a svislítka jsou povolené. Náhradní hodnota je prostý text do 100 znaků v rovných uvozovkách bez složených závorek; uvozovku zapište ", zpětné lomítko \. Do HTML se escapuje jako údaj. Platí v předmětu, úvodním textu, textu i textové verzi, ne v adresách odkazů a ne u systémových odkazů (422 u pole). U povinného vstupního pole se neuplatní, požadavek bez něj se odmítne jako dosud. used_variables vrací jen název značky (first_name). Značky bez svislítka se chovají jako dřív.

Výběr verze šablony. Verzi určuje dvojice template_id + template_version. Publikovaná verze se nemění a publikovanou transakční šablonu už nelze upravit; změna vzniká jako kopie s novým template_id (kopie publikované šablony). Požadavek s template_version použije přesně tu publikovanou verzi, i když už existuje novější. Požadavek bez template_version dostane nejnovější publikovanou verzi platnou při prvním přijetí, takže po publikaci nové verze dostávají další takové požadavky už ji. Ostré integrace proto mají posílat pevnou template_version a na novou verzi přejít vědomě. Číslo aktuální publikované verze vrací katalog v current_published_version.version a detail šablony GET /templates/{templateId} v publishedVersion. Detail vrací i version, tedy aktuální pracovní revizi: tu posílejte jako expectedVersion při PUT /templates/{templateId} a archivaci. Úplnou historii vrací GET /templates/{templateId}/versions (oprávnění templates:read; publikovaná revize má vyplněné publishedAt). Převzatá sdílená šablona má v cílovém projektu jedinou verzi, převzatou v aplikaci; historie běžné knihovny ji nevrací. Pevné číslo pak potvrdí deklarace GET /transactional/templates/{templateId}/versions/{version} s is_current_published a každá odpověď 202 vrací použitou verzi v result.template_version. Projekt si může v aplikaci zapnout přepsání publikované transakční šablony (Nastavení projektu, jen vlastník a administrátor): šablona si pak ponechá template_id a publikace vytvoří další verzi, kterou požadavky bez template_version dostanou hned. Veřejné API přepsání nenabízí a dál vrací 409 template_published_locked. Publikovat smí v aplikaci vlastník, administrátor a uživatel projektu a přes API klíč s oprávněním templates:write.

inputSchema.defaultSender nastaví výchozí odesílací profil šablony: senderProfileId (odesílací profil vlastního projektu) a volitelný replyTo (e-mailová adresa, nikdy na doméně platformy). Nová publikace transakční revize výchozí odesílací profil vyžaduje; bez něj vrátí 422 s chybou pole inputSchema.defaultSender. Dřív publikované verze bez profilu platí dál a přijímají požadavky s sender_profile_id. inputSchema.engagementTracking zapíná (true) nebo vypíná (false) měření otevření a prokliků u revize; chybí-li, platí výchozí hodnota projektu (dnes vypnuto). Obojí je součástí neměnné revize, takže pozdější úprava šablony už přijaté zprávy nezmění. Měření se vždy omezí na ověřenou měřicí adresu klientské domény.

Druh šablony. Nepovinné inputSchema.messageKind rozliší servisní šablonu (service) od marketingové zprávy odesílané transakční frontou (marketing). Chybí-li, platí service, takže dřívější šablony a volání se nemění. Druh je součástí neměnné revize. Katalog publikovaných šablon ho vrací jako message_kind u current_published_version i v deklaraci verze, takže lze zvlášť sledovat stížnosti u marketingových zpráv.

Odhlašovací adresa marketingové šablony. Revize druhu marketing se publikuje jen s inputSchema.unsubscribeUrl (HTTPS adresa stránky klienta, bez přihlašovacích údajů, nikdy doména platformy) a s odkazem přesně na tuto adresu v HTML těle i v textové části zprávy; jinak publikace vrátí 422 s chybou pole inputSchema.unsubscribeUrl (chybí adresa nebo odkaz v HTML), případně textTemplate (adresa chybí v textové části). Odkaz na tuto přesnou adresu se nikdy neměří ani nepřepisuje a zpráva nemá hlavičku List-Unsubscribe. Servisní šablona odhlašovací adresu nepotřebuje a značka {{unsubscribe_url}} zůstává u transakčních šablon zakázaná. Už publikované verze a jejich volání se nemění.

Značka odhlašovacího formuláře. Do obsahu transakční šablony můžete místo pevné adresy vložit systémovou značku {{unsubscribe_form_url}}, například do tlačítka. Při náhledu, ručním testu i odeslání se za ni dosadí inputSchema.unsubscribeUrl revize; integrace ji v inputs neposílá a pole tohoto jména nejde deklarovat. Značka je oddělená od {{unsubscribe_url}} marketingové rozesílky a funguje u servisní i marketingové šablony; v marketingové šabloně kampaní ji uložení odmítne. Revize, jejíž obsah značku používá, se publikuje jen s vyplněnou adresou, jinak 422 s chybou pole inputSchema.unsubscribeUrl, takže zpráva nikdy neodejde s prázdným odkazem. U marketingové šablony splní povinný odkaz na adresu i tlačítko nebo odkaz se značkou. Katalog vrací značku v used_variables. Systémové odkazy ({{unsubscribe_url}}, {{unsubscribe_all_url}}, {{manage_subscriptions_url}}, {{web_version_url}} a {{unsubscribe_form_url}}) patří jen do těla: nový nebo změněný subjectTemplate či previewTextTemplate s nimi u POST /templates, PUT /templates/{templateId} i PUT /campaigns/{campaignId}/content vrátí 422 campaign_email_subject_link_invalid s chybou u pole. Už uložený obsah, který je má, se dál čte, kopíruje i odesílá. Náhled rozpracované šablony bez adresy použije ukázkovou adresu https://example.com/odhlasovaci-formular?preview=1.

curl -X POST 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/templates' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: transactional-template-example-0001' \
  --data '{"name":"Ukázková objednávka","category":"Objednávky","tags":[],"purpose":"transactional","inputSchema":{"schemaVersion":1,"fields":[{"key":"order_number","label":"Číslo objednávky","type":"text","required":true,"maxLength":80,"example":"TEST-100"}],"defaultSender":{"senderProfileId":"snd_00000000000000000000000000000002","replyTo":"podpora@example.test"},"engagementTracking":false},"subjectTemplate":"Objednávka {{order_number}}","previewTextTemplate":"Potvrzení objednávky","textTemplate":"Objednávka {{order_number}} byla přijata.","document":{"schemaVersion":1,"settings":{"accentColor":"#178f5d","backgroundColor":"#f4f7f5","contentColor":"#ffffff","contentWidth":640,"textColor":"#17352a"},"blocks":[{"id":"order_example","type":"text","text":"Objednávka {{order_number}} byla přijata.","tone":"default"}]}}'

Vlastní HTML používá v dokumentu schemaVersion: 3 a řetězec html (nejvýše 200 000 bajtů UTF-8). Povinné settings zůstává stejné; blocks obsahuje jediný blok spacer, bez propojených sekcí. HTML se nepřevádí na bloky a kontroluje se pravidly v2 v pohledu prohlížeče i Outlooku: projdou podmíněné komentáře a tabulky jen pro Outlook, tlačítka a pozadí ve VML, obrázek na pozadí přes CSS url(https://…) a atribut background, odkazy http: a značka s náhradní hodnotou {{first_name|"zákazníku"}}. Server odmítá aktivní obsah (skripty, formuláře, obsluhy událostí), relativní adresy obrázků a neznámé značky; publikace transakční šablony navíc odmítne odkaz na doménu NG e-mailingu. Odmítnutí uvede v fields konkrétní pole a důvod, u pravidla HTML s číslem řádku. Vykreslená zpráva včetně přepsaných měřených odkazů smí mít nejvýše 250 000 bajtů; pro Gmail držte hotový e-mail pod 102 kB. Ostatní pravidla šablon, revizí a oprávnění platí beze změny.

Transakční zpráva a dávka

Nejdříve publikujte transakční revizi a zvolte připravený odesílací profil vlastního projektu. sender_profile_id je nepovinné: když ho vynecháte, použije se výchozí odesílací profil publikované revize šablony (a její replyTo); šablona bez výchozího odesílatele vrátí 422 transactional_sender_required. Zadáte-li odesílatele výslovně, má přednost a projde stejnou kontrolou (projekt, ověřená doména, připravenost odesílání). Bez template_version se při prvním přijetí zmrazí nejnovější publikovaná revize; po publikaci nové verze ji proto další požadavky bez čísla verze dostanou automaticky. Doporučujeme posílat pevnou template_version (výběr verze šablony). 202 Accepted vrací obálku {mode, simulated, request_id, result}; v result jsou batch_id, vybraná verze a položky s message_id. Přijetí nepotvrzuje odeslání ani doručení. Testovací klíč neuloží odesílací práci. Vadné pole odmítne celou dávku; chráněný příjemce dostane položkový důvod a ostatní platné položky pokračují.

curl -X POST 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/transactional/messages' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: transactional-message-example-0001' \
  --data '{"template_id":"tpl_00000000000000000000000000000001","email":"recipient@example.test","reference":"TEST-100","inputs":{"order_number":"TEST-100"}}'
curl -X POST 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/transactional/batches' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: transactional-batch-example-0001' \
  --data '{"template_id":"tpl_00000000000000000000000000000001","sender_profile_id":"snd_00000000000000000000000000000002","recipients":[{"email":"recipient@example.test","reference":"TEST-101","inputs":{"order_number":"TEST-101"}},{"email":"another@example.test","reference":"TEST-102","inputs":{"order_number":"TEST-102"}}]}'

Seznamy položek

Když má jedna zpráva obsahovat víc údajů stejného druhu, například pojištěné osoby na jedné smlouvě a ke každé odkaz na její kartičku, použijte seznam položek. Seznam se definuje v aplikaci v Nastavení → Vlastní pole → Seznamy položek a transakční šablona ho vybere; v API ho poznáte podle názvu (key). V požadavku je hodnotou seznamu v inputs pole objektů: jeden objekt je jedna položka s jejími údaji. Jeden záznam pošlete jako seznam s jednou položkou. Funguje to stejně u POST /transactional/messages i u každého příjemce POST /transactional/batches, ostatní části požadavku se nemění.

curl -X POST 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/transactional/messages' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: transactional-list-example-0001' \
  --data '{"template_id":"tpl_00000000000000000000000000000001","template_version":3,"email":"recipient@example.test","reference":"ZPR-123","inputs":{"cislo_smlouvy":"S-9","pojistene_osoby":[{"jmeno":"Jan Novák","karticka_url":"https://www.example.test/k/001"},{"jmeno":"Eva Nováková","karticka_url":"https://www.example.test/k/002"}]}}'

Deklarace. GET /projects/{projectId}/transactional/templates/{templateId}/versions/{version} i katalog vracejí seznamy v input_schema.lists, vedle běžných polí v input_schema.fields. Seznam má key, label, required, nepovinné minRows a maxRows a v items údaje položky se stejnými vlastnostmi jako běžné pole (key, type, required, meze, povolené hodnoty, příklad). used_variables uvádí i značky údajů položek a request_fields.lists odkazuje na input_schema.lists. Náhled POST /projects/{projectId}/templates/{templateId}/versions/{version}/preview s tělem {"inputs": …} hodnoty ověří a vykreslí zprávu se skutečným počtem položek, nic neodešle.

Hodnoty. Údaj typu text je neprázdný řetězec bez řídicích znaků v deklarované délce, případně jedna z povolených hodnot; number je číslo JSON (ne řetězec), boolean je true nebo false, date je řetězec RRRR-MM-DD, url je HTTPS adresa bez přihlašovacích údajů a email e-mailová adresa. Povinný údaj musí mít každá položka. Nepovinný údaj, který nemáte, můžete vynechat nebo poslat jako null či prázdný řetězec: všechny tři znamenají nevyplněno a místo hodnoty bude ve zprávě prázdné místo. U povinného údaje vrátí null i prázdný řetězec chybu „Povinný údaj položky chybí.“ Totéž platí pro běžná pole v inputs a pro nepovinný seznam (null = bez položek). Text jen z mezer prázdná hodnota není a API ho odmítne. Neznámý údaj API odmítne. Položky se vykreslí v pořadí, v jakém je pošlete. Povinný seznam musí mít aspoň jednu položku, případně minRows. Nepovinný seznam smíte vynechat a opakovaná část se pak nevykreslí; prázdné pole [] projde jen u seznamu bez minRows.

Limity. Šablona má nejvýše 8 seznamů, seznam nejvýše 50 položek (nebo méně podle maxRows) a položka nejvýše 16 údajů. Údaj nesmí být další seznam ani objekt. Celý požadavek má nejvýše 1 MiB. Vykreslená zpráva má dva stropy: textová verze nejvýše 20 000 bajtů a hotové HTML po doplnění hodnot nejvýše 200 000 bajtů. U seznamu položek narazíte nejdřív na textovou verzi (například 50 položek po 16 údajích zhruba po 23 znacích). Delší zprávu API odmítne s 422 transactional_inputs_invalid u /inputs a větou, která překročený limit i skutečnou velikost jmenuje. Jméno a odkaz na kartičku pro 50 osob se vejdou s velkou rezervou.

Chyby. Vadná hodnota vrátí 422 transactional_inputs_invalid s cestou k místu chyby ve fields. Index položky začíná nulou: /inputs/pojistene_osoby/1/karticka_url je druhá položka, u dávky /recipients/0/inputs/pojistene_osoby/1/karticka_url. Chybějící povinný seznam a počet položek mimo meze hlásí cestu k seznamu, /inputs/pojistene_osoby. Stejný kód a jedinou cestu mají i chyby tvaru: víc než 50 položek (/inputs/pojistene_osoby: „Seznam smí mít nejvýše 50 položek.“), víc než 16 údajů (/inputs/pojistene_osoby/0), položka, která není objekt, a seznam nebo objekt uvnitř údaje (/inputs/pojistene_osoby/0/jmeno). Chyba u kteréhokoli příjemce odmítne celou dávku a nic se nezaloží.

{
  "type": "urn:ngemailing:problem:transactional_inputs_invalid",
  "title": "Zkontrolujte hodnoty příjemce.",
  "status": 422,
  "code": "transactional_inputs_invalid",
  "request_id": "req_00000000000000000000000000000001",
  "fields": {
    "/inputs/pojistene_osoby/1/karticka_url": "Použijte HTTPS adresu bez přihlašovacích údajů."
  }
}

Šablona. Opakování zatím funguje v šablonách s vlastním HTML. Opakovanou část ohraničí komentáře <!--ng:each pojistene_osoby--> a <!--/ng:each-->, uvnitř platí značky údajů položky a také běžná pole šablony. Komentář smí stát i mezi řádky tabulky. Opakované části se nevnořují a stejný seznam jde použít na víc místech. Hodnoty se vkládají jako text, HTML z hodnot se neprovede. Textová verze zprávy se u šablony s opakovanou částí vytvoří z vykresleného HTML, takže má stejné položky: každý řádek tabulky na vlastním řádku, buňky oddělené mezerou a za odkazem jeho adresa v závorce. Vlastní textová verze šablony se v tom případě nepoužije.

<table><tbody>
<!--ng:each pojistene_osoby-->
<tr><td>{{jmeno}}</td><td><a href="{{karticka_url}}">Stáhnout kartičku</a></td></tr>
<!--/ng:each-->
</tbody></table>

Změna seznamu. Seznam je součástí neměnné publikované verze šablony. Seznam, který používá publikovaná šablona, jde v aplikaci upravit jen tak, aby dosavadní volání fungovala dál: popisek, příklad, nový nepovinný údaj, vyšší maxRows nebo volnější meze. Jinou změnu aplikace odmítne a nabídne kopii seznamu pod novým názvem. Do API se úprava dostane až novou publikovanou verzí šablony; dosavadní template_version přijímá původní podobu a nový údaj v ní odmítne jako neznámý. Když projekt nedovoluje přepsat publikovanou šablonu, nová podoba vznikne v kopii šablony s novým template_id. Po změně proto načtěte deklaraci a upravte template_version, případně template_id.

Katalog šablon a obecné údaje požadavku

Katalog i deklarace vracejí description, purpose: transactional a used_variables. V katalogu seznam značek odpovídá current_published_version; v deklaraci konkrétní požadované verzi. name a description jsou aktuální vlastnosti knihovny, obsah a značky pocházejí z přesné publikované revize. Použité značky nezaměňujte s nepoužitými deklarovanými poli.

GET /transactional/templates (oprávnění templates:read) vrací jen publikované transakční šablony: nejnovější publikovanou verzi s jejím číslem (current_published_version.version) a deklarací vstupních polí (klíč, název, typ, povinnost, omezení) a seznamů položek v input_schema.lists (seznamy položek). Pro pravidelnou synchronizaci použijte changed_since. GET /transactional/templates/{templateId}/versions/{version} deklaruje jednu publikovanou verzi a uvádí, zda je aktuální. Aktuální je ta, kterou dostane požadavek bez template_version; integrace může pevnou verzi zadat výslovně (výběr verze šablony).

Obecné údaje požadavku jsou template_id, volitelná template_version, sender_profile_id, email, reference a hlavička Idempotency-Key. Personalizační pole patří výhradně do objektu inputs. Volitelná external_customer_id a external_contract_id (do 160 znaků) slouží k dohledání zpráv přesnou shodou ve výpisu a statistikách; nejsou klíčem zprávy, takže na stejnou adresu lze v jedné dávce poslat víc zpráv k různým smlouvám.

Převzaté sdílené šablony se v cílovém projektu objeví v témže transakčním katalogu. Mají stejné template_id, nepovinné shared_from s project_id a share_id a pouze přesně převzatou publikovanou verzi. Bez template_version se vybere tato verze; nová kopie ve zdroji ji nezmění. sender_profile_id vynechte: použije se odesílatel a Reply-To zvolený při převzetí v cíli, nikoli profil zdroje. Jiný profil vrátí 422 transactional_sender_unavailable. Samotné sdílení bez převzetí katalog ani odesílání nezpřístupní. Dokud se nedokončí kopie obrázků do cíle, přijetí vrací 422 transactional_template_unpublished; po dokončení se použijí kopie a mediální adresa cíle. Katalogová deklarace a náhled vstupů přes POST fungují i pro převzatou verzi; editační operace běžné knihovny zůstávají jen pro vlastní šablony.

Platí do

Požadavek i dávka mohou mít expires_at: nejméně 60 sekund v budoucnu a nejvýše lhůta čekání integrace (capacity.limits.queue_expiry_seconds, výchozí 24 hodin); jinak 422 transactional_expiry_invalid. Bez hodnoty platí nejdelší lhůta. Zpráva, která do té doby nebyla předána k odeslání, se neodešle: má stav cancelled a důvod transactional_queue_expired ve výsledku, událostech i webhooku. Těsně před předáním Amazon SES se platnost ověří znovu.

Načítání výsledků

Načítejte GET /transactional/messages/{messageId} a GET /transactional/batches/{batchId}. Výpis GET /transactional/messages a souhrn GET /transactional/statistics sdílejí filtry from (včetně), to (mimo), state, delivery (not_reported, delayed, delivered, bounced), engagement (clicked, opened, not_measured; bez rozpoznaných robotů), batch_id, template_id, přesnou adresu recipient a přesnou reference. Výsledky patří pouze přihlášené integraci a jejímu režimu. Souhrn počítá unikátní zachované zprávy, nikoli opakované události SES. Pole progress uvádí skutečná předání ve výběru za posledních 300 sekund, pětiminutový průměr za minutu a samostatný orientační estimated_seconds odbavení zbývající fronty. Odhad používá rozestupy alespoň tří předání z poslední minuty rozložených přes nejméně 10 sekund, poslední nejvýše 30 sekund staré. Při nedostatečném nebo zastaveném vzorku, pozastavení, drženém či rušeném požadavku, zprávách vyžadujících pozornost nebo prázdné frontě je null; není příslibem doručení. paused_messages počítá čekající zprávy pozastavených požadavků a referencí. average_handover_seconds je průměrná doba od přijetí po předání u zpráv předaných za posledních 300 sekund; bez předání je null.

Stavy: queued Ve frontě, sending Odesílá se, sent Odesláno, requires_attention Vyžaduje pozornost, cancelled Zrušeno. Doručení delivery a stížnost complaint jsou samostatné. sent může mít pozdější oznámení o nedoručení či stížnost; neznamená Doručeno. Měření je volitelné a ve výchozím stavu vypnuté. engagement: not_measured znamená Neměřeno; při aktivním měření na ověřené klientské doméně vrací API engagement: measured a engagement_counts s počty otevření a prokliků, včetně oddělených strojových událostí. Měření nepotvrzuje doručení. Detail obsahuje pokusy a časovou osu ověřených událostí, nikoli personalizační vstupy. detail_expires_at uvádí skutečnou lhůtu detailu; známý zachovaný expirovaný objekt vrátí 410 transactional_detail_expired, po fyzickém výmazu 404. Tato lhůta je nezávislá na 7/90denní ochraně opakování požadavku.

curl 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/transactional/messages?reference=TEST-100&limit=20' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY"

Průběžné události

GET /transactional/events?limit=50 vrací události a neprůhledný šifrovaný next_cursor; jeho obsah nečtěte ani neskládejte. Další požadavek použije cursor beze změny; kurzor nelze přenést na jinou integraci, projekt ani režim. Ukládejte si event_id a podle něj deduplikujte opakované čtení. Navazující čtení zachovává i události potvrzené během stránkování. Události ani kurzor nejsou určeny pro neomezený archiv: lhůta je 7 dnů; při expiraci či odstraněné historii vrací API 410 event_cursor_expired. Začněte nové čtení a použijte zachované výsledky zpráv k dorovnání evidence. Pokud byl detail zprávy vymazán, událost výslovně uvede data_available: false a reference: null. Událost neobsahuje adresu, vstupy šablony ani citlivé odkazy. Při zapnutém měření šablony přicházejí i transactional.opened a transactional.clicked; pole reason nese odhad původce (human_confirmed, machine_probable pro robota nebo ochranu soukromí, unknown). Otevření ani proklik nepotvrzují doručení ani stažení obsahu. U transactional.bounced nese reason typ vrácení: permanent (adresa neexistuje, NG ji zablokuje) nebo transient (dočasný problém, například plná schránka). Automatická odpověď (například „mimo kancelář“), kterou poskytovatel hlásí jako neurčené vrácení, událost vrácení nevytvoří; zpráva zůstává doručená. transactional.sending_state přijde jen při změně viditelného stavu; requires_attention se opakuje, když se změní důvod.

Webhooky

Oprávnění webhooks:read a webhooks:write. Integrace má nejvýše pět HTTPS cílů. Při vytvoření a rotaci se whsec_… zobrazí jednou; opakování se stejným Idempotency-Key vrátí původní cíl s secret: null a replayed: true. Po ztrátě tajemství proveďte rotaci, nevytvářejte druhý cíl. Testovací klíč simuluje nastavení a test bez skutečného webhooku.

curl -X POST 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/webhooks' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: webhook-example-0001' \
  --data '{"name":"Objednávky","url":"https://shop.example.test/webhooks/email","event_types":["transactional.sending_state","transactional.delivered","transactional.bounced","transactional.complained"],"enabled":true}'

PATCH /webhooks/{webhookId} vyžaduje celé nastavení a expected_version; souběžná změna vrátí 409. POST /webhooks/{webhookId}/rotate-secret také vyžaduje expected_version. URL, výběr událostí a tajemství se připnou k verzi platné pro čas potvrzení události. Historie nadále používá původní URL a tajemství; API nepřesouvá historii na nový server. Původní tajemství přijímejte po celou sedmidenní lhůtu zachovaných doručení. POST /webhooks/{webhookId}/archive s expected_version a confirm_archive:true nevratně uvolní kapacitu cíle a zastaví čekající pokusy. Již zahájený pokus může dokončit předání; historie je dostupná do vlastní expirace. Archivovaný cíl nelze znovu zapnout. Vypnutí cíle drží rozpracované pokusy; události potvrzené během vypnutí se nedoručují.

Služba podepíše přesné UTF-8 tělo pomocí HMAC-SHA256 přes timestamp + "." + rawBody, kde timestamp je celé UNIX datum v sekundách. Hlavičky jsou X-NG-Webhook-Timestamp, X-NG-Webhook-Signature: v1=hex, X-NG-Event-Id a X-NG-Delivery-Id. Klíč pro HMAC je 32 bajtů získaných base64url dekódováním části za whsec_. Ověřte podpis před parsováním, přijímejte čas nejvýše ±300 sekund od aktuálního času a trvale deduplikujte podle podepsaného event_id v těle. Události mohou přijít duplicitně a mimo pořadí; pořadí webhooku nepotvrzuje současný stav zprávy.

Webhook neobsahuje e-mailovou adresu ani vstupy šablony. Událost má stejné ID, typ, schema_version, message_id/batch_id, čas, režim, klientskou referenci a oddělený stav jako průběžné načítání přes API. Po výmazu detailu je reference null a data_available false. Síťová kontrola při každém pokusu odmítá soukromé, loopback, metadata a vyhrazené IP adresy, smíšené DNS odpovědi a přesměrování; TLS ověřuje původní název serveru.

HTTP 2xx znamená doručeno. 408, 429, 5xx, výpadek spojení a nejistá odpověď se omezeně opakují, nejvýše šest pokusů celkem s prodlevami 30, 120, 600, 1800 a 7200 sekund. Ostatní HTTP chyby jsou konečné. DNS má lhůtu 3 sekundy, spojení neaktivní 5 sekund, celý HTTP pokus 10 sekund; tělo nejvýše 64 KiB a odpověď 16 KiB. Výchozí sdílený integrační limit je 60 pokusů/minutu; aktuální příděl ukazuje capacity.limits.webhook_attempts_per_minute. Provozovatel může přidělit méně než šest pokusů; každé přijaté doručení si svůj limit zachová. Výpadek webhooku nikdy neposílá nový e-mail.

GET /webhooks/{webhookId}/deliveries nabízí limit 1–100 a offset do 100000; detail GET /webhooks/{webhookId}/deliveries/{deliveryId} obsahuje jednotlivé pokusy a původní URL bez tajemství/těla. Pokusy a šifrovaná těla mají výchozí lhůtu 7 dnů, přidělit lze 1–7 dnů a konkrétní expires_at platí pro přijaté doručení; zachovaný expirovaný detail vrací 410, po fyzickém výmazu 404. POST /webhooks/{webhookId}/test s confirm_test:true zařadí syntetickou událost webhook.test bez e-mailu. Opakování dokončeného doručení přes POST /webhooks/{webhookId}/deliveries/{deliveryId}/retry vyžaduje expected_attempt, confirm_repeat:true a nový Idempotency-Key; stále používá původní event_id, URL a původní přidělený limit pokusů.

Marketingovou kampaň lze naplánovat přes její dispatch-requests. Změna termínu používá POST /campaigns/{campaignId}/dispatch-requests/{dispatchRequestId}/reschedule s scheduledAt a spreadOverHours. Povolena je pouze dosud nezahájená čekající práce; vzniká neměnný následník nad stejnými schválenými podklady, bez nového příjemce či obejití podmínky odesílání.

Účinné blokace

Oprávnění suppressions:read nabízí GET /suppressions s limit/offset a volitelnou přesnou adresou recipient. Výpis propojuje kontaktní blokace a minimální nezávislou ochranu po trvalém nedoručení nebo stížnosti, která přežije odstranění kontaktu a zprávy. Neobsahuje adresy ani HMAC otisky; count_basis:evidence_records uvádí počet evidencí, který není počtem unikátních adres. Zdroj, důvod, chráněnost, účinek na marketing/transakci a dostupná lhůta jsou explicitní. Výpis obsahuje i registr adres (source: registry): dočasné blokace, zákazy Amazon SES, ruční blokace a blokace adres mimo Kontakty. Trvalé nedoručení, stížnost a zákaz SES platí v celé organizaci, tedy i v jejích ostatních projektech; odhlášení z odběru blokací není. POST /suppressions/check s tělem {"recipient":"…"} vrátí účinné důvody pro konkrétní adresu (zastaralá varianta GET /suppressions/check?recipient=… dává stejný výsledek, ale adresa v URL může zůstat v přístupových lozích), včetně ochrany bez marketingového kontaktu a blokací z registru adres (například dočasná blokace po plné schránce soft_bounce, zákaz Amazon SES nebo ruční blokace); shoduje se s tím, co odmítne přijetí transakce. Absence blokace nepovoluje marketing: permission_checked:false znamená, že je nadále nutný doložený souhlas a všechny podmínky odesílání. API neposkytuje odstranění ani obcházení chráněné blokace.

Koncept kampaně

Vytvoření konceptu nic neodesílá. Před zařazením použijte připravenost, neměnné podklady a stávající schvalovací postup. ID odběru musí patřit vašemu projektu.

Pokud GET /campaigns/{campaignId}/readiness vrací reviewPackage: null, podklad ještě nebyl dokončen nebo neodpovídá aktuálnímu obsahu a publiku. V běžném režimu zavolejte POST /campaigns/{campaignId}/finalize-standard-preparation bez těla, s oprávněním campaigns:write a novým Idempotency-Key. Je to stejná akce jako Dokončit přípravu v aplikaci: vytvoří neměnný obsah, balíček a interní potvrzení bez návštěvy aplikace. Odpověď je obal zápisu: podklad čtěte z result.reviewPackage.id. Pokud zůstává null, result.nextAction a result.checks vysvětlí nutnou opravu nebo čekání na publikum; HTTP 200 samo neznamená dokončenou přípravu. Po opravě použijte nový klíč požadavku, protože opakování starého vrací původní výsledek.

Poté načtěte GET /campaigns/{campaignId}/delivery-readiness a pro POST /campaigns/{campaignId}/dispatch-requests použijte aktuální expectedSourceInputHash z pole sourceInputHash a expectedReviewPackageId z dokončeného podkladu. Hash je řetězec 64 malých šestnáctkových znaků; nevymýšlejte ho ani nepočítejte sami. Pokud je sourceInputHash: null nebo canCreatePlan: false, nejprve vyřešte checks a odeslání nevolejte. Null, prázdný řetězec nebo nedosazená proměnná v expectedSourceInputHash vrátí 422 validation_error s polem /expectedSourceInputHash. Příprava sama nic neodesílá ani neplánuje; ostatní podmínky odeslání zůstávají povinné. Přísný režim vrací 409 campaign_standard_preparation_mode_required a dál vyžaduje rozhodnutí druhé osoby. Testovací klíč přípravu jen simuluje: vrácené nové ID se neuloží a není použitelné pro další zápis.

curl -X POST 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/campaigns' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: campaign-example-0001' \
  --data '{"name":"Ukázková kampaň","audience":{"mode":"all_production_email","subscriptionTypeId":"sub_00000000000000000000000000000001"}}'

Koncept automatizace

Použijte existující segment a verzi šablony vlastního projektu. Koncept ani validace nic neodesílají.

PUT /automations/{workflowId} založí novou revizi jen při změně kroků (segment, šablona, čekání). Změna jen názvu nebo poznámky se uloží bez nové revize: currentVersion v odpovědi zůstane stejné. Do dalšího požadavku proto vždy pošlete expectedVersion z poslední odpovědi, nepočítejte ho sami.

curl -X POST 'https://my.ngemailing.cz/api/integrations/v1/projects/prj_00000000000000000000000000000001/automations' \
  -H 'Authorization: Bearer '"$NG_TEST_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: automation-example-0001' \
  --data '{"name":"Ukázková automatizace","segmentId":"seg_00000000000000000000000000000001","segmentVersion":1,"emailTemplateId":"tpl_00000000000000000000000000000001","emailTemplateVersion":1,"waitDays":1}'

Skupina je statické členství; odběr je samostatný doložený stav a segment je dynamická podmínka. Vytvoření skupiny nikdy nepřihlašuje k odběru. Odstranění kontaktu neodstraní chráněnou blokaci.

Reference API

Vyberte oblast v levé navigaci. Cesty operací navazují na základní adresu https://my.ngemailing.cz/api/integrations/v1. Parametry a schémata odpovídají aktuálnímu kontraktu; úplné definice včetně odkazovaných typů obsahuje stažitelný OpenAPI.

REFERENCE API

Projekt a přístup

3 operace

GET/projects/{projectId}/project

Načte přiřazený projekt a jeho aktuální provozní stav. Požadované oprávnění: project:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
organization_idpovinnéstring
projectpovinnéobject
scopespovinnéarray
modepovinné"test" | "live"
requests_per_minutepovinnéinteger
capacitypovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/senders

Načte povolené odesílací profily a připravenost domén; nepřijímá libovolné prostředky SES. Požadované oprávnění: senders:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
profilespovinnéobject
domainspovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/context

Ověřená integrace, její domovský projekt a výslovně povolené projekty organizace. Cookies prohlížeče tento endpoint neautentizují. Požadované oprávnění: project:read.

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
integrationpovinnéobject
projectspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑
REFERENCE API

Kontakty

22 operací

POST/projects/{projectId}/contacts

Přijme kontakt přes šifrovaný příjem a společné asynchronní zpracování. Import neuděluje marketingové oprávnění; vyžaduje potvrzení a výslovný doklad. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
evidencepovinnéobject
addressAttestationpovinnétrue
privacyAttestationpovinnétrue
targetListIdsarray
contactpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

202 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/contacts

Vypíše kontakty projektu; neodvozuje souhlas. Požadované oprávnění: contacts:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
qparametr URLstring
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
assignmentspovinnéarray
contactCapacitypovinnéobject
filtersAppliedpovinnéboolean
itemspovinnéarray
limitpovinnéinteger
offsetpovinnéinteger
searchIndexPendingpovinnéinteger
searchIndexPendingCappedpovinnéboolean
subscriptionspovinnéarray
summarypovinnéobject
totalpovinnéinteger
workspaceTotalpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/contacts/bulk

Přijme kontakty v JSON v povoleném rozsahu jako jednu asynchronní importní úlohu. Uvede neplatné a duplicitní řádky a zachová chráněné blokace. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
evidencepovinnéobject
addressAttestationpovinnétrue
privacyAttestationpovinnétrue
targetListIdsarray
contactspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

202 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/contact-imports/analyze

Analyzuje zdrojová data v povoleném rozsahu bez udělení oprávnění. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
contentpovinnéstring
delimiterpovinné"auto" | "comma" | "semicolon" | "tab"
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/contact-imports/preview

Připraví náhled importu s výslovným právním důvodem. Samotný import není souhlas. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
contentpovinnéstring
delimiterpovinné"comma" | "semicolon" | "tab"
evidenceObservedAtpovinnéstring · date-time
evidenceReferencestring
intakeOrigin"import" | "manual"
mappingpovinnéobject
marketingPermissionBasispovinné"customer_relationship" | "explicit_consent" | "none"
processingBasispovinné"consent" | "contract" | "legal_obligation" | "legitimate_interests" | "none"
sourceNamestring
subscriptionSourcestring
subscriptionTypeIdstring
subscriptionTypeIdsarray
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/contact-imports

Připraví šifrovaný příjem kontaktů bez čekání HTTP požadavku na hromadný zápis. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
addressAttestationpovinnétrue
addressAttestationVersionpovinné"contact-address-v1"
contentpovinnéstring
previewHashpovinnéstring
previewIdpovinnéstring
privacyAttestationpovinnétrue
privacyNoticeVersionpovinné"contact-import-v1"
targetListIdsarray
targetListobject
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/contact-imports

Načte připravené importní úlohy a jejich postup. Požadované oprávnění: contacts:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
qparametr URLstring
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
itemspovinnéarray
limitpovinnéinteger
offsetpovinnéinteger
totalpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/contact-imports/{jobId}/results

Vyžaduje také suppressions:read. Vypíše zpracované zdrojové řádky importu a odděleně aktuální blokace marketingu a transakcí s důvody. Výsledek created/updated není potvrzení možnosti odesílat. source_row zahrnuje hlavičku CSV; aktuální blokace nejsou historickým důvodem importu. Požadované oprávnění: contacts:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
projectIdpovinnécestastring
jobIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
job_idpovinnéstring
request_idpovinnéstring | null
totalpovinnéinteger
limitpovinnéinteger
offsetpovinnéinteger
itemspovinnéarray
evaluated_atpovinnéstring · date-time
suppression_basispovinné"current_state_not_import_history"
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/contact-imports/{jobId}/readiness

Načte aktuální připravenost importní úlohy k potvrzení. Požadované oprávnění: contacts:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
jobIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
availablepovinnéboolean
blockerspovinnéarray
contractVersionpovinné"contact-commit-v1"
requestpovinnéobject | null
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/contact-imports/{jobId}/commit

Požádá o asynchronní příjem kontaktů při zachování kapacity a podmínek provozního stavu. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
jobIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
contractVersionpovinné"contact-commit-v1"
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/contacts/{contactId}

Načte kontakt projektu včetně stavu oprávnění a odběrů. Požadované oprávnění: contacts:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
contactIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
engagementobject
contactpovinnéobject
lifecyclepovinnéobject
listMembershipspovinnéobject
marketingpovinnéobject
subscriptionspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

DELETE/projects/{projectId}/contacts/{contactId}

Odstraní data kontaktu a zachová chráněné evidence blokací. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
contactIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
expectedVersionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

PATCH/projects/{projectId}/contacts/{contactId}/profile

Upraví profil kontaktu s kontrolou očekávané verze. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
contactIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
citypovinnéstring
companypovinnéstring
countrypovinnéstring
customFieldspovinnéobject
expectedVersionpovinnéinteger
firstNamepovinnéstring
lastNamepovinnéstring
localepovinnéstring
phonepovinnéstring
postalCodepovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

PATCH/projects/{projectId}/contacts/{contactId}/identity

Upraví identitu kontaktu stejnou chráněnou operací jako aplikace. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
contactIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
confirmedpovinnétrue
emailpovinnéstring
expectedVersionpovinnéinteger
reasonpovinné"correction" | "customer_request" | "other"
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/contacts/{contactId}/permission

Zaznamená výslovné právní oprávnění. Import ani zařazení do skupiny neudělují souhlas. Požadované oprávnění: subscriptions:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
contactIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
actionpovinné"grant" | "revoke"
confirmedpovinnétrue
evidenceReferencepovinnéstring
expectedVersionpovinnéinteger
marketingPermissionBasispovinné"customer_relationship" | "explicit_consent" | "none"
occurredAtpovinnéstring · date-time
processingBasispovinné"consent" | "contract" | "legitimate_interest" | "none"
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/contacts/{contactId}/subscriptions/{subscriptionTypeId}

Přihlásí nebo odhlásí odběr podle výslovného právního dokladu a aktuálních provozních pravidel. Požadované oprávnění: subscriptions:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
contactIdpovinnécestastring
subscriptionTypeIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
actionpovinné"restore" | "unsubscribe"
confirmedpovinnétrue
expectedVersionpovinnéinteger
reasonpovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/contacts/{contactId}/permission-history

Načte dostupnou historii oprávnění kontaktu v projektu. Požadované oprávnění: subscriptions:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
contactIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
contactpovinnéobject
currentpovinnéobject
digestpovinnéobject
generatedAtpovinnéstring · date-time
permissionEventspovinnéarray
schemaVersionpovinné1
suppressionEventspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/contact-fields

Načte společné definice vlastních polí. Požadované oprávnění: contacts:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
archivedItemsarray
itemspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/contact-fields

Vytvoří definici vlastního pole (text, number, date, phone, boolean, select, multiselect). Výběrové typy vyžadují options: 1–100 různých neprázdných řetězců do 120 znaků; ostatní typy možnosti nemají. Klíč pole odvodí server z názvu; při vynechaném mergeTag vytvoří automaticky i značku, kolize řeší číselnou příponou. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
dataTypepovinné"text" | "number" | "date" | "phone" | "boolean" | "select" | "multiselect"
optionsarray
editableByRecipientpovinnéboolean
labelpovinnéstring
mergeTagstring
visibleInContactDetailpovinnéboolean
visibleInFormsboolean
visibleToRecipientpovinnéboolean
restoreArchivedobject
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

PATCH/projects/{projectId}/contact-fields/{fieldId}

Upraví vlastní pole kontaktu bez obcházení vazeb nebo neměnných systémových polí. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
fieldIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
dataTypepovinné"text" | "number" | "date" | "phone" | "boolean" | "select" | "multiselect"
optionsarray
editableByRecipientpovinnéboolean
labelpovinnéstring
mergeTagpovinnéstring
visibleInContactDetailpovinnéboolean
visibleInFormsboolean
visibleToRecipientpovinnéboolean
expectedVersionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/contact-fields/{fieldId}/impact

Vrátí počet vyplněných kontaktů a vazby, které brání archivaci pole. Požadované oprávnění: contacts:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
fieldIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
filledContactspovinnéinteger
totalContactspovinnéinteger
canArchivepovinnéboolean
usespovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/contact-fields/{fieldId}/archive

Archivuje pole kontaktu podle aktuálních společných pravidel. Požadované oprávnění: contacts:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
fieldIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
confirmedpovinnétrue
expectedVersionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑
REFERENCE API

Skupiny

8 operací

GET/projects/{projectId}/groups

Vypíše statické skupiny, které jsou odlišné od odběrů a segmentů. Požadované oprávnění: groups:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
qparametr URLstring
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
catalogRevisionpovinnéstring
itemspovinnéarray
limitpovinnéinteger
offsetpovinnéinteger
totalpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/groups

Vytvoří statickou skupinu; nemění souhlas. Požadované oprávnění: groups:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
descriptionstring
namepovinnéstring
tagNamesarray
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

PATCH/projects/{projectId}/groups/{groupId}

Přejmenuje statickou skupinu s kontrolou aktuální verze. Požadované oprávnění: groups:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
groupIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
descriptionstring
expectedMetadataRevisionpovinnéinteger
namepovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

DELETE/projects/{projectId}/groups/{groupId}

Odstraní statickou skupinu a zachová kontakty i souhlasy. Požadované oprávnění: groups:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
groupIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/groups/{groupId}

Načte konkrétní statickou skupinu bez změny souhlasu. Požadované oprávnění: groups:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
groupIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
createdAtpovinnéstring · date-time
descriptionpovinnéstring
idpovinnéstring
memberCountpovinnéinteger
metadataRevisionpovinnéinteger
namepovinnéstring
tagspovinnéarray
updatedAtpovinnéstring · date-time
versionpovinnéinteger
addedLast30Daysinteger
lastUsedAtstring · date-time
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/groups/{groupId}/members

Načte členy statické skupiny. Požadované oprávnění: groups:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
qparametr URLstring
projectIdpovinnécestastring
groupIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
itemspovinnéarray
limitpovinnéinteger
listpovinnéobject
offsetpovinnéinteger
totalpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/groups/{groupId}/members

Přidá člena bez přihlášení k odběru nebo udělení marketingového oprávnění. Požadované oprávnění: groups:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
groupIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
contactIdpovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

DELETE/projects/{projectId}/groups/{groupId}/members/{contactId}

Odstraní členství ve skupině bez změny odběrů. Požadované oprávnění: groups:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
groupIdpovinnécestastring
contactIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑
REFERENCE API

Odběry

1 operace

GET/projects/{projectId}/subscriptions

Načte dostupné odběry projektu, které jsou odlišné od statických skupin. Požadované oprávnění: subscriptions:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
qparametr URLstring
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
defaultSubscriptionTypeIdpovinnéstring
itemspovinnéarray
limitpovinnéinteger
multiSubscriptionModepovinnéboolean
offsetpovinnéinteger
totalpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑
REFERENCE API

Segmenty

6 operací

GET/projects/{projectId}/segments

Načte definice segmentů a verzovaná pravidla. Požadované oprávnění: segments:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
qparametr URLstring
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
catalogRevisionpovinnéstring
itemspovinnéarray
limitpovinnéinteger
offsetpovinnéinteger
totalpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/segments

Vytvoří dynamický segment pomocí stejného modelu podmínek jako aplikace; nepřijímá libovolné SQL. Požadované oprávnění: segments:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
descriptionstring
expressionpovinnéobject
namepovinnéstring
tagNamesarray
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/segments/{segmentId}

Načte konkrétní podmínky segmentu v povoleném projektu. Požadované oprávnění: segments:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
segmentIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
createdAtpovinnéstring · date-time
currentVersionpovinnéobject
descriptionpovinnéstring
idpovinnéstring
matchSummaryobject
metadataRevisionpovinnéinteger
namepovinnéstring
originpovinné"custom" | "system"
systemKeypovinné"blocked" | "can_contact" | "never_in_campaign" | "new_recently" | "pending_confirmation" | "unsubscribed" | null
tagspovinnéarray
updatedAtpovinnéstring · date-time
versionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

PUT/projects/{projectId}/segments/{segmentId}

Upraví vlastní dynamický segment s kontrolou očekávané verze. Požadované oprávnění: segments:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
segmentIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
descriptionstring
expectedVersionpovinnéinteger
expressionpovinnéobject
namepovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

DELETE/projects/{projectId}/segments/{segmentId}

Odstraní vlastní segment, pokud to dovolují pravidla jeho vazeb. Požadované oprávnění: segments:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
segmentIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/segments/preview

Zobrazí náhled kontaktů dynamického segmentu bez trvalého uložení členství publika. Požadované oprávnění: segments:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring

Tělo požadavku application/json

PoleTyp a popis
expressionpovinnéobject
limitinteger
offsetinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
evaluatedAtpovinnéstring · date-time
expressionpovinnéobject
expressionHashpovinnéstring
itemspovinnéarray
limitpovinnéinteger
matchingContactCountpovinnéinteger
offsetpovinnéinteger
ruleCountsobject
statespovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑
REFERENCE API

Šablony

11 operací

GET/projects/{projectId}/templates

Načte společnou knihovnu šablon. Požadované oprávnění: templates:read.

Parametry požadavku

ParametrUmístěníTyp
purposeparametr URL"marketing" | "transactional"
labelIdsparametr URLarray
messageKindsparametr URLarray
publicationparametr URLarray
sortparametr URL"name" | "usage" | "updated" | "last_used"
directionparametr URL"asc" | "desc"
unusedForDaysparametr URLinteger
categoryparametr URLstring
folderparametr URLstring
folderRootparametr URLboolean
includeArchivedparametr URLboolean
labelIdparametr URLstring
limitparametr URLinteger
offsetparametr URLinteger
qparametr URLstring
statusparametr URL"active" | "all" | "archived"
tagparametr URLstring
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
usedCountinteger
activeCountpovinnéinteger
effectiveLimitpovinnéinteger
facetspovinnéobject
itemspovinnéarray
limitpovinnéinteger
offsetpovinnéinteger
productLimitpovinnéinteger | null
totalpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/templates

Vytvoří šablonu v existující knihovně v jejím standardním formátu editoru. Požadované oprávnění: templates:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
descriptionstring
purpose"marketing" | "transactional"
inputSchemaobject
originDescriptionstring
labelNamesarray
categorypovinnéstring
documentpovinnéobject
folderstring | null
namepovinnéstring
previewTextTemplatepovinnéstring
subjectTemplatepovinnéstring
tagspovinnéarray
textTemplatepovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/templates/{templateId}

Načte souhrn šablony v rozsahu klientského účtu. U transakční šablony vrací inputSchema.fields aktuální pracovní revize včetně typů, povinnosti, omezení a příkladů. Pro odesílání použijte deklaraci publikované verze. publishedVersion je verze k odeslání, version aktuální pracovní revize pro expectedVersion. Požadované oprávnění: templates:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
templateIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
purpose"marketing" | "transactional"
originDescriptionstring | null
descriptionstring
createdAtstring · date-time
usageCountinteger
lastUsedAtstring · date-time | null
sentLast30Daysinteger
archivedAtpovinnéstring · date-time | null
folderstring | null
idpovinnéstring
labelspovinnéarray
metadataRevisionpovinnéinteger
namepovinnéstring
publishedVersioninteger | null
hasUnpublishedChangesboolean
trackingEnabledboolean
messageKind"service" | "marketing"
tagspovinnéarray
updatedAtpovinnéstring · date-time
versionpovinnéinteger
categorypovinné"marketing" | "transactional"
inputSchemaobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

PUT/projects/{projectId}/templates/{templateId}

Upraví obsah šablony a vytvoří novou neměnnou verzi. Transakční šablonu s publikovanou verzí nelze upravit: vrátí 409 template_published_locked, změnu vydejte jako kopii přes POST /templates/{templateId}/duplicate. Požadované oprávnění: templates:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
templateIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
descriptionstring
purpose"marketing" | "transactional"
inputSchemaobject
labelNamesarray
categorypovinnéstring
documentpovinnéobject
expectedVersionpovinnéinteger
expectedMetadataRevisioninteger
namepovinnéstring
previewTextTemplatepovinnéstring
subjectTemplatepovinnéstring
tagspovinnéarray
textTemplatepovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/templates/{templateId}/versions

Načte historii neměnných verzí šablony. Požadované oprávnění: templates:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
qparametr URLstring
projectIdpovinnécestastring
templateIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
itemspovinnéarray
limitpovinnéinteger
offsetpovinnéinteger
totalpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/templates/{templateId}/versions/{version}

Načte přesný obsah šablony a neměnnou verzi. Požadované oprávnění: templates:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
templateIdpovinnécestastring
versionpovinnécestainteger

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
usedVariablesarray

Skutečně použité značky této přesné neměnné revize, bez závorek.

publishedAtstring · date-time | null
purpose"marketing" | "transactional"
inputSchemaobject
createdAtpovinnéstring · date-time
currentStatuspovinné"active" | "archived"
documentpovinnéobject
idpovinnéstring
isCurrentpovinnéboolean
lifecycleEventpovinné"archived" | "created" | "restored" | "updated"
namepovinnéstring
previewTextTemplatepovinnéstring
subjectTemplatepovinnéstring
tagspovinnéarray
templateIdpovinnéstring
textTemplatepovinnéstring
versionpovinnéinteger
categorypovinné"marketing" | "transactional"
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/templates/{templateId}/versions/{version}/preview

Vykreslí konkrétní verzi šablony s ukázkovými daty bez odesílání. Požadované oprávnění: templates:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
templateIdpovinnécestastring
versionpovinnécestainteger

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
htmlpovinnéstring
mediaPlaceholderCountpovinnéinteger
networkIsolatedpovinnétrue
plainTextpovinnéstring
previewTextpovinnéstring
subjectpovinnéstring
templateIdpovinnéstring
versionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/templates/{templateId}/versions/{version}/preview

Ověří deklarované transakční vstupy a vykreslí izolovaný náhled vlastní nebo převzaté šablony bez odesílání a stahování URL. Požadované oprávnění: templates:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
templateIdpovinnécestastring
versionpovinnécestainteger

Tělo požadavku application/json

PoleTyp a popis
inputspovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
htmlpovinnéstring
mediaPlaceholderCountpovinnéinteger
networkIsolatedpovinnétrue
plainTextpovinnéstring
previewTextpovinnéstring
subjectpovinnéstring
templateIdpovinnéstring
versionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/templates/{templateId}/versions/{version}/publish

Po ověření publikuje přesnou aktuální neměnnou verzi knihovny a deklarované vstupy. Transakční šablonu s publikovanou verzí už nelze publikovat v jiné verzi: vrátí 409 template_published_locked, změnu vydejte jako kopii přes POST /templates/{templateId}/duplicate. Požadované oprávnění: templates:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
templateIdpovinnécestastring
versionpovinnécestainteger
idempotency-keypovinnéhlavičkastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/templates/{templateId}/duplicate

Vytvoří nepublikovanou kopii šablony s novým ID ze zvolené neměnné verze (source_version), jinak z publikované, jinak z aktuální. Zkopíruje obsah, deklarované vstupy, druh zprávy, odhlašovací odkaz, výchozího odesílatele, měření a štítky. Originál a jeho publikované verze zůstávají beze změny. Bez názvu dostane kopie „<název> (kopie)“. Požadované oprávnění: templates:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
templateIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
namestring
source_versioninteger
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

201 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/templates/{templateId}/archive

Archivuje šablonu podle aktuální verze a pravidel vazeb. Požadované oprávnění: templates:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
templateIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
expectedMetadataRevisioninteger
expectedVersionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑
REFERENCE API

Kampaně

22 operací

GET/projects/{projectId}/campaigns

Načte kampaně projektu se stránkováním. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
qparametr URLstring
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
itemspovinnéarray
inProgressCountinteger
limitpovinnéinteger
offsetpovinnéinteger
sectionsarray
totalpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/campaigns

Vytvoří koncept kampaně podle aktuálních pravidel publika a produktu. Požadované oprávnění: campaigns:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
audiencepovinnéobject
namepovinnéstring
sourceCampaignobject
sourceTemplateobject
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaigns/{campaignId}/recipients

Načte neměnný snímek produkčního publika se zachycenou způsobilostí; dnešní data kontaktu nepřepisují původní doklad. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
snapshot_idparametr URLstring
projectIdpovinnécestastring
campaignIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
campaign_idpovinnéstring
snapshot_idpovinnéstring
snapshot_statuspovinnéstring
basispovinné"frozen_production_audience"
totalpovinnéinteger
limitpovinnéinteger
offsetpovinnéinteger
itemspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaigns/{campaignId}/message-results

Načte uchované unikátní výsledky zpráv kampaně. Odeslání, doručení a stížnost jsou oddělené; podporuje filtry konkrétního schvalovacího balíčku a období. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
fromparametr URLstring · date-time
toparametr URLstring · date-time
review_package_idparametr URLstring
stateparametr URL"queued" | "sending" | "sent" | "requires_attention" | "cancelled"
projectIdpovinnécestastring
campaignIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
campaign_idpovinnéstring
basispovinné"retained_unique_messages"
totalpovinnéinteger
limitpovinnéinteger
offsetpovinnéinteger
itemspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaign-results

Načte aktuální výsledky kampaně a rozlišuje odeslání od doručení. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
contractVersionpovinné"campaign-results-summary-v1"
deliveredpovinnéinteger
deliveryEventsReceivingpovinnéboolean
measuredAtpovinnéstring · date-time
periodDayspovinné30
periodStartpovinnéstring · date-time
recipientspovinnéinteger
sentCampaignspovinnéinteger
unsubscribedContactspovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaigns/{campaignId}/dispatch-requests

Načte trvalé úlohy rozesílky kampaně. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/campaigns/{campaignId}/dispatch-requests

Zařadí nebo naplánuje kampaň až po splnění přípravy, schválení a podmínek poskytovatele. Požadované oprávnění: campaigns:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
expectedSourceInputHashstring
expectedReviewPackageIdpovinnéstring
scheduledAtstring · date-time | null
spreadOverHoursinteger | null
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/campaigns/{campaignId}/dispatch-requests/{dispatchRequestId}/cancel

Zruší rozesílku pouze ve fázi, kdy její provozní stav ještě dovoluje zrušení. Požadované oprávnění: campaigns:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring
dispatchRequestIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/campaigns/{campaignId}/dispatch-requests/{dispatchRequestId}/reschedule

Nahradí pouze nezahájenou čekající rozesílku neměnným následníkem s novým termínem. Schválení, zdroj a podmínky odesílání zůstávají platné. Požadované oprávnění: campaigns:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring
dispatchRequestIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
scheduledAtpovinnéstring · date-time | null
spreadOverHourspovinnéinteger | null
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaigns/{campaignId}

Načte kampaň projektu a aktuální fáze. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
approvalPendingtrue
contentVersioninteger
sendingControl"running" | "paused" | "stopped"
dispatchLastErrorCodestring | null
audienceSnapshotpovinnéobject
createdAtpovinnéstring · date-time
deliveryPeriodpovinnéobject
deliverySummarypovinnéobject
deliveryStagepovinné"paused" | "not_started" | "scheduled" | "queued" | "sending" | "completed" | "failed" | "cancelled" | "archived"
idpovinnéstring
kindpovinné"manual" | "automation"
metadataRevisionpovinnéinteger
namepovinnéstring
preparationStagepovinné"audience_preparing" | "audience_failed" | "content_missing" | "content_draft" | "ready_for_review" | "archived"
statuspovinné"draft" | "archived"
subjectstring | null
tagspovinnéarray
updatedAtpovinnéstring · date-time
versionpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaigns/{campaignId}/content

Načte koncept kampaně. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
abVariantspovinnéarray
abWinnerpovinnéobject | null
campaignIdpovinnéstring
createdAtpovinnéstring · date-time
documentpovinnéobject
idpovinnéstring
isInitialContentboolean
latestReviewVersionpovinnéobject | null
previewTextTemplatepovinnéstring
subjectTemplatepovinnéstring
textTemplatepovinnéstring
updatedAtpovinnéstring · date-time
utmParameterspovinnéobject
versionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

PUT/projects/{projectId}/campaigns/{campaignId}/content

Upraví koncept kampaně s kontrolou očekávané verze. Požadované oprávnění: campaigns:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
abVariantsarray
abWinnerobject | null
documentpovinnéobject
expectedVersionpovinnéinteger
previewTextTemplatepovinnéstring
subjectTemplatepovinnéstring
textTemplatepovinnéstring
utmParametersobject
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaigns/{campaignId}/readiness

Prověří aktuální podmínky připravenosti kampaně. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
approvalModepovinné"standard" | "second_person_required"
campaignIdpovinnéstring
checkedAtpovinnéstring · date-time
approvalpovinnéobject | null
checkspovinnéarray
governanceVersionpovinnéinteger
contentVersionpovinnéinteger | null
deliveryStatepovinné"not_released" | "released"
nextActionpovinné"review_content" | "create_review_version" | "wait_for_audience" | "review_audience" | "create_review_package" | "request_approval" | "wait_for_approval" | "revise_after_rejection" | "delivery_not_released"
reviewPackagepovinnéobject | null
reviewTargetpovinnéobject | null
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/campaigns/{campaignId}/finalize-standard-preparation

Dokončí přípravu kampaně v běžném režimu: vytvoří neměnný podklad a interní potvrzení stejně jako aplikace. Vrátí připravenost s reviewPackage.id, nebo konkrétní zbývající podmínky. Neodesílá ani neplánuje. Povinné schválení druhou osobou touto akcí nelze nahradit. Požadované oprávnění: campaigns:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaigns/{campaignId}/delivery-readiness

Načte přesný aktuální podklad a potvrzovací otisk vyžadovaný pro rozesílku. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
approvalModepovinné"standard" | "second_person_required"
campaignIdpovinnéstring
canCreatePlanpovinnéboolean
checkedAtpovinnéstring · date-time
checkspovinnéarray
currentPlanpovinnéobject | null
deliveryStatepovinné"not_released" | "released"
governanceVersionpovinnéinteger
historypovinnéobject
intentSummaryobject | null
latestPlanpovinnéobject | null
sourceInputHashpovinnéstring | null
timezonepovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaigns/{campaignId}/content/preview

Vykreslí aktuálně uložený obsah kampaně s ukázkovými daty bez odesílání. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
envelopepovinnéobject
generatedTextpovinnéstring
htmlpovinnéstring
previewTextpovinnéstring
qualitypovinnéobject
renderpovinnéobject
subjectpovinnéstring
textpovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaigns/{campaignId}/content/versions

Načte neměnné verze obsahu používané schvalovacím postupem. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
itemspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/campaigns/{campaignId}/content/versions

Zmrazí aktuální koncept pro kontrolu bez schválení a odeslání. Požadované oprávnění: campaigns:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
expectedDraftVersionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaigns/{campaignId}/content/versions/{contentVersionId}

Načte konkrétní neměnný obsah kampaně v povoleném projektu. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring
contentVersionIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
abVariantspovinnéarray
abWinnerpovinnéobject | null
campaignIdpovinnéstring
contentHashpovinnéstring
createdAtpovinnéstring · date-time
documentpovinnéobject
idpovinnéstring
previewTextTemplatepovinnéstring
sourceDraftVersionpovinnéinteger
subjectTemplatepovinnéstring
textTemplatepovinnéstring
utmParameterspovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/campaigns/{campaignId}/review-history

Načte schvalovací balíčky a rozhodnutí lidí bez obcházení schválení. Požadované oprávnění: campaigns:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
campaignIdpovinnéstring
createdBystring | null
sendingStartedBystring | null
lastEditedBystring | null
lastEditedAtstring · date-time | null
itemspovinnéarray
testEmailsarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/campaigns/{campaignId}/review-packages

Spojí neměnný zkontrolovaný obsah s připraveným publikem; schválení zůstává samostatné. Požadované oprávnění: campaigns:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
expectedAudienceSnapshotIdpovinnéstring
expectedCampaignVersionIdpovinnéstring
expectedContentReviewVersionIdpovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/campaigns/{campaignId}/approval-requests

Požádá člověka o schválení konkrétního aktuálního balíčku bez automatického schválení a odeslání. Požadované oprávnění: campaigns:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
campaignIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
expectedReviewPackageIdpovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑
REFERENCE API

Automatizace

8 operací

GET/projects/{projectId}/automations

Načte koncepty automatizací a jejich aktuální provozní připravenost. Požadované oprávnění: automations:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
qparametr URLstring
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
dryRunAllowedpovinnéboolean
itemspovinnéarray
limitpovinnéinteger
observationRuntimepovinnéobject
offsetpovinnéinteger
totalpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/automations

Vytvoří koncept automatizace; nezapíná odesílání. Požadované oprávnění: automations:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/automations/{workflowId}/observation

Načte aktuální a nedávné běhy sledování a jejich počítadla. Provoz sleduje budoucí vstupy do segmentu bez odesílání. Požadované oprávnění: automations:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
workflowIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
observationpovinnéobject | null
observationHistorypovinnéarray
observationHistoryTotalpovinnéinteger
observationRuntimepovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/automations/{workflowId}/versions/{version}/observe

Zapne existující sledování bez odesílání, pouze pokud to dovolují produktové a provozní podmínky a zpracovatel. Vyžaduje výslovné potvrzení. Požadované oprávnění: automations:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
workflowIdpovinnécestastring
versionpovinnécestainteger
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
confirmedpovinnétrue
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/automations/{workflowId}/observations/{observationId}/stop

Vypne aktivní sledování podle aktuální revize; opakování stejného požadavku nezastaví jiný běh. Požadované oprávnění: automations:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
workflowIdpovinnécestastring
observationIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
expectedRevisionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/automations/{workflowId}

Načte přesnou definici a stav automatizace v povoleném projektu. Požadované oprávnění: automations:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
workflowIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
sendingobject
createdAtpovinnéstring · date-time
currentVersionpovinnéinteger
definitionpovinnéobject
definitionHashpovinnéstring
descriptionpovinnéstring | null
dryRunpovinnéobject
idpovinnéstring
layoutpovinnéobject
layoutHashpovinnéstring
namepovinnéstring
observationpovinnéobject | null
observationHistorypovinnéarray
observationHistoryTotalpovinnéinteger
referencespovinnéobject
simulationInputpovinnéobject
statepovinné"draft"
updatedAtpovinnéstring · date-time
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

PUT/projects/{projectId}/automations/{workflowId}

Upraví koncept automatizace podle stávající validace a produktových pravidel. Změna kroků založí novou revizi; změna jen názvu nebo poznámky se uloží bez nové revize a currentVersion v odpovědi zůstane stejné. Požadované oprávnění: automations:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
workflowIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/automations/{workflowId}/versions/{version}/validate

Ověří nebo simuluje definici automatizace bez odesílání. Požadované oprávnění: automations:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
workflowIdpovinnécestastring
versionpovinnécestainteger

Tělo požadavku application/json

PoleTyp a popis
factspovinnéobject
sampleSize100 | 1000 | 10000
virtualStartedAtpovinnéstring · date-time
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑
REFERENCE API

Transakční e-maily

15 operací

GET/projects/{projectId}/transactional/sending-control

Načte stav pozastavení celého projektu společný s aplikací; nezpřístupňuje údaje jiných integrací. Požadované oprávnění: results:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
versionpovinnéinteger
pausedpovinnéboolean
paused_atpovinnéstring · date-time | null
dispatch_limitpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/transactional/sending-control/status

Pozastaví nebo obnoví transakční odesílání celého projektu včetně aplikace a ostatních integrací. Pauza drží frontu; platné API zprávy se dále přijímají s platnými limity a expirací. Již zahájené předání může doběhnout. Obnovení zachovává expiraci, kapacitu a podmínky odesílání. Testovací režim nemění ostrý stav. Požadované oprávnění: transactional:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
actionpovinné"pause" | "resume"
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/transactional/batches

Trvale přijme ověřenou transakční dávku. Stav 202 potvrzuje přijetí práce, nikoli předání do SES nebo doručení. Idempotency-Key platí společně s POST /transactional/messages. Požadované oprávnění: transactional:send.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
batch_referencestring

Nepovinná společná reference více API volání. Není idempotentní klíč.

template_idpovinnéstring
template_versioninteger

Obecný údaj: verze šablony. Bez ní se při přijetí zmrazí nejnovější publikovaná verze.

sender_profile_idstring
expires_atstring · date-time

Platí do. Zpráva, která do tohoto okamžiku nebyla předána k odeslání, se neodešle a dostane stav Zrušeno s důvodem transactional_queue_expired. Nejméně 60 sekund v budoucnu, nejvýše lhůta čekání integrace (capacity.limits.queue_expiry_seconds, výchozí 24 hodin). Bez hodnoty platí tato nejdelší lhůta.

recipientspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

202 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/transactional/messages

Přijme jednoho transakčního příjemce přes stejnou trvalou frontu; testovací klíč simuluje bez SES. Idempotency-Key platí společně s POST /transactional/batches. Požadované oprávnění: transactional:send.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
batch_referencestring

Nepovinná společná reference více API volání. Není idempotentní klíč.

template_idpovinnéstring
template_versioninteger

Obecný údaj: verze šablony. Bez ní se při přijetí zmrazí nejnovější publikovaná verze.

sender_profile_idstring
expires_atstring · date-time

Platí do. Zpráva, která do tohoto okamžiku nebyla předána k odeslání, se neodešle a dostane stav Zrušeno s důvodem transactional_queue_expired. Nejméně 60 sekund v budoucnu, nejvýše lhůta čekání integrace (capacity.limits.queue_expiry_seconds, výchozí 24 hodin). Bez hodnoty platí tato nejdelší lhůta.

emailpovinnéstring

Obecný údaj: adresa příjemce. Sama není klíčem zprávy; jednu adresu lze v dávce uvést opakovaně.

inputspovinnéobject

Personalizační pole šablony. Názvy, typy, povinnost a omezení deklaruje publikovaná verze šablony.

referencepovinnéstring

Obecný údaj: vaše reference této konkrétní zprávy (například číslo události). Vyhledává se přesnou shodou.

external_customer_idstring

Nepovinné ID zákazníka ve vašem systému. Ukládá se šifrovaně a slouží jen k dohledání; není to reference zprávy.

external_contract_idstring

Nepovinné ID smlouvy ve vašem systému. Ukládá se šifrovaně a slouží jen k dohledání; není to reference zprávy.

Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

202 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/transactional/messages

Načte uchované zprávy této integrace a režimu s povolenými filtry. Požadované oprávnění: results:read.

Parametry požadavku

ParametrUmístěníTyp
qparametr URLstring

Přesná adresa, reference zprávy, ID zákazníka nebo ID smlouvy.

limitparametr URLinteger
offsetparametr URLinteger
fromparametr URLstring · date-time
toparametr URLstring · date-time
stateparametr URL"queued" | "sending" | "sent" | "requires_attention" | "cancelled"
batch_idparametr URLstring
batch_referenceparametr URLstring
deliveryparametr URL"delivered" | "bounced" | "delayed" | "not_reported"
statesparametr URLstring
sourceparametr URL"api" | "test"
template_idparametr URLstring
recipientparametr URLstring
referenceparametr URLstring
engagementparametr URL"clicked" | "opened" | "not_measured"
external_customer_idparametr URLstring
external_contract_idparametr URLstring
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
itemspovinnéarray
totalpovinnéinteger
limitpovinnéinteger
offsetpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/transactional/messages/{messageId}/cancel

Zruší jednu čekající zprávu, dokud její předání Amazon SES nezačalo. Pozdě podané zrušení vrátí 409 transactional_cancel_not_possible; odeslaný e-mail nelze vzít zpět. Testovací klíč zrušení jen simuluje. Požadované oprávnění: transactional:send.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
messageIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/transactional/reference

Načte souhrn společné reference batch_reference napříč ostrými integracemi projektu: stav řízení (active, paused, closed), počty požadavků a zpráv podle stavů. Požadované oprávnění: results:read.

Parametry požadavku

ParametrUmístěníTyp
batch_referencepovinnéparametr URLstring
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
batch_referencepovinnéstring
statepovinné"active" | "paused" | "closed"
requestspovinnéinteger
paused_requestspovinnéinteger
receivedpovinnéinteger
available_itemspovinnéinteger
countspovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/transactional/requests/control

Pozastaví (pause), obnoví (resume) nebo trvale zruší neodeslané a uzavře (cancel) jeden požadavek (batch_id) nebo společnou referenci (batch_reference). Platí pro celý projekt jako v aplikaci; nejvýše 10 000 požadavků. Zrušení se dokončuje na pozadí, výsledek ukazují stavy zpráv. Testovací klíč změnu jen simuluje. Požadované oprávnění: transactional:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
actionpovinné"pause" | "resume" | "cancel"
batch_idstring
batch_referencestring
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/transactional/recipient-erasures

Nevratně odstraní transakční data jedné adresy v projektu: zprávy, šifrované obálky, odkazy, události poskytovatele a měření. Technická blokace adresy a anonymní souhrnné počty zůstávají. Vyžaduje produkční klíč. Vrací ID žádosti a počty, nikdy adresu. Požadované oprávnění: transactional:erase.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
emailpovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/transactional/templates

Vypíše publikované transakční šablony s nejnovější publikovanou verzí (current_published_version.version) a deklarací vstupů. Pro průběžnou synchronizaci použijte changed_since. Požadované oprávnění: templates:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
qparametr URLstring
changed_sinceparametr URLstring · date-time

Vrátí jen šablony, jejichž publikace nebo rozpracovaná úprava se změnily od tohoto okamžiku.

projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
itemspovinnéarray
totalpovinnéinteger
limitpovinnéinteger
offsetpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/transactional/templates/{templateId}/versions/{version}

Popíše konkrétní publikovanou transakční verzi: názvy a typy vstupů, povinnost a limity odděleně od obecných polí požadavku. Uvádí, zda jde o aktuální publikovanou verzi. Požadované oprávnění: templates:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
templateIdpovinnécestastring
versionpovinnécestainteger

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
shared_fromobject

Původ převzaté šablony. ID šablony zůstává stejné; odesílatel v input_schema patří cílovému projektu.

template_idpovinnéstring
namepovinnéstring
descriptionpovinnéstring
purposepovinné"transactional"
used_variablespovinnéarray

Skutečně použité personalizační značky vybrané publikované verze, bez závorek. Deklarovaná pole v input_schema mohou obsahovat další nepoužité vstupy. Systémová značka unsubscribe_form_url nemá pole v input_schema.fields: dosadí se za ni input_schema.unsubscribeUrl.

versionpovinnéinteger
published_atpovinnéstring · date-time
is_current_publishedpovinnéboolean

Pravda u nejnovější publikované verze šablony.

message_kindpovinné"service" | "marketing"

Druh šablony: service (servisní) nebo marketing (marketingová zpráva odesílaná transakční frontou). Bez výslovné volby service.

input_schemapovinnéobject
request_fieldspovinnéobject
categorypovinné"transactional"
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/transactional/messages/{messageId}

Načte odděleně odesílání, doručení, stížnosti a časovou osu. Volitelné měření interakcí uvádí jako measured nebo not_measured. Požadované oprávnění: results:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
messageIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
messagepovinnéobject
attemptspovinnéarray
eventspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/transactional/batches/{batchId}

Načte výsledky jednotlivých položek dávky. Přijato neznamená doručeno. Požadované oprávnění: results:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
batchIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
batch_idpovinnéstring
request_idpovinnéstring
created_atpovinnéstring · date-time
statepovinné"queued" | "sending" | "sent" | "requires_attention" | "cancelled"
item_countpovinnéinteger
available_itemspovinnéinteger
countspovinnéobject
itemspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/transactional/statistics

Spočítá unikátní uchované zprávy podle stejných filtrů, nikoli duplicitní události poskytovatele. Požadované oprávnění: results:read.

Parametry požadavku

ParametrUmístěníTyp
qparametr URLstring

Přesná adresa, reference zprávy, ID zákazníka nebo ID smlouvy.

limitparametr URLinteger
offsetparametr URLinteger
fromparametr URLstring · date-time
toparametr URLstring · date-time
stateparametr URL"queued" | "sending" | "sent" | "requires_attention" | "cancelled"
batch_idparametr URLstring
batch_referenceparametr URLstring
deliveryparametr URL"delivered" | "bounced" | "delayed" | "not_reported"
statesparametr URLstring
sourceparametr URL"api" | "test"
template_idparametr URLstring
recipientparametr URLstring
referenceparametr URLstring
engagementparametr URL"clicked" | "opened" | "not_measured"
external_customer_idparametr URLstring
external_contract_idparametr URLstring
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
progressobject
basispovinné"unique_messages"
totalpovinnéinteger
countspovinnéobject
engagementpovinné"not_measured" | "measured"
engagement_countsobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/transactional/events

Načte trvalé události pomocí ověřeného kurzoru vázaného na integraci a režim. Expirovaný kurzor vrací 410. Požadované oprávnění: results:read.

Parametry požadavku

ParametrUmístěníTyp
cursorparametr URLstring
limitparametr URLinteger
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
itemspovinnéarray
next_cursorpovinnéstring
cursor_expires_atpovinnéstring · date-time
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑
REFERENCE API

Blokace

3 operace

GET/projects/{projectId}/suppressions

Načte účinné blokace projektu: ochrannou evidenci, stav kontaktů a registr adres včetně blokací celé organizace a adres mimo Kontakty. Odhlášení z odběru není blokace. Počty označují evidence, nikoli odvozený marketingový souhlas. Požadované oprávnění: suppressions:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
recipientparametr URLstring · email
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
itemspovinnéarray
totalpovinnéinteger
limitpovinnéinteger
offsetpovinnéinteger
count_basispovinné"evidence_records"
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/suppressions/check

Zastaralé: adresa v URL může zůstat v přístupových lozích. Použijte POST /suppressions/check se stejnou odpovědí. Požadované oprávnění: suppressions:read.

Parametry požadavku

ParametrUmístěníTyp
recipientpovinnéparametr URLstring · email
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
marketingpovinnéobject
transactionalpovinnéobject
permission_checkedpovinnéfalse
explanationpovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/suppressions/check

Prověří konkrétního příjemce v projektu stejně jako přijetí zprávy, včetně blokací celé organizace. Adresa je v těle, ne v URL. Nepřítomnost blokace nezakládá marketingové oprávnění ani neobchází podmínky odesílání. Požadované oprávnění: suppressions:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring

Tělo požadavku application/json

PoleTyp a popis
recipientpovinnéstring · email
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
marketingpovinnéobject
transactionalpovinnéobject
permission_checkedpovinnéfalse
explanationpovinnéstring
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑
REFERENCE API

Webhooky

10 operací

GET/projects/{projectId}/webhooks

Načte seznam cílů webhooků této integrace v povoleném rozsahu. Požadované oprávnění: webhooks:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
itemspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/webhooks

Vytvoří verzovaný HTTPS cíl. Podpisové tajemství zobrazí jednou; při opakování stejného požadavku se nevrací. Požadované oprávnění: webhooks:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
namepovinnéstring
urlpovinnéstring · uri
event_typespovinnéarray
enabledpovinnéboolean
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/webhooks/{webhookId}

Načte aktuální cíl webhooku bez podpisového tajemství. Požadované oprávnění: webhooks:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
webhookIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
namepovinnéstring
urlpovinnéstring · uri
event_typespovinnéarray
enabledpovinnéboolean
idpovinnéstring
versionpovinnéinteger
created_atpovinnéstring · date-time
archived_atpovinnéstring · date-time | null
delivery_successobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

PATCH/projects/{projectId}/webhooks/{webhookId}

Změní pouze budoucí události; dřívější události si ponechají původní URL a tajemství. Cíl se v DNS ověřuje při změně adresy a při zapnutí vypnutého webhooku; vypnutí a změna názvu nebo událostí se neověřují, takže projdou i při výpadku DNS cíle. Požadované oprávnění: webhooks:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
webhookIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
namepovinnéstring
urlpovinnéstring · uri
event_typespovinnéarray
enabledpovinnéboolean
expected_versionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/webhooks/{webhookId}/archive

Nevratně archivuje cíl a uvolní kapacitu. Doručování před předáním se zastaví, uchovaná historie zůstává čitelná. Již převzaté doručení může doběhnout. Požadované oprávnění: webhooks:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
webhookIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
expected_versionpovinnéinteger
confirm_archivepovinnétrue
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/webhooks/{webhookId}/rotate-secret

Vymění podpisové tajemství pro budoucí události; uchovaná doručení používají původní verzi. Požadované oprávnění: webhooks:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
webhookIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
expected_versionpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/webhooks/{webhookId}/test

Zařadí jeden výslovně potvrzený syntetický test webhooku. Neodesílá e-mail ani nenavazuje spojení během HTTP požadavku. Požadované oprávnění: webhooks:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
webhookIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
confirm_testpovinnétrue
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/webhooks/{webhookId}/deliveries

Načte uchované výsledky doručení se stránkováním v povoleném rozsahu. Požadované oprávnění: webhooks:read.

Parametry požadavku

ParametrUmístěníTyp
limitparametr URLinteger
offsetparametr URLinteger
projectIdpovinnécestastring
webhookIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
itemspovinnéarray
totalpovinnéinteger
limitpovinnéinteger
offsetpovinnéinteger
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

GET/projects/{projectId}/webhooks/{webhookId}/deliveries/{deliveryId}

Načte technické pokusy a původní cílovou adresu; bez těla události a tajemství. Požadované oprávnění: webhooks:read.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
webhookIdpovinnécestastring
deliveryIdpovinnécestastring

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
deliverypovinnéobject
pinned_urlpovinnéstring · uri
target_versionpovinnéinteger
attemptspovinnéarray
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑

POST/projects/{projectId}/webhooks/{webhookId}/deliveries/{deliveryId}/retry

Výslovně zopakuje dokončené doručení s původní verzí cíle a ID události. Nejvýše šest pokusů celkem; neposílá další e-mail. Požadované oprávnění: webhooks:write.

Parametry požadavku

ParametrUmístěníTyp
projectIdpovinnécestastring
webhookIdpovinnécestastring
deliveryIdpovinnécestastring
idempotency-keypovinnéhlavičkastring

Tělo požadavku application/json

PoleTyp a popis
expected_attemptpovinnéinteger
confirm_repeatpovinnétrue
Úplné JSON schéma

Načítá se z OpenAPI…

Odpovědi

200 Úspěšná odpověď

application/json

PoleTyp a popis
modepovinné"live" | "test"
simulatedpovinnéboolean
request_idpovinnéstring
idempotencypovinnéobject
resultpovinnéobject
Úplné JSON schéma

Načítá se z OpenAPI…

Chybové odpovědi
400 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

401 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

403 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

404 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

409 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

410 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

413 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

415 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

422 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

429 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

500 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

503 Chybová odpověď

application/problem+json

Formát chyby je společný: type, title, status, code, request_id a případně fields. Význam kódů popisuje katalog chybových kódů.

Kontrakt operace v OpenAPI

Načítá se z OpenAPI…

Zpět na navigaci ↑