Preskočiť na obsah
API dokumentácia

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á referencia je v angličtine (rovnako ako strojovo čitateľný dokument OpenAPI). Celú skupinu pre AI agenta načítate z /api/openapi.json?tag=Templates.

Prihlásenie: Authorization: Bearer pst_... alebo HTTP Basic (e-mail člena firmy a API kľúč).

Operácie

MetódaCestaPopis
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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo 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).

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
htmlstringáno
subjectstringáno
preheaderstringáno

Odpovede

  • 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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo 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.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
htmlstringáno
subjectstringáno
preheaderstringáno

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom 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.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringáno
categorystringnie
kindEditorElementKindáno
mjmlstringáno

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the element (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
categorystringnie
mjmlstringnie

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the element (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringáno
parentIdstring or nulláno

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the folder (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
parentIdstring or nullnie

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the folder (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo 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.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.
folderIdquerystringnie
pagequeryintegerniePage number, from 1. default 1, min 1
pageSizequeryintegernieItems per page, 1 to 100. default 25, min 1, max 100
qquerystringnieSearch text (case and diacritics insensitive). max 200 chars
recentquerystringnie
sortquerystringnieSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).
typequerystringnie

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (multipart/form-data)

PoleTypPovinnéPopis
filestring (binary)ánoThe file.

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom 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}.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json): Required by the server: id.

PoleTypPovinnéPopis
idstringáno
sizeone of: large, webnie
folderIdstring or nullnie

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom 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.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json): Required by the server: url.

PoleTypPovinnéPopis
urlstringáno
folderIdstring or nullnie

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the asset (string of digits).

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the asset (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
folderIdstring or nullnie

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the asset (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the asset (string of digits).

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.
editorquerystringnie
qquerystringnieSearch text (case and diacritics insensitive). max 200 chars
sortquerystringnieSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringáno
editorone of: visual, htmláno
htmlstringáno
designEmailDesign or nulláno

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the footer (string of digits).

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the footer (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringáno

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

204; 409 default for the default footer.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the footer (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the footer (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
editorone of: visual, htmláno
htmlstringáno
designEmailDesign or nulláno
baseVersionnumberánoThe version the editor started from; a newer one on the server answers 409 version (saved elsewhere meanwhile).
saveKindone of: manual, auto, restorenieHistory entry kind: auto (autosave, journaled), manual (Uložit), restore (a version taken back). Default auto.

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the footer (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
suffixstringáno

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the footer (string of digits).

Telo požiadavky (application/json)

object

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the footer (string of digits).

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the footer (string of digits).

Telo požiadavky (application/json)

object

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the footer (string of digits).
beforequerystringnie
limitquerystringnie

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the footer (string of digits).
version_idpathstringánoId of the version (string of digits).

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

{items: LandingPageSummary[]} without the HTML.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.
qquerystringnieSearch text (case and diacritics insensitive). max 200 chars
sortquerystringnieSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringáno
activebooleanáno
htmlstringáno

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the landing page (string of digits).

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the landing page (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
activebooleannie
htmlstringnie

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the landing page (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the landing page (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
suffixstringáno

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo 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).

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.
qquerystringnieSearch text (case and diacritics insensitive). max 200 chars
sortquerystringnieSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringáno
contentstringáno

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the script (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the script (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
contentstringnie

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the script (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.
qquerystringnieSearch text (case and diacritics insensitive). max 200 chars
sortquerystringnieSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringáno
bodystringáno
stripDiacriticsbooleanánoOdeslat bez diakritiky: the text goes without accents (GSM 7-bit).

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the sms template (string of digits).

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the sms template (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
bodystringnie
stripDiacriticsbooleannieOdeslat bez diakritiky: the text goes without accents (GSM 7-bit).

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the sms template (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the sms template (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
suffixstringáno

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo 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.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.
categoryquerystringnie
colorsquerystringnie
editorsChoicequerystringnie
imageTypequerystringnie
langquerystringnie
minHeightquerystringnie
minWidthquerystringnie
orderquerystringnie
orientationquerystringnie
pagequeryintegerniePage number, from 1. default 1, min 1
perPagequerystringnie
qquerystringnieSearch text (case and diacritics insensitive). max 200 chars

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.
qquerystringnieSearch text (case and diacritics insensitive). max 200 chars
sortquerystringnieSort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
activebooleannieAn inactive survey answers 404.
titlestringnie
introstringnie
pagesarray of SurveyPagenie
thanksHtmlstringnie
afterUrlstringnieAddress after the last page instead of the thank-you text.
oneResponsebooleannieOne contact answers once (the recipient's link).

Odpovede

  • 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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the survey (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the survey (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
activebooleannieAn inactive survey answers 404.
titlestringnie
introstringnie
pagesarray of SurveyPagenie
thanksHtmlstringnie
afterUrlstringnieAddress after the last page instead of the thank-you text.
oneResponsebooleannieOne contact answers once (the recipient's link).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the survey (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the survey (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
suffixstringáno

Odpovede

  • 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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the survey (string of digits).
pagequeryintegerniePage number, from 1. default 1, min 1
pageSizequeryintegernieItems per page, 1 to 100. default 25, min 1, max 100

Odpovede

  • 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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the survey (string of digits).

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo 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.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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, allnieStatus filter.

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom 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).

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringáno
subjectstringáno
preheaderstringáno
tagsarray of stringnie
contentobjectánoA copy of a design: a starter, a campaign or another template.

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json): Required by the server: ids.

PoleTypPovinnéPopis
idsarray of stringáno
addarray of stringnie
removearray of stringnie
tagsarray of stringnie

Odpovede

  • 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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: get_template

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full · Nástroj MCP: update_template (cez MCP len s náhľadom a potvrdením)

Changes name, subject, preheader or tags.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
tagsarray of stringnie
subjectstringnie
preheaderstringnie
linkParamsarray of CampaignLinkParamnieGoogle Analytics parameters added to links of the e-shop (as a campaign's linkParams).
headersarray of CampaignHeadernieOwn e-mail headers (X-...).
unsubscribePageIdstring or nullnieNull = the default unsubscribe page.
footerIdstring or nullnieNull = the default footer of the editor.

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full · Nástroj MCP: delete_template (cez MCP len s náhľadom a potvrdením)

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full · Nástroj MCP: archive_template

Archives a template.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).

Telo požiadavky (application/json)

object

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full · Nástroj MCP: save_template_content (cez MCP len s náhľadom a potvrdením)

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
editorone of: visual, htmláno
htmlstringáno
designEmailDesign or nulláno
baseVersionnumberánoThe version the editor started from; a newer one on the server answers 409 version (saved elsewhere meanwhile).
saveKindone of: manual, auto, restorenieHistory entry kind: auto (autosave, journaled), manual (Uložit), restore (a version taken back). Default auto.

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom 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).

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringáno

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full · Nástroj MCP: duplicate_template

Copies a template under a new name.

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).

Telo požiadavky (application/json)

object

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom 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.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).

Telo požiadavky (application/json)

TemplatePublishInput

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom 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.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
shopIdstringáno
tostringáno

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo 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.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).
beforequerystringnie
limitquerystringnie

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the template (string of digits).
version_idpathstringánoId of the version (string of digits).

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: list_test_recipients

Addresses that may receive test e-mails.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Odpovede

  • 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ávnenie: modul settings, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json): Required by the server: items.

PoleTypPovinnéPopis
itemsarray of stringáno

Odpovede

  • 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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
activebooleannieActive pages may be the default; an active page cannot be deleted.
modeone of: page, redirectniepage = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl.
redirectUrlstringnie
logoUrlstringnie
videoUrlstringnieYouTube only.
languageone of: cs, sk, auto, en, pl, de, hu, it, ro, uknie
customHtmlstringnie
questionEnabledbooleannie
questionstringnie
answersarray of stringnie
afterUrlstringniePřesměrování po odhlášení ('' = the thank-you page); merge tags of the contact allowed.

Odpovede

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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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.

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
activebooleannieActive pages may be the default; an active page cannot be deleted.
modeone of: page, redirectniepage = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl.
redirectUrlstringnie
logoUrlstringnie
videoUrlstringnieYouTube only.
languageone of: cs, sk, auto, en, pl, de, hu, it, ro, uknie
customHtmlstringnie
questionEnabledbooleannie
questionstringnie
answersarray of stringnie
afterUrlstringniePřesměrování po odhlášení ('' = the thank-you page); merge tags of the contact allowed.

Odpovede

  • 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ávnenie: modul content, úroveň read; kľúč s prístupom read alebo full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the unsub page (string of digits).

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

409 default when the default page would stop being active.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the unsub page (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
namestringnie
activebooleannieActive pages may be the default; an active page cannot be deleted.
modeone of: page, redirectniepage = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl.
redirectUrlstringnie
logoUrlstringnie
videoUrlstringnieYouTube only.
languageone of: cs, sk, auto, en, pl, de, hu, it, ro, uknie
customHtmlstringnie
questionEnabledbooleannie
questionstringnie
answersarray of stringnie
afterUrlstringniePřesměrování po odhlášení ('' = the thank-you page); merge tags of the contact allowed.

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the unsub page (string of digits).

Odpovede

  • 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ávnenie: modul content, úroveň full; kľúč s prístupom full

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

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the unsub page (string of digits).

Telo požiadavky (application/json)

PoleTypPovinnéPopis
suffixstringáno

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

409 active for an inactive page.

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the unsub page (string of digits).

Telo požiadavky (application/json)

object

Odpovede

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ávnenie: modul content, úroveň full; kľúč s prístupom full

Parametre

NázovKdeTypPovinnéPopis
tenantpathstring (uuid)ánoPublic 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_idpathstringánoId of the unsub page (string of digits).

Odpovede

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émy

BoxPadding

PoleTypPovinnéPopis
topnumberáno
rightnumberáno
bottomnumberáno
leftnumberáno

CampaignHeader

PoleTypPovinnéPopis
namestringáno
valuestringáno

CampaignLinkParam

PoleTypPovinnéPopis
namestringáno
valuestringáno

ContentVersion

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

PoleTypPovinnéPopis
idstringáno
versionnumberáno
kindone of: manual, auto, restoreáno
createdAtstringáno
createdBystring or nullánoName or e-mail of the user; null for the API or unknown.

ContentVersionDetail

PoleTypPovinnéPopis
contentobjectáno
idstringáno
versionnumberáno
kindone of: manual, auto, restoreáno
createdAtstringáno
createdBystring or nullánoName or e-mail of the user; null for the API or unknown.

ContentVersionList

PoleTypPovinnéPopis
itemsarray of ContentVersionáno
morebooleanáno

ConvertedTemplate

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

PoleTypPovinnéPopis
conversionobjectáno
contentEmailContentánoWhat the editor opens: the draft of a template in use, else the published content.
settingsTemplateSettingsáno
draftobjectánoA 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).
activeUsesTemplateActiveUsesáno
publicUrlstringánoVeřejný náhled: a public page with the content (merge tags unfilled).
idstringáno
namestringáno
subjectstringáno
preheaderstringáno
editorone of: visual, htmláno
createdAtstringáno
updatedAtstringáno
tagsarray of stringáno
sizenumberánoSize of the HTML in bytes (Gmail clips messages over 102 kB).
archivedbooleanánoArchived templates are not offered for new campaigns; they can be duplicated or restored.
archivedAtstring or nulláno
readOnlybooleanánoArchive copy of an imported SmartEmailing original: content, name and tags never change, no delete or restore.
usageobjectánoCampaigns made from the template and e-mail nodes of automations naming it.
lastUsedAtstring or nullánoNewest such campaign or automation e-mail.
checkTemplateCheckáno

EditorElement

PoleTypPovinnéPopis
idstringáno
namestringáno
categorystringáno
kindEditorElementKindáno
mjmlstringáno
createdAtstringáno
updatedAtstringáno

EditorElementInput

PoleTypPovinnéPopis
namestringáno
categorystringnie
kindEditorElementKindáno
mjmlstringáno

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, htmláno
htmlstringánoHTML with merge tags left in place (compiled from the design, or written by hand); the core personalises and sends it.
designEmailDesign or nullánoVisual editor only.
versionnumberáno0 = no content yet; every save adds one.
updatedAtstring or nulláno

EmailContentInput

PoleTypPovinnéPopis
editorone of: visual, htmláno
htmlstringáno
designEmailDesign or nulláno
baseVersionnumberánoThe version the editor started from; a newer one on the server answers 409 version (saved elsewhere meanwhile).
saveKindone of: manual, auto, restorenieHistory 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-1ánoFormat version; a later editor migrates older designs.
mjmlstringáno
stylesEmailStylesáno

EmailStyles

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

PoleTypPovinnéPopis
fontFamilystringánoOne of EMAIL_FONTS (web-safe stacks; recipients' clients have no web fonts by default).
headingFontFamilystringáno
fontSizenumberánoBase text size in px (12 to 20).
textColorstringáno
headingColorstringáno
linkColorstringáno
buttonColorstringáno
buttonTextColorstringáno
backgroundColorstringánoAround the e-mail.
contentColorstringánoBody of the e-mail.
widthnumberánoWidth of the e-mail in px (480 to 800).
magicMagicStylesnieSettings 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
errorobjectáno
json
{
  "error": {
    "code": "validation",
    "message": "email"
  }
}

FileFolder

PoleTypPovinnéPopis
idstringáno
namestringáno
parentIdstring or nullánonull = the root.
filesnumberánoFiles directly in the folder.
createdAtstringáno

FileSource

PoleTypPovinnéPopis
namestringáno
authorstringáno
authorUrlstringáno
pageUrlstringáno

FooterDetail

PoleTypPovinnéPopis
contentEmailContentáno
publishedHtmlstringánoThe copy e-mails end with ('' before the first Publikovat); the Magic editor shows it (PA-01).
idstringáno
namestringáno
editorone of: visual, htmlánovisual = Magic Editor list, html = Smart Editor list.
isDefaultbooleanánoE-mails of this editor end with it (instead of the e-shop's standard footer); at most one per editor.
publishedbooleanánoE-mails use only the published copy (Publikovat).
publishedAtstring or nulláno
unpublishedChangesbooleanánoThe draft differs from the published copy (or was never published).
gapsarray of FooterGapáno
createdAtstringáno
updatedAtstringáno
contentUpdatedAtstring or nulláno
publicUrlstringánoPublic preview of the draft (Zkopírovat veřejný odkaz).

FooterGap

one of: link, sender, loop, empty

FooterInput

PoleTypPovinnéPopis
namestringáno
editorone of: visual, htmláno
htmlstringáno
designEmailDesign or nulláno

FooterSummary

PoleTypPovinnéPopis
idstringáno
namestringáno
editorone of: visual, htmlánovisual = Magic Editor list, html = Smart Editor list.
isDefaultbooleanánoE-mails of this editor end with it (instead of the e-shop's standard footer); at most one per editor.
publishedbooleanánoE-mails use only the published copy (Publikovat).
publishedAtstring or nulláno
unpublishedChangesbooleanánoThe draft differs from the published copy (or was never published).
gapsarray of FooterGapáno
createdAtstringáno
updatedAtstringáno
contentUpdatedAtstring or nulláno
publicUrlstringánoPublic 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 stringáno
addarray of stringnie
removearray of stringnie
tagsarray of stringnie

LandingPage

PoleTypPovinnéPopis
htmlstringáno
idstringáno
namestringáno
activebooleanánoAn inactive page answers 404 on its address.
urlstringánoThe public address on the link domain.
createdAtstringáno
updatedAtstringáno

LandingPageInput

PoleTypPovinnéPopis
namestringáno
activebooleanáno
htmlstringáno

LandingPageSummary

PoleTypPovinnéPopis
idstringáno
namestringáno
activebooleanánoAn inactive page answers 404 on its address.
urlstringánoThe public address on the link domain.
createdAtstringáno
updatedAtstringáno

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_ratioáno
severityLintSeverityánoErrors block the approval of a campaign; warnings do not.
paramsmap of string or numberáno

LintRequest

PoleTypPovinnéPopis
htmlstringáno
subjectstringáno
preheaderstringáno

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, imageáno
fromstringnie
tostringnie
anglenumbernieGradient direction in degrees (180 = top to bottom).
imagestringnie
fitone of: cover, repeat, originalniePicture: cover the area, tile, or the original size once.

MagicStyles

PoleTypPovinnéPopis
paddingBoxPaddingnieSpace around the e-mail body, desktop and mobile.
paddingMobileBoxPaddingnie
darkModebooleannieDark mode in the recipient's app (prefers-color-scheme) with its colours.
darkBackgroundColorstringnie
darkContentColorstringnie
darkTextColorstringnie
darkHeadingColorstringnie
darkLinkColorstringnie
darkButtonColorstringnieDark mode colours of the buttons and the divider (SE: every colour has its "(tmavé schéma)" variant).
darkButtonTextColorstringnie
darkButton2Colorstringnie
darkButton2TextColorstringnie
darkDividerColorstringnie
backgroundMagicBackgroundnieSE "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).
bodyBackgroundMagicBackgroundnie
button2ColorstringnieSecondary button and divider colours.
button2TextColorstringnie
button2BorderColorstringnie
buttonBorderColorstringnie
dividerColorstringnie
footerDefaultbooleannieSystem footer (SmartEmailing "Patička"): its own default look instead of the e-mail's, and no background.
footerTransparentbooleannie
textobjectnieText styles per kind; missing keys = defaults. Mobile values override desktop ones under 480 px.
textMobileobjectnie
defaultsobjectnieDefaults of new elements (SmartEmailing "Prvky").

ScriptTemplate

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

PoleTypPovinnéPopis
idstringáno
namestringáno
contentstringáno
parsesbooleanánoThe piece is a complete script by itself (half of a pair is allowed too).
createdAtstringáno
updatedAtstringáno

ScriptTemplateInput

PoleTypPovinnéPopis
namestringáno
contentstringáno

SmsTemplate

PoleTypPovinnéPopis
idstringáno
lengthnumberánoThe counter of the server (screens/sms/smsModel.ts gives the same).
partsnumberáno
capacitynumberáno
encodingone of: gsm, ucs2áno
createdAtstringáno
updatedAtstringáno
namestringáno
bodystringáno
stripDiacriticsbooleanánoOdeslat bez diakritiky: the text goes without accents (GSM 7-bit).

SmsTemplateInput

PoleTypPovinnéPopis
namestringáno
bodystringáno
stripDiacriticsbooleanánoOdeslat 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
scorenumberáno
verdictone of: ok, spam, blockedáno
sizeKbnumberáno
rulesarray of objectánofound = what the rule found in the content (phrases, hosts, domains, HTML tags), at most 5.

StockPhoto

PoleTypPovinnéPopis
idstringáno
pageUrlstringáno
tagsstringáno
typestringáno
previewUrlstringáno
previewWidthnumberáno
previewHeightnumberáno
webformatUrlstringáno
webformatWidthnumberáno
webformatHeightnumberáno
largeImageUrlstringáno
imageWidthnumberáno
imageHeightnumberáno
viewsnumberáno
downloadsnumberáno
likesnumberáno
userstringáno
userUrlstringáno

StockPhotoSaved

PoleTypPovinnéPopis
fileStoredFileáno
photoobjectáno
existingbooleanáno

StockResult

PoleTypPovinnéPopis
totalnumberáno
totalHitsnumberáno
pagenumberáno
perPagenumberáno
hitsarray of StockPhotoáno
sourcestringáno
sourceUrlstringáno

StockStatus

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

PoleTypPovinnéPopis
configuredbooleanáno
sourcestringáno
sourceUrlstringáno

StoredFile

PoleTypPovinnéPopis
idstringáno
namestringáno
folderIdstring or nulláno
contentTypestringáno
sizenumberáno
widthnumber or nullánoPictures only.
heightnumber or nulláno
urlstringánoStable public address on the link domain: renaming or moving the file keeps it.
createdAtstringáno
pickedAtstring or nullnieLast time the editor chose it (Zvolit obrázek); null = never.
sourceFileSource or nullnieWhere a picture of the photo bank comes from (Pixabay, its page and author); null for own files.

StoredFileDetail

PoleTypPovinnéPopis
usageobjectánoTemplates and draft campaigns whose content names the address (shown before a delete).
idstringáno
namestringáno
folderIdstring or nulláno
contentTypestringáno
sizenumberáno
widthnumber or nullánoPictures only.
heightnumber or nulláno
urlstringánoStable public address on the link domain: renaming or moving the file keeps it.
createdAtstringáno
pickedAtstring or nullnieLast time the editor chose it (Zvolit obrázek); null = never.
sourceFileSource or nullnieWhere a picture of the photo bank comes from (Pixabay, its page and author); null for own files.

Survey

PoleTypPovinnéPopis
idstringáno
namestringáno
activebooleanánoAn inactive survey answers 404.
urlstringánoAnonymous public page.
linkTagstringáno{{surveylink_<id>}}: each recipient's own link in an e-mail.
questionsnumberáno
responsesnumbernie
createdAtstringáno
updatedAtstringáno
titlestringáno
introstringáno
pagesarray of SurveyPageáno
thanksHtmlstringáno
afterUrlstringánoAddress after the last page instead of the thank-you text.
oneResponsebooleanánoOne contact answers once (the recipient's link).

SurveyPage

PoleTypPovinnéPopis
questionsarray of SurveyQuestionáno

SurveyQuestion

PoleTypPovinnéPopis
idstringáno'q' + digits, stable: the answers are kept under it.
typeone of: number, date, short_text, long_text, single, multiple, dropdown, scale, starsáno
labelstringáno
helpstringáno
requiredbooleanáno
optionsarray of stringniesingle, multiple, dropdown.
minnumber or nullniescale (0 or 1 to 3..10), stars (1 to 5), number (optional range).
maxnumber or nullnie
minLabelstringnie
maxLabelstringnie

SurveyResponse

PoleTypPovinnéPopis
idstringáno
contactIdstring or nulláno
emailstringáno
answersmap of string or number or array of stringáno
submittedAtstringáno

SurveyResults

PoleTypPovinnéPopis
totalnumberáno
questionsarray of objectáno

SurveySummary

PoleTypPovinnéPopis
idstringáno
namestringáno
activebooleanáno
urlstringánoAnonymous public page.
linkTagstringáno{{surveylink_<id>}}: each recipient's own link in an e-mail.
questionsnumberáno
responsesnumbernie
createdAtstringáno
updatedAtstringáno

TemplateActiveUses

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

PoleTypPovinnéPopis
automationsnumberáno
emailsnumberáno
campaignsnumberáno

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_ratioáno
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_ratioáno
checkedAtstring or nulláno

TemplateDetail

PoleTypPovinnéPopis
contentEmailContentánoWhat the editor opens: the draft of a template in use, else the published content.
settingsTemplateSettingsáno
draftobjectánoA 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).
activeUsesTemplateActiveUsesáno
publicUrlstringánoVeřejný náhled: a public page with the content (merge tags unfilled).
idstringáno
namestringáno
subjectstringáno
preheaderstringáno
editorone of: visual, htmláno
createdAtstringáno
updatedAtstringáno
tagsarray of stringáno
sizenumberánoSize of the HTML in bytes (Gmail clips messages over 102 kB).
archivedbooleanánoArchived templates are not offered for new campaigns; they can be duplicated or restored.
archivedAtstring or nulláno
readOnlybooleanánoArchive copy of an imported SmartEmailing original: content, name and tags never change, no delete or restore.
usageobjectánoCampaigns made from the template and e-mail nodes of automations naming it.
lastUsedAtstring or nullánoNewest such campaign or automation e-mail.
checkTemplateCheckáno

TemplateInput

PoleTypPovinnéPopis
namestringáno
subjectstringáno
preheaderstringáno
tagsarray of stringnie
contentobjectánoA 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
namestringnie
tagsarray of stringnie
subjectstringnie
preheaderstringnie
linkParamsarray of CampaignLinkParamnieGoogle Analytics parameters added to links of the e-shop (as a campaign's linkParams).
headersarray of CampaignHeadernieOwn e-mail headers (X-...).
unsubscribePageIdstring or nullnieNull = the default unsubscribe page.
footerIdstring or nullnieNull = 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 CampaignLinkParamánoGoogle Analytics parameters added to links of the e-shop (as a campaign's linkParams).
headersarray of CampaignHeaderánoOwn e-mail headers (X-...).
unsubscribePageIdstring or nullánoNull = the default unsubscribe page.
footerIdstring or nullánoNull = the default footer of the editor.

TemplateSummary

PoleTypPovinnéPopis
idstringáno
namestringáno
subjectstringáno
preheaderstringáno
editorone of: visual, htmláno
createdAtstringáno
updatedAtstringáno
tagsarray of stringáno
sizenumberánoSize of the HTML in bytes (Gmail clips messages over 102 kB).
archivedbooleanánoArchived templates are not offered for new campaigns; they can be duplicated or restored.
archivedAtstring or nulláno
readOnlybooleanánoArchive copy of an imported SmartEmailing original: content, name and tags never change, no delete or restore.
usageobjectánoCampaigns made from the template and e-mail nodes of automations naming it.
lastUsedAtstring or nullánoNewest such campaign or automation e-mail.
checkTemplateCheckáno

TestSendResult

PoleTypPovinnéPopis
tostringáno
sentAtstringáno

UnsubscribePage

PoleTypPovinnéPopis
idstringáno
isDefaultbooleanánoServes every unsubscribe link of the tenant (Poštárna; without one the standard page).
createdAtstringáno
updatedAtstringáno
namestringáno
activebooleanánoActive pages may be the default; an active page cannot be deleted.
modeone of: page, redirectánopage = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl.
redirectUrlstringáno
logoUrlstringáno
videoUrlstringánoYouTube only.
languageone of: cs, sk, auto, en, pl, de, hu, it, ro, ukáno
customHtmlstringáno
questionEnabledbooleanáno
questionstringáno
answersarray of stringáno
afterUrlstringánoPř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
fileStoredFileáno
providerone of: youtube, vimeoáno
videoIdstringáno
videoUrlstringáno
titlestringáno