Přeskočit na obsah
API dokumentace

Templates and content

E-mail templates (HTML or the visual MJML editor), content versions, lint and spam check, footers, unsubscribe pages, saved editor elements, script templates (Twig), SMS templates, landing pages, surveys and the file manager.

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

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

Operace

MetodaCestaPopis
POST/api/v1/tenants/{tenant}/content/lintCheck e-mail content (merge tags, links, required parts)
POST/api/v1/tenants/{tenant}/content/spam-checkAntispam check of e-mail content
GET/api/v1/tenants/{tenant}/editor-elementsList saved editor elements
POST/api/v1/tenants/{tenant}/editor-elementsSave an editor element
PATCH/api/v1/tenants/{tenant}/editor-elements/{element_id}Update a saved editor element
DELETE/api/v1/tenants/{tenant}/editor-elements/{element_id}Delete a saved editor element
GET/api/v1/tenants/{tenant}/file-foldersList folders of the file manager
POST/api/v1/tenants/{tenant}/file-foldersCreate a folder
PATCH/api/v1/tenants/{tenant}/file-folders/{folder_id}Rename a folder
DELETE/api/v1/tenants/{tenant}/file-folders/{folder_id}Delete a folder
GET/api/v1/tenants/{tenant}/filesList files of the file manager
POST/api/v1/tenants/{tenant}/filesUpload a file (multipart)
POST/api/v1/tenants/{tenant}/files/stock-photoSave a stock photo to the file manager
POST/api/v1/tenants/{tenant}/files/video-thumbnailCreate a video thumbnail image
GET/api/v1/tenants/{tenant}/files/{asset_id}Get a file
PATCH/api/v1/tenants/{tenant}/files/{asset_id}Rename or move a file
DELETE/api/v1/tenants/{tenant}/files/{asset_id}Delete a file
POST/api/v1/tenants/{tenant}/files/{asset_id}/pickedRecord that a file was used
GET/api/v1/tenants/{tenant}/footersList footers
POST/api/v1/tenants/{tenant}/footersCreate a footer
GET/api/v1/tenants/{tenant}/footers/{footer_id}Get a footer
PATCH/api/v1/tenants/{tenant}/footers/{footer_id}Rename a footer
DELETE/api/v1/tenants/{tenant}/footers/{footer_id}Delete a footer
PUT/api/v1/tenants/{tenant}/footers/{footer_id}/contentSave the content of a footer
POST/api/v1/tenants/{tenant}/footers/{footer_id}/copyCopy a footer
POST/api/v1/tenants/{tenant}/footers/{footer_id}/defaultMake a footer the default
DELETE/api/v1/tenants/{tenant}/footers/{footer_id}/defaultStop using a footer as the default
POST/api/v1/tenants/{tenant}/footers/{footer_id}/publishPublish a footer
GET/api/v1/tenants/{tenant}/footers/{footer_id}/versionsList saved versions of a footer
GET/api/v1/tenants/{tenant}/footers/{footer_id}/versions/{version_id}Get one version of a footer
GET/api/v1/tenants/{tenant}/landing-pagesList landing pages
POST/api/v1/tenants/{tenant}/landing-pagesCreate a landing page
GET/api/v1/tenants/{tenant}/landing-pages/{landing_page_id}Get a landing page
PATCH/api/v1/tenants/{tenant}/landing-pages/{landing_page_id}Update a landing page
DELETE/api/v1/tenants/{tenant}/landing-pages/{landing_page_id}Delete a landing page
POST/api/v1/tenants/{tenant}/landing-pages/{landing_page_id}/copyCopy a landing page
GET/api/v1/tenants/{tenant}/script-templatesList script templates (Twig)
POST/api/v1/tenants/{tenant}/script-templatesCreate a script template
GET/api/v1/tenants/{tenant}/script-templates/{script_id}Get a script template
PATCH/api/v1/tenants/{tenant}/script-templates/{script_id}Update a script template
DELETE/api/v1/tenants/{tenant}/script-templates/{script_id}Delete a script template
GET/api/v1/tenants/{tenant}/sms-templatesList SMS templates
POST/api/v1/tenants/{tenant}/sms-templatesCreate an SMS template
GET/api/v1/tenants/{tenant}/sms-templates/{sms_template_id}Get an SMS template
PATCH/api/v1/tenants/{tenant}/sms-templates/{sms_template_id}Update an SMS template
DELETE/api/v1/tenants/{tenant}/sms-templates/{sms_template_id}Delete an SMS template
POST/api/v1/tenants/{tenant}/sms-templates/{sms_template_id}/copyCopy an SMS template
GET/api/v1/tenants/{tenant}/stock-photosSearch stock photos
GET/api/v1/tenants/{tenant}/stock-photos/statusWhether the stock photo search is available
GET/api/v1/tenants/{tenant}/surveysList surveys
POST/api/v1/tenants/{tenant}/surveysCreate a survey
GET/api/v1/tenants/{tenant}/surveys/{survey_id}Get a survey
PATCH/api/v1/tenants/{tenant}/surveys/{survey_id}Update a survey
DELETE/api/v1/tenants/{tenant}/surveys/{survey_id}Delete a survey
POST/api/v1/tenants/{tenant}/surveys/{survey_id}/copyCopy a survey
GET/api/v1/tenants/{tenant}/surveys/{survey_id}/responsesList responses of a survey
GET/api/v1/tenants/{tenant}/surveys/{survey_id}/resultsSummary results of a survey
GET/api/v1/tenants/{tenant}/templatesList templates
POST/api/v1/tenants/{tenant}/templatesCreate a template
POST/api/v1/tenants/{tenant}/templates/tagsChange labels of templates
GET/api/v1/tenants/{tenant}/templates/{template_id}Get a template with its content
PATCH/api/v1/tenants/{tenant}/templates/{template_id}Update template settings (name, subject, preheader ...)
DELETE/api/v1/tenants/{tenant}/templates/{template_id}Delete a template
POST/api/v1/tenants/{tenant}/templates/{template_id}/archiveArchive a template
PUT/api/v1/tenants/{tenant}/templates/{template_id}/contentSave the content of a template
POST/api/v1/tenants/{tenant}/templates/{template_id}/convert-to-visualConvert an HTML template to the visual editor
DELETE/api/v1/tenants/{tenant}/templates/{template_id}/draftDiscard the unpublished draft of a template
POST/api/v1/tenants/{tenant}/templates/{template_id}/duplicateDuplicate a template
POST/api/v1/tenants/{tenant}/templates/{template_id}/publishPublish the draft of a template used by an active automation
POST/api/v1/tenants/{tenant}/templates/{template_id}/testSend a test e-mail of a template
POST/api/v1/tenants/{tenant}/templates/{template_id}/unarchiveRestore an archived template
GET/api/v1/tenants/{tenant}/templates/{template_id}/versionsList saved content versions of a template
GET/api/v1/tenants/{tenant}/templates/{template_id}/versions/{version_id}Get one content version of a template
GET/api/v1/tenants/{tenant}/test-recipientsList the test addresses of the company
PUT/api/v1/tenants/{tenant}/test-recipientsReplace the test addresses of the company
GET/api/v1/tenants/{tenant}/unsubscribe-pagesList unsubscribe pages
POST/api/v1/tenants/{tenant}/unsubscribe-pagesCreate an unsubscribe page
POST/api/v1/tenants/{tenant}/unsubscribe-pages/previewRender an unsubscribe page preview
GET/api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}Get an unsubscribe page
PATCH/api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}Update an unsubscribe page
DELETE/api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}Delete an unsubscribe page
POST/api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/copyCopy an unsubscribe page
POST/api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/defaultMake an unsubscribe page the default
DELETE/api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/defaultStop using an unsubscribe page as the default

Check e-mail content (merge tags, links, required parts)

POST /api/v1/tenants/{tenant}/content/lint

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

Checks e-mail content (merge tags, emoji rules, footer, size, scripts) and answers issue codes.

Body {html, subject, preheader}: {issues: [{code, severity, params}]}, errors first (codes only).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
htmlstringano
subjectstringano
preheaderstringano

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validationhtml, subject
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Antispam check of e-mail content

POST /api/v1/tenants/{tenant}/content/spam-check

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

Body {html, subject, preheader}: {score, verdict (ok | spam | blocked), sizeKb, rules: [{code, points, found?}]} of Poštárna's own antispam rules (core/spam_check.py, SmartEmailing's "Antispamová kontrola: X / 5"); found = the phrases, hosts, domains or tags a rule found.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
htmlstringano
subjectstringano
preheaderstringano

Odpovědi

Chyby

StavKódHodnoty message
400validationhtml, subject
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

List saved editor elements

GET /api/v1/tenants/{tenant}/editor-elements

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

{items: [{id, name, category, kind, mjml, createdAt, updatedAt}]} by category, then name.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Save an editor element

POST /api/v1/tenants/{tenant}/editor-elements

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

Body {name, category?, kind, mjml}: 201 with the element; 409 conflict name (taken in the category), 400 validation limit (500 elements per tenant) or the field.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringano
categorystringne
kindEditorElementKindano
mjmlstringano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Update a saved editor element

PATCH /api/v1/tenants/{tenant}/editor-elements/{element_id}

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

Body {name?, category?, mjml?}: the element.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
element_idpathstringanoId of the element (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
categorystringne
mjmlstringne

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Delete a saved editor element

DELETE /api/v1/tenants/{tenant}/editor-elements/{element_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
element_idpathstringanoId of the element (string of digits).

Odpovědi

  • 204 No content

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

List folders of the file manager

GET /api/v1/tenants/{tenant}/file-folders

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Create a folder

POST /api/v1/tenants/{tenant}/file-folders

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringano
parentIdstring or nullano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.
503unavailablestorage

Rename a folder

PATCH /api/v1/tenants/{tenant}/file-folders/{folder_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
folder_idpathstringanoId of the folder (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
parentIdstring or nullne

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.
503unavailablestorage

Delete a folder

DELETE /api/v1/tenants/{tenant}/file-folders/{folder_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
folder_idpathstringanoId of the folder (string of digits).

Odpovědi

  • 204 No content

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.
503unavailablestorage

List files of the file manager

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

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

?folderId= (empty or missing = the root), ?q= (name contains, all folders), ?sort= name (default), -name, created, -created, size, -size, ?type=image (pictures only), ?recent=1 (files picked into an e-mail, newest pick first, all folders: folderId and sort are ignored), page, pageSize.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
folderIdquerystringne
pagequeryintegernePage number, from 1. default 1, min 1
pageSizequeryintegerneItems per page, 1 to 100. default 25, min 1, max 100
qquerystringneSearch text (case and diacritics insensitive). max 200 chars
recentquerystringne
sortquerystringneSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).
typequerystringne

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validationrecent, sort, type
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.
503unavailablestorage

Upload a file (multipart)

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

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

multipart/form-data: file (one file), folderId (optional). 201 with the file.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (multipart/form-data)

PoleTypPovinnéPopis
filestring (binary)anoThe file.

Odpovědi

Chyby

StavKódHodnoty message
400validationfile
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.
503unavailablestorage

Save a stock photo to the file manager

POST /api/v1/tenants/{tenant}/files/stock-photo

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

Body {id, size?, folderId?}: the picture of the photo bank downloaded into the file manager (no hotlinking), in the root folder Fotobanka unless folderId is given; size large (1280 px, default) or web (640 px). An identical picture stored before is returned instead of a copy. 201 {file, photo: {id, pageUrl, user, userUrl}, existing}.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

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

PoleTypPovinnéPopis
idstringano
sizeone of: large, webne
folderIdstring or nullne

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429rate_limitedstock
502upstreamstock
503unavailablestock, storage

Create a video thumbnail image

POST /api/v1/tenants/{tenant}/files/video-thumbnail

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

Body {url, folderId?}: the thumbnail of a YouTube or Vimeo video as a file (core/video_thumbs.py), in the root folder Videa unless folderId is given; an identical picture already stored is returned instead. 201 {file, provider, videoId, videoUrl, title}. 400 validation url (reason unsupported) for another address, 502 upstream url (reason not_found, http_<status>, network, too_large, invalid, host) when the picture cannot be fetched.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

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

PoleTypPovinnéPopis
urlstringano
folderIdstring or nullne

Odpovědi

Chyby

StavKódHodnoty message
400validationurl
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.
502upstreamurl
503unavailablestorage

Get a file

GET /api/v1/tenants/{tenant}/files/{asset_id}

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

The file and its uses: {templates, campaigns} whose content names its address (shown before a delete).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
asset_idpathstringanoId of the asset (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Rename or move a file

PATCH /api/v1/tenants/{tenant}/files/{asset_id}

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

Body {name, folderId} (any of them): the address stays the same.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
asset_idpathstringanoId of the asset (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
folderIdstring or nullne

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.
503unavailablestorage

Delete a file

DELETE /api/v1/tenants/{tenant}/files/{asset_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
asset_idpathstringanoId of the asset (string of digits).

Odpovědi

  • 204 No content

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Record that a file was used

POST /api/v1/tenants/{tenant}/files/{asset_id}/picked

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

The editor picked the file into an e-mail: picked_at = now (the library's recently used tab). The file.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
asset_idpathstringanoId of the asset (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

List footers

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

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

?editor=visual|html (default all), ?q= part of the name, ?sort= id, name, default with '-' for descending.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
editorquerystringne
qquerystringneSearch text (case and diacritics insensitive). max 200 chars
sortquerystringneSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validationeditor, sort
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Create a footer

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

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringano
editorone of: visual, htmlano
htmlstringano
designEmailDesign or nullano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Get a footer

GET /api/v1/tenants/{tenant}/footers/{footer_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
footer_idpathstringanoId of the footer (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Rename a footer

PATCH /api/v1/tenants/{tenant}/footers/{footer_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
footer_idpathstringanoId of the footer (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Delete a footer

DELETE /api/v1/tenants/{tenant}/footers/{footer_id}

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

204; 409 default for the default footer.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
footer_idpathstringanoId of the footer (string of digits).

Odpovědi

  • 204 No content

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Save the content of a footer

PUT /api/v1/tenants/{tenant}/footers/{footer_id}/content

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

The draft as e-mail content {editor, html, design, baseVersion, saveKind}: EmailContent; 409 version.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
footer_idpathstringanoId of the footer (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
editorone of: visual, htmlano
htmlstringano
designEmailDesign or nullano
baseVersionnumberanoThe version the editor started from; a newer one on the server answers 409 version (saved elsewhere meanwhile).
saveKindone of: manual, auto, restoreneHistory entry kind: auto (autosave, journaled), manual (Uložit), restore (a version taken back). Default auto.

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Copy a footer

POST /api/v1/tenants/{tenant}/footers/{footer_id}/copy

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

Kopírovat patičku: body {suffix} (the word after the name, from the client's language, default 'kopie').

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
footer_idpathstringanoId of the footer (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
suffixstringano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Make a footer the default

POST /api/v1/tenants/{tenant}/footers/{footer_id}/default

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

Nastavit jako výchozí: 409 published for a footer that was never published.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
footer_idpathstringanoId of the footer (string of digits).

Tělo požadavku (application/json)

object

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Stop using a footer as the default

DELETE /api/v1/tenants/{tenant}/footers/{footer_id}/default

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
footer_idpathstringanoId of the footer (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Publish a footer

POST /api/v1/tenants/{tenant}/footers/{footer_id}/publish

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

Publikovat: 409 incomplete with {gaps: [link, sender, loop, empty]}.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
footer_idpathstringanoId of the footer (string of digits).

Tělo požadavku (application/json)

object

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

List saved versions of a footer

GET /api/v1/tenants/{tenant}/footers/{footer_id}/versions

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
footer_idpathstringanoId of the footer (string of digits).
beforequerystringne
limitquerystringne

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Get one version of a footer

GET /api/v1/tenants/{tenant}/footers/{footer_id}/versions/{version_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
footer_idpathstringanoId of the footer (string of digits).
version_idpathstringanoId of the version (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

List landing pages

GET /api/v1/tenants/{tenant}/landing-pages

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

{items: LandingPageSummary[]} without the HTML.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
qquerystringneSearch text (case and diacritics insensitive). max 200 chars
sortquerystringneSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validationsort
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Create a landing page

POST /api/v1/tenants/{tenant}/landing-pages

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringano
activebooleanano
htmlstringano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Get a landing page

GET /api/v1/tenants/{tenant}/landing-pages/{landing_page_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
landing_page_idpathstringanoId of the landing page (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Update a landing page

PATCH /api/v1/tenants/{tenant}/landing-pages/{landing_page_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
landing_page_idpathstringanoId of the landing page (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
activebooleanne
htmlstringne

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Delete a landing page

DELETE /api/v1/tenants/{tenant}/landing-pages/{landing_page_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
landing_page_idpathstringanoId of the landing page (string of digits).

Odpovědi

  • 204 No content

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Copy a landing page

POST /api/v1/tenants/{tenant}/landing-pages/{landing_page_id}/copy

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
landing_page_idpathstringanoId of the landing page (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
suffixstringano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

List script templates (Twig)

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

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

{items: [{id, name, content, parses, createdAt, updatedAt}]}; ?q= (name or content contains), ?sort= id, name, content, createdAt, updatedAt with a leading '-' for descending (default -createdAt, SmartEmailing's grid).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
qquerystringneSearch text (case and diacritics insensitive). max 200 chars
sortquerystringneSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validationsort
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Create a script template

POST /api/v1/tenants/{tenant}/script-templates

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

Body {name, content}: 201 with the template; 409 conflict name, 400 validation (field or limit).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringano
contentstringano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Get a script template

GET /api/v1/tenants/{tenant}/script-templates/{script_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
script_idpathstringanoId of the script (string of digits).

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Update a script template

PATCH /api/v1/tenants/{tenant}/script-templates/{script_id}

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

Body {name?, content?}: the template.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
script_idpathstringanoId of the script (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
contentstringne

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Delete a script template

DELETE /api/v1/tenants/{tenant}/script-templates/{script_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
script_idpathstringanoId of the script (string of digits).

Odpovědi

  • 204 No content

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

List SMS templates

GET /api/v1/tenants/{tenant}/sms-templates

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
qquerystringneSearch text (case and diacritics insensitive). max 200 chars
sortquerystringneSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validationsort
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Create an SMS template

POST /api/v1/tenants/{tenant}/sms-templates

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringano
bodystringano
stripDiacriticsbooleananoOdeslat bez diakritiky: the text goes without accents (GSM 7-bit).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Get an SMS template

GET /api/v1/tenants/{tenant}/sms-templates/{sms_template_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
sms_template_idpathstringanoId of the sms template (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Update an SMS template

PATCH /api/v1/tenants/{tenant}/sms-templates/{sms_template_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
sms_template_idpathstringanoId of the sms template (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
bodystringne
stripDiacriticsbooleanneOdeslat bez diakritiky: the text goes without accents (GSM 7-bit).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Delete an SMS template

DELETE /api/v1/tenants/{tenant}/sms-templates/{sms_template_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
sms_template_idpathstringanoId of the sms template (string of digits).

Odpovědi

  • 204 No content

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Copy an SMS template

POST /api/v1/tenants/{tenant}/sms-templates/{sms_template_id}/copy

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
sms_template_idpathstringanoId of the sms template (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
suffixstringano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

GET /api/v1/tenants/{tenant}/stock-photos

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

Search of the photo bank (core/stock_photos.search_params): ?q, lang (cs, sk, en ...), imageType (all, photo, illustration, vector), orientation (all, horizontal, vertical), category, colors (comma separated), order (popular, latest), minWidth, minHeight, editorsChoice, page, perPage (3 to 200; at most 500 results). safesearch is always on. {total, totalHits, page, perPage, hits, source, sourceUrl}; the answers are cached for 24 hours.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
categoryquerystringne
colorsquerystringne
editorsChoicequerystringne
imageTypequerystringne
langquerystringne
minHeightquerystringne
minWidthquerystringne
orderquerystringne
orientationquerystringne
pagequeryintegernePage number, from 1. default 1, min 1
perPagequerystringne
qquerystringneSearch text (case and diacritics insensitive). max 200 chars

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429rate_limitedstock
502upstreamstock
503unavailablestock

Whether the stock photo search is available

GET /api/v1/tenants/{tenant}/stock-photos/status

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

{configured, source}: whether the photo bank has its key (the tab says it is not set up otherwise).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

Chyby

StavKódHodnoty message
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

List surveys

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

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
qquerystringneSearch text (case and diacritics insensitive). max 200 chars
sortquerystringneSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validationsort
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Create a survey

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

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
activebooleanneAn inactive survey answers 404.
titlestringne
introstringne
pagesarray of SurveyPagene
thanksHtmlstringne
afterUrlstringneAddress after the last page instead of the thank-you text.
oneResponsebooleanneOne contact answers once (the recipient's link).

Odpovědi

  • 201 Created: application/json Survey

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Get a survey

GET /api/v1/tenants/{tenant}/surveys/{survey_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
survey_idpathstringanoId of the survey (string of digits).

Odpovědi

  • 200 OK: application/json Survey

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Update a survey

PATCH /api/v1/tenants/{tenant}/surveys/{survey_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
survey_idpathstringanoId of the survey (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
activebooleanneAn inactive survey answers 404.
titlestringne
introstringne
pagesarray of SurveyPagene
thanksHtmlstringne
afterUrlstringneAddress after the last page instead of the thank-you text.
oneResponsebooleanneOne contact answers once (the recipient's link).

Odpovědi

  • 200 OK: application/json Survey

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Delete a survey

DELETE /api/v1/tenants/{tenant}/surveys/{survey_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
survey_idpathstringanoId of the survey (string of digits).

Odpovědi

  • 204 No content

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Copy a survey

POST /api/v1/tenants/{tenant}/surveys/{survey_id}/copy

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
survey_idpathstringanoId of the survey (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
suffixstringano

Odpovědi

  • 201 Created: application/json Survey

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

List responses of a survey

GET /api/v1/tenants/{tenant}/surveys/{survey_id}/responses

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

?page=, ?pageSize= (at most 100): {items: [{id, contactId, email, answers, submittedAt}], total, page, pageSize}, newest first; email '' for an anonymous answer.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
survey_idpathstringanoId of the survey (string of digits).
pagequeryintegernePage number, from 1. default 1, min 1
pageSizequeryintegerneItems per page, 1 to 100. default 25, min 1, max 100

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validationpage
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Summary results of a survey

GET /api/v1/tenants/{tenant}/surveys/{survey_id}/results

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
survey_idpathstringanoId of the survey (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

List templates

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

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

E-mail templates (status active, archived or all) with size, usage and the stored content check.

?status=active (default), archived or all.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
statusqueryone of: active, archived, allneStatus filter.

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validationstatus
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Create a template

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

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

Creates a template with content {editor: html|visual, html, design}.

Body {name, subject, preheader, tags, content, saveKind?}: 201 with the template; its first content goes to the save history with saveKind (default auto).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringano
subjectstringano
preheaderstringano
tagsarray of stringne
contentobjectanoA copy of a design: a starter, a campaign or another template.

Odpovědi

Chyby

StavKódHodnoty message
400validationsaveKind
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Change labels of templates

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

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

Štítky of e-mail templates (SE ⋮ "Nastavit štítky", bulk "Přiřadit štítky").

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

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

PoleTypPovinnéPopis
idsarray of stringano
addarray of stringne
removearray of stringne
tagsarray of stringne

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validationids
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Get a template with its content

GET /api/v1/tenants/{tenant}/templates/{template_id}

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

One template with its content (editor, html, design, version).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Update template settings (name, subject, preheader ...)

PATCH /api/v1/tenants/{tenant}/templates/{template_id}

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

Changes name, subject, preheader or tags.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
tagsarray of stringne
subjectstringne
preheaderstringne
linkParamsarray of CampaignLinkParamneGoogle Analytics parameters added to links of the e-shop (as a campaign's linkParams).
headersarray of CampaignHeaderneOwn e-mail headers (X-...).
unsubscribePageIdstring or nullneNull = the default unsubscribe page.
footerIdstring or nullneNull = the default footer of the editor.

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Delete a template

DELETE /api/v1/tenants/{tenant}/templates/{template_id}

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

Deletes a template (campaigns keep their own copy of the content).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).

Odpovědi

  • 204 No content

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Archive a template

POST /api/v1/tenants/{tenant}/templates/{template_id}/archive

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

Archives a template.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).

Tělo požadavku (application/json)

object

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Save the content of a template

PUT /api/v1/tenants/{tenant}/templates/{template_id}/content

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

Saves the HTML or MJML content of a template. baseVersion = the version you read (conflict when someone saved since).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
editorone of: visual, htmlano
htmlstringano
designEmailDesign or nullano
baseVersionnumberanoThe version the editor started from; a newer one on the server answers 409 version (saved elsewhere meanwhile).
saveKindone of: manual, auto, restoreneHistory entry kind: auto (autosave, journaled), manual (Uložit), restore (a version taken back). Default auto.

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Convert an HTML template to the visual editor

POST /api/v1/tenants/{tenant}/templates/{template_id}/convert-to-visual

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

Creates a NEW visual (block) template converted from an HTML template; the original stays. Answers the template and conversion {quality: clean|partial|raw, stats}.

Body {name} (optional, default "<name> (vizuální)"): a NEW visual template converted from an HTML template (core/html_to_mjml.py), 201 with the template and conversion {quality, stats}; the original stays as it is. 409 editor (not an HTML template), 409 content (nothing to convert), 409 name, 400 lint (banned hosts).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Discard the unpublished draft of a template

DELETE /api/v1/tenants/{tenant}/templates/{template_id}/draft

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

Zahodit změny: the draft goes, the published content stays (409 draft without one). Answers the template.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Duplicate a template

POST /api/v1/tenants/{tenant}/templates/{template_id}/duplicate

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

Copies a template under a new name.

Body {name}: the copy (active, writable), 201.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).

Tělo požadavku (application/json)

object

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Publish the draft of a template used by an active automation

POST /api/v1/tenants/{tenant}/templates/{template_id}/publish

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

Body {password} (a person with a password) or {confirm: <template name>} (Google sign-in, API key): the draft of a template becomes the content its e-mails send (SE "Uložit a publikovat změny", a dangerous action that asks for the password). 401 invalid_credentials (wrong password, counted like a sign-in), 429 after too many, 400 confirm, 409 draft (nothing to publish), 400 lint (hard checks). Answers the template.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).

Tělo požadavku (application/json)

TemplatePublishInput

Odpovědi

Chyby

StavKódHodnoty message
400validationconfirm
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Send a test e-mail of a template

POST /api/v1/tenants/{tenant}/templates/{template_id}/test

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

Sends a test e-mail of a template to the account's test addresses only (list_test_recipients), with [TEST] in the subject.

Body {shopId, to}: the shop gives the sender and the footer.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
shopIdstringano
tostringano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.
503unavailablemail

Restore an archived template

POST /api/v1/tenants/{tenant}/templates/{template_id}/unarchive

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

409 read_only for archive copies of imported originals, 409 lint (codes, hosts) for banned addresses.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

List saved content versions of a template

GET /api/v1/tenants/{tenant}/templates/{template_id}/versions

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

?before=<snapshot id>&limit=1..100 (default 50): {items: [{id, version, kind, createdAt, createdBy}], more}, newest first; createdBy = the saver's name or e-mail, null when not known.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).
beforequerystringne
limitquerystringne

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Get one content version of a template

GET /api/v1/tenants/{tenant}/templates/{template_id}/versions/{version_id}

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

One snapshot with content {editor, html, design}.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
template_idpathstringanoId of the template (string of digits).
version_idpathstringanoId of the version (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

List the test addresses of the company

GET /api/v1/tenants/{tenant}/test-recipients

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

Addresses that may receive test e-mails.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Replace the test addresses of the company

PUT /api/v1/tenants/{tenant}/test-recipients

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

Body {items: [e-mail, ...]} (at most 20): the addresses test e-mails may go to (Nastavení › Odesílání).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

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

PoleTypPovinnéPopis
itemsarray of stringano

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

List unsubscribe pages

GET /api/v1/tenants/{tenant}/unsubscribe-pages

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Create an unsubscribe page

POST /api/v1/tenants/{tenant}/unsubscribe-pages

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
activebooleanneActive pages may be the default; an active page cannot be deleted.
modeone of: page, redirectnepage = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl.
redirectUrlstringne
logoUrlstringne
videoUrlstringneYouTube only.
languageone of: cs, sk, auto, en, pl, de, hu, it, ro, ukne
customHtmlstringne
questionEnabledbooleanne
questionstringne
answersarray of stringne
afterUrlstringnePřesměrování po odhlášení ('' = the thank-you page); merge tags of the contact allowed.

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Render an unsubscribe page preview

POST /api/v1/tenants/{tenant}/unsubscribe-pages/preview

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

The page of unsaved settings ({name, ... as a create}) as HTML with sample values.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
activebooleanneActive pages may be the default; an active page cannot be deleted.
modeone of: page, redirectnepage = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl.
redirectUrlstringne
logoUrlstringne
videoUrlstringneYouTube only.
languageone of: cs, sk, auto, en, pl, de, hu, it, ro, ukne
customHtmlstringne
questionEnabledbooleanne
questionstringne
answersarray of stringne
afterUrlstringnePřesměrování po odhlášení ('' = the thank-you page); merge tags of the contact allowed.

Odpovědi

  • 200 OK: application/json object

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
429429 rate_limited: wait Retry-After seconds.

Get an unsubscribe page

GET /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
unsub_page_idpathstringanoId of the unsub page (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Update an unsubscribe page

PATCH /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}

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

409 default when the default page would stop being active.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
unsub_page_idpathstringanoId of the unsub page (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
namestringne
activebooleanneActive pages may be the default; an active page cannot be deleted.
modeone of: page, redirectnepage = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl.
redirectUrlstringne
logoUrlstringne
videoUrlstringneYouTube only.
languageone of: cs, sk, auto, en, pl, de, hu, it, ro, ukne
customHtmlstringne
questionEnabledbooleanne
questionstringne
answersarray of stringne
afterUrlstringnePřesměrování po odhlášení ('' = the thank-you page); merge tags of the contact allowed.

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Delete an unsubscribe page

DELETE /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}

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

204; 409 active for an active page (deactivate it first).

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
unsub_page_idpathstringanoId of the unsub page (string of digits).

Odpovědi

  • 204 No content

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Copy an unsubscribe page

POST /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/copy

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

An inactive copy; body {suffix} (default 'kopie').

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
unsub_page_idpathstringanoId of the unsub page (string of digits).

Tělo požadavku (application/json)

PoleTypPovinnéPopis
suffixstringano

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Make an unsubscribe page the default

POST /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/default

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

409 active for an inactive page.

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
unsub_page_idpathstringanoId of the unsub page (string of digits).

Tělo požadavku (application/json)

object

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Stop using an unsubscribe page as the default

DELETE /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/default

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

Parametry

NázevKdeTypPovinnéPopis
tenantpathstring (uuid)anoPublic id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page.
unsub_page_idpathstringanoId of the unsub page (string of digits).

Odpovědi

Chyby

StavKódHodnoty message
400validation
401401 unauthorized: missing, unknown, revoked, expired or idle API key.
403403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack.
404not_found
429429 rate_limited: wait Retry-After seconds.

Schémata

BoxPadding

PoleTypPovinnéPopis
topnumberano
rightnumberano
bottomnumberano
leftnumberano

CampaignHeader

PoleTypPovinnéPopis
namestringano
valuestringano

CampaignLinkParam

PoleTypPovinnéPopis
namestringano
valuestringano

ContentVersion

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

PoleTypPovinnéPopis
idstringano
versionnumberano
kindone of: manual, auto, restoreano
createdAtstringano
createdBystring or nullanoName or e-mail of the user; null for the API or unknown.

ContentVersionDetail

PoleTypPovinnéPopis
contentobjectano
idstringano
versionnumberano
kindone of: manual, auto, restoreano
createdAtstringano
createdBystring or nullanoName or e-mail of the user; null for the API or unknown.

ContentVersionList

PoleTypPovinnéPopis
itemsarray of ContentVersionano
morebooleanano

ConvertedTemplate

Result of POST /templates/{id}/convert-to-visual: the new template and how much of it became blocks.

PoleTypPovinnéPopis
conversionobjectano
contentEmailContentanoWhat the editor opens: the draft of a template in use, else the published content.
settingsTemplateSettingsano
draftobjectanoA template that active automations send keeps its published content; the editor saves a draft until it is published with the password (POST /templates/{id}/publish) or thrown away (DELETE /templates/{id}/draft).
activeUsesTemplateActiveUsesano
publicUrlstringanoVeřejný náhled: a public page with the content (merge tags unfilled).
idstringano
namestringano
subjectstringano
preheaderstringano
editorone of: visual, htmlano
createdAtstringano
updatedAtstringano
tagsarray of stringano
sizenumberanoSize of the HTML in bytes (Gmail clips messages over 102 kB).
archivedbooleananoArchived templates are not offered for new campaigns; they can be duplicated or restored.
archivedAtstring or nullano
readOnlybooleananoArchive copy of an imported SmartEmailing original: content, name and tags never change, no delete or restore.
usageobjectanoCampaigns made from the template and e-mail nodes of automations naming it.
lastUsedAtstring or nullanoNewest such campaign or automation e-mail.
checkTemplateCheckano

EditorElement

PoleTypPovinnéPopis
idstringano
namestringano
categorystringano
kindEditorElementKindano
mjmlstringano
createdAtstringano
updatedAtstringano

EditorElementInput

PoleTypPovinnéPopis
namestringano
categorystringne
kindEditorElementKindano
mjmlstringano

EditorElementKind

one of: text, image, button, row, feed, logo, video, divider, spacer, section

EmailContent

E-mail content of a template or a campaign.

PoleTypPovinnéPopis
editorone of: visual, htmlano
htmlstringanoHTML with merge tags left in place (compiled from the design, or written by hand); the core personalises and sends it.
designEmailDesign or nullanoVisual editor only.
versionnumberano0 = no content yet; every save adds one.
updatedAtstring or nullano

EmailContentInput

PoleTypPovinnéPopis
editorone of: visual, htmlano
htmlstringano
designEmailDesign or nullano
baseVersionnumberanoThe version the editor started from; a newer one on the server answers 409 version (saved elsewhere meanwhile).
saveKindone of: manual, auto, restoreneHistory entry kind: auto (autosave, journaled), manual (Uložit), restore (a version taken back). Default auto.

EmailDesign

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

PoleTypPovinnéPopis
formatmjml-1anoFormat version; a later editor migrates older designs.
mjmlstringano
stylesEmailStylesano

EmailStyles

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

PoleTypPovinnéPopis
fontFamilystringanoOne of EMAIL_FONTS (web-safe stacks; recipients' clients have no web fonts by default).
headingFontFamilystringano
fontSizenumberanoBase text size in px (12 to 20).
textColorstringano
headingColorstringano
linkColorstringano
buttonColorstringano
buttonTextColorstringano
backgroundColorstringanoAround the e-mail.
contentColorstringanoBody of the e-mail.
widthnumberanoWidth of the e-mail in px (480 to 800).
magicMagicStylesneSettings of the Magic editor (e-mail paddings, text styles, dark mode, element defaults); the server keeps the object as it is (bounded JSON, API-CONTRACT.md). Absent in designs saved before it.

Error

PoleTypPovinnéPopis
errorobjectano
json
{
  "error": {
    "code": "validation",
    "message": "email"
  }
}

FileFolder

PoleTypPovinnéPopis
idstringano
namestringano
parentIdstring or nullanonull = the root.
filesnumberanoFiles directly in the folder.
createdAtstringano

FileSource

PoleTypPovinnéPopis
namestringano
authorstringano
authorUrlstringano
pageUrlstringano

FooterDetail

PoleTypPovinnéPopis
contentEmailContentano
publishedHtmlstringanoThe copy e-mails end with ('' before the first Publikovat); the Magic editor shows it (PA-01).
idstringano
namestringano
editorone of: visual, htmlanovisual = Magic Editor list, html = Smart Editor list.
isDefaultbooleananoE-mails of this editor end with it (instead of the e-shop's standard footer); at most one per editor.
publishedbooleananoE-mails use only the published copy (Publikovat).
publishedAtstring or nullano
unpublishedChangesbooleananoThe draft differs from the published copy (or was never published).
gapsarray of FooterGapano
createdAtstringano
updatedAtstringano
contentUpdatedAtstring or nullano
publicUrlstringanoPublic preview of the draft (Zkopírovat veřejný odkaz).

FooterGap

one of: link, sender, loop, empty

FooterInput

PoleTypPovinnéPopis
namestringano
editorone of: visual, htmlano
htmlstringano
designEmailDesign or nullano

FooterSummary

PoleTypPovinnéPopis
idstringano
namestringano
editorone of: visual, htmlanovisual = Magic Editor list, html = Smart Editor list.
isDefaultbooleananoE-mails of this editor end with it (instead of the e-shop's standard footer); at most one per editor.
publishedbooleananoE-mails use only the published copy (Publikovat).
publishedAtstring or nullano
unpublishedChangesbooleananoThe draft differs from the published copy (or was never published).
gapsarray of FooterGapano
createdAtstringano
updatedAtstringano
contentUpdatedAtstring or nullano
publicUrlstringanoPublic preview of the draft (Zkopírovat veřejný odkaz).

GridTagsInput

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

PoleTypPovinnéPopis
idsarray of stringano
addarray of stringne
removearray of stringne
tagsarray of stringne

LandingPage

PoleTypPovinnéPopis
htmlstringano
idstringano
namestringano
activebooleananoAn inactive page answers 404 on its address.
urlstringanoThe public address on the link domain.
createdAtstringano
updatedAtstringano

LandingPageInput

PoleTypPovinnéPopis
namestringano
activebooleanano
htmlstringano

LandingPageSummary

PoleTypPovinnéPopis
idstringano
namestringano
activebooleananoAn inactive page answers 404 on its address.
urlstringanoThe public address on the link domain.
createdAtstringano
updatedAtstringano

LintIssue

PoleTypPovinnéPopis
codeone of: subject_missing, subject_too_long, content_empty, unknown_tag, foreign_tag, script_tag, script_error, unsupported_filter, bad_fallback, emoji, forbidden_word, image_placeholder, image_data_uri, banned_host, html_too_large, no_unsubscribe, footer_incomplete, subject_long, img_without_alt, insecure_image, image_too_large, image_foreign_host, text_image_ratioano
severityLintSeverityanoErrors block the approval of a campaign; warnings do not.
paramsmap of string or numberano

LintRequest

PoleTypPovinnéPopis
htmlstringano
subjectstringano
preheaderstringano

LintSeverity

one of: error, warning

MagicBackground

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

PoleTypPovinnéPopis
typeone of: color, gradient, imageano
fromstringne
tostringne
anglenumberneGradient direction in degrees (180 = top to bottom).
imagestringne
fitone of: cover, repeat, originalnePicture: cover the area, tile, or the original size once.

MagicStyles

PoleTypPovinnéPopis
paddingBoxPaddingneSpace around the e-mail body, desktop and mobile.
paddingMobileBoxPaddingne
darkModebooleanneDark mode in the recipient's app (prefers-color-scheme) with its colours.
darkBackgroundColorstringne
darkContentColorstringne
darkTextColorstringne
darkHeadingColorstringne
darkLinkColorstringne
darkButtonColorstringneDark mode colours of the buttons and the divider (SE: every colour has its "(tmavé schéma)" variant).
darkButtonTextColorstringne
darkButton2Colorstringne
darkButton2TextColorstringne
darkDividerColorstringne
backgroundMagicBackgroundneSE "Typ pozadí" of the e-mail (around the body) and of the body: a gradient or a picture over the colour (backgroundColor / contentColor stay the fallback of clients without head styles).
bodyBackgroundMagicBackgroundne
button2ColorstringneSecondary button and divider colours.
button2TextColorstringne
button2BorderColorstringne
buttonBorderColorstringne
dividerColorstringne
footerDefaultbooleanneSystem footer (SmartEmailing "Patička"): its own default look instead of the e-mail's, and no background.
footerTransparentbooleanne
textobjectneText styles per kind; missing keys = defaults. Mobile values override desktop ones under 480 px.
textMobileobjectne
defaultsobjectneDefaults of new elements (SmartEmailing "Prvky").

ScriptTemplate

A script template (SmartEmailing "Šablony skriptů"): a reusable piece of template script.

PoleTypPovinnéPopis
idstringano
namestringano
contentstringano
parsesbooleananoThe piece is a complete script by itself (half of a pair is allowed too).
createdAtstringano
updatedAtstringano

ScriptTemplateInput

PoleTypPovinnéPopis
namestringano
contentstringano

SmsTemplate

PoleTypPovinnéPopis
idstringano
lengthnumberanoThe counter of the server (screens/sms/smsModel.ts gives the same).
partsnumberano
capacitynumberano
encodingone of: gsm, ucs2ano
createdAtstringano
updatedAtstringano
namestringano
bodystringano
stripDiacriticsbooleananoOdeslat bez diakritiky: the text goes without accents (GSM 7-bit).

SmsTemplateInput

PoleTypPovinnéPopis
namestringano
bodystringano
stripDiacriticsbooleananoOdeslat bez diakritiky: the text goes without accents (GSM 7-bit).

SpamCheck

POST /content/spam-check: Poštárna's own antispam rules (SmartEmailing's "Antispamová kontrola: X / 5").

PoleTypPovinnéPopis
scorenumberano
verdictone of: ok, spam, blockedano
sizeKbnumberano
rulesarray of objectanofound = what the rule found in the content (phrases, hosts, domains, HTML tags), at most 5.

StockPhoto

PoleTypPovinnéPopis
idstringano
pageUrlstringano
tagsstringano
typestringano
previewUrlstringano
previewWidthnumberano
previewHeightnumberano
webformatUrlstringano
webformatWidthnumberano
webformatHeightnumberano
largeImageUrlstringano
imageWidthnumberano
imageHeightnumberano
viewsnumberano
downloadsnumberano
likesnumberano
userstringano
userUrlstringano

StockPhotoSaved

PoleTypPovinnéPopis
fileStoredFileano
photoobjectano
existingbooleanano

StockResult

PoleTypPovinnéPopis
totalnumberano
totalHitsnumberano
pagenumberano
perPagenumberano
hitsarray of StockPhotoano
sourcestringano
sourceUrlstringano

StockStatus

Fotobanka of the image library (Pixabay through Poštárna's server, one platform key).

PoleTypPovinnéPopis
configuredbooleanano
sourcestringano
sourceUrlstringano

StoredFile

PoleTypPovinnéPopis
idstringano
namestringano
folderIdstring or nullano
contentTypestringano
sizenumberano
widthnumber or nullanoPictures only.
heightnumber or nullano
urlstringanoStable public address on the link domain: renaming or moving the file keeps it.
createdAtstringano
pickedAtstring or nullneLast time the editor chose it (Zvolit obrázek); null = never.
sourceFileSource or nullneWhere a picture of the photo bank comes from (Pixabay, its page and author); null for own files.

StoredFileDetail

PoleTypPovinnéPopis
usageobjectanoTemplates and draft campaigns whose content names the address (shown before a delete).
idstringano
namestringano
folderIdstring or nullano
contentTypestringano
sizenumberano
widthnumber or nullanoPictures only.
heightnumber or nullano
urlstringanoStable public address on the link domain: renaming or moving the file keeps it.
createdAtstringano
pickedAtstring or nullneLast time the editor chose it (Zvolit obrázek); null = never.
sourceFileSource or nullneWhere a picture of the photo bank comes from (Pixabay, its page and author); null for own files.

Survey

PoleTypPovinnéPopis
idstringano
namestringano
activebooleananoAn inactive survey answers 404.
urlstringanoAnonymous public page.
linkTagstringano{{surveylink_<id>}}: each recipient's own link in an e-mail.
questionsnumberano
responsesnumberne
createdAtstringano
updatedAtstringano
titlestringano
introstringano
pagesarray of SurveyPageano
thanksHtmlstringano
afterUrlstringanoAddress after the last page instead of the thank-you text.
oneResponsebooleananoOne contact answers once (the recipient's link).

SurveyPage

PoleTypPovinnéPopis
questionsarray of SurveyQuestionano

SurveyQuestion

PoleTypPovinnéPopis
idstringano'q' + digits, stable: the answers are kept under it.
typeone of: number, date, short_text, long_text, single, multiple, dropdown, scale, starsano
labelstringano
helpstringano
requiredbooleanano
optionsarray of stringnesingle, multiple, dropdown.
minnumber or nullnescale (0 or 1 to 3..10), stars (1 to 5), number (optional range).
maxnumber or nullne
minLabelstringne
maxLabelstringne

SurveyResponse

PoleTypPovinnéPopis
idstringano
contactIdstring or nullano
emailstringano
answersmap of string or number or array of stringano
submittedAtstringano

SurveyResults

PoleTypPovinnéPopis
totalnumberano
questionsarray of objectano

SurveySummary

PoleTypPovinnéPopis
idstringano
namestringano
activebooleanano
urlstringanoAnonymous public page.
linkTagstringano{{surveylink_<id>}}: each recipient's own link in an e-mail.
questionsnumberano
responsesnumberne
createdAtstringano
updatedAtstringano

TemplateActiveUses

SE "Kryjeme vám záda": active automations (and their e-mails) sending the template, running campaigns made of it.

PoleTypPovinnéPopis
automationsnumberano
emailsnumberano
campaignsnumberano

TemplateCheck

Result of the content check stored with every save (server rules with the tenant's).

PoleTypPovinnéPopis
errorsarray of one of: subject_missing, subject_too_long, content_empty, unknown_tag, foreign_tag, script_tag, script_error, unsupported_filter, bad_fallback, emoji, forbidden_word, image_placeholder, image_data_uri, banned_host, html_too_large, no_unsubscribe, footer_incomplete, subject_long, img_without_alt, insecure_image, image_too_large, image_foreign_host, text_image_ratioano
warningsarray of one of: subject_missing, subject_too_long, content_empty, unknown_tag, foreign_tag, script_tag, script_error, unsupported_filter, bad_fallback, emoji, forbidden_word, image_placeholder, image_data_uri, banned_host, html_too_large, no_unsubscribe, footer_incomplete, subject_long, img_without_alt, insecure_image, image_too_large, image_foreign_host, text_image_ratioano
checkedAtstring or nullano

TemplateDetail

PoleTypPovinnéPopis
contentEmailContentanoWhat the editor opens: the draft of a template in use, else the published content.
settingsTemplateSettingsano
draftobjectanoA template that active automations send keeps its published content; the editor saves a draft until it is published with the password (POST /templates/{id}/publish) or thrown away (DELETE /templates/{id}/draft).
activeUsesTemplateActiveUsesano
publicUrlstringanoVeřejný náhled: a public page with the content (merge tags unfilled).
idstringano
namestringano
subjectstringano
preheaderstringano
editorone of: visual, htmlano
createdAtstringano
updatedAtstringano
tagsarray of stringano
sizenumberanoSize of the HTML in bytes (Gmail clips messages over 102 kB).
archivedbooleananoArchived templates are not offered for new campaigns; they can be duplicated or restored.
archivedAtstring or nullano
readOnlybooleananoArchive copy of an imported SmartEmailing original: content, name and tags never change, no delete or restore.
usageobjectanoCampaigns made from the template and e-mail nodes of automations naming it.
lastUsedAtstring or nullanoNewest such campaign or automation e-mail.
checkTemplateCheckano

TemplateInput

PoleTypPovinnéPopis
namestringano
subjectstringano
preheaderstringano
tagsarray of stringne
contentobjectanoA copy of a design: a starter, a campaign or another template.

TemplatePatch

PATCH /templates/{id}: name, subject, preheader, tags and the e-mail settings (any of them).

PoleTypPovinnéPopis
namestringne
tagsarray of stringne
subjectstringne
preheaderstringne
linkParamsarray of CampaignLinkParamneGoogle Analytics parameters added to links of the e-shop (as a campaign's linkParams).
headersarray of CampaignHeaderneOwn e-mail headers (X-...).
unsubscribePageIdstring or nullneNull = the default unsubscribe page.
footerIdstring or nullneNull = the default footer of the editor.

TemplatePublishInput

object

TemplateSettings

Nastavení e-mailu of a template (migration 0231): Data a statistiky, the unsubscribe page and the footer.

PoleTypPovinnéPopis
linkParamsarray of CampaignLinkParamanoGoogle Analytics parameters added to links of the e-shop (as a campaign's linkParams).
headersarray of CampaignHeaderanoOwn e-mail headers (X-...).
unsubscribePageIdstring or nullanoNull = the default unsubscribe page.
footerIdstring or nullanoNull = the default footer of the editor.

TemplateSummary

PoleTypPovinnéPopis
idstringano
namestringano
subjectstringano
preheaderstringano
editorone of: visual, htmlano
createdAtstringano
updatedAtstringano
tagsarray of stringano
sizenumberanoSize of the HTML in bytes (Gmail clips messages over 102 kB).
archivedbooleananoArchived templates are not offered for new campaigns; they can be duplicated or restored.
archivedAtstring or nullano
readOnlybooleananoArchive copy of an imported SmartEmailing original: content, name and tags never change, no delete or restore.
usageobjectanoCampaigns made from the template and e-mail nodes of automations naming it.
lastUsedAtstring or nullanoNewest such campaign or automation e-mail.
checkTemplateCheckano

TestSendResult

PoleTypPovinnéPopis
tostringano
sentAtstringano

UnsubscribePage

PoleTypPovinnéPopis
idstringano
isDefaultbooleananoServes every unsubscribe link of the tenant (Poštárna; without one the standard page).
createdAtstringano
updatedAtstringano
namestringano
activebooleananoActive pages may be the default; an active page cannot be deleted.
modeone of: page, redirectanopage = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl.
redirectUrlstringano
logoUrlstringano
videoUrlstringanoYouTube only.
languageone of: cs, sk, auto, en, pl, de, hu, it, ro, ukano
customHtmlstringano
questionEnabledbooleanano
questionstringano
answersarray of stringano
afterUrlstringanoPřesměrování po odhlášení ('' = the thank-you page); merge tags of the contact allowed.

VideoThumbnail

POST .../files/video-thumbnail: the preview picture of a YouTube or Vimeo video, kept in the file manager.

PoleTypPovinnéPopis
fileStoredFileano
providerone of: youtube, vimeoano
videoIdstringano
videoUrlstringano
titlestringano