Templates and content
E-mail templates (HTML or the visual MJML editor), content versions, lint and spam check, footers, unsubscribe pages, saved editor elements, script templates (Twig), SMS templates, landing pages, surveys and the file manager.
Technická reference je anglicky (stejně jako strojově čitelný dokument OpenAPI). Celou skupinu pro AI agenta načtete z /api/openapi.json?tag=Templates.
Přihlášení: Authorization: Bearer pst_... nebo HTTP Basic (e-mail člena firmy a API klíč).
Operace
| Metoda | Cesta | Popis |
|---|---|---|
| POST | /api/v1/tenants/{tenant}/content/lint | Check e-mail content (merge tags, links, required parts) |
| POST | /api/v1/tenants/{tenant}/content/spam-check | Antispam check of e-mail content |
| GET | /api/v1/tenants/{tenant}/editor-elements | List saved editor elements |
| POST | /api/v1/tenants/{tenant}/editor-elements | Save 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-folders | List folders of the file manager |
| POST | /api/v1/tenants/{tenant}/file-folders | Create 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}/files | List files of the file manager |
| POST | /api/v1/tenants/{tenant}/files | Upload a file (multipart) |
| POST | /api/v1/tenants/{tenant}/files/stock-photo | Save a stock photo to the file manager |
| POST | /api/v1/tenants/{tenant}/files/video-thumbnail | Create 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}/picked | Record that a file was used |
| GET | /api/v1/tenants/{tenant}/footers | List footers |
| POST | /api/v1/tenants/{tenant}/footers | Create 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}/content | Save the content of a footer |
| POST | /api/v1/tenants/{tenant}/footers/{footer_id}/copy | Copy a footer |
| POST | /api/v1/tenants/{tenant}/footers/{footer_id}/default | Make a footer the default |
| DELETE | /api/v1/tenants/{tenant}/footers/{footer_id}/default | Stop using a footer as the default |
| POST | /api/v1/tenants/{tenant}/footers/{footer_id}/publish | Publish a footer |
| GET | /api/v1/tenants/{tenant}/footers/{footer_id}/versions | List 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-pages | List landing pages |
| POST | /api/v1/tenants/{tenant}/landing-pages | Create 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}/copy | Copy a landing page |
| GET | /api/v1/tenants/{tenant}/script-templates | List script templates (Twig) |
| POST | /api/v1/tenants/{tenant}/script-templates | Create 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-templates | List SMS templates |
| POST | /api/v1/tenants/{tenant}/sms-templates | Create 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}/copy | Copy an SMS template |
| GET | /api/v1/tenants/{tenant}/stock-photos | Search stock photos |
| GET | /api/v1/tenants/{tenant}/stock-photos/status | Whether the stock photo search is available |
| GET | /api/v1/tenants/{tenant}/surveys | List surveys |
| POST | /api/v1/tenants/{tenant}/surveys | Create 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}/copy | Copy a survey |
| GET | /api/v1/tenants/{tenant}/surveys/{survey_id}/responses | List responses of a survey |
| GET | /api/v1/tenants/{tenant}/surveys/{survey_id}/results | Summary results of a survey |
| GET | /api/v1/tenants/{tenant}/templates | List templates |
| POST | /api/v1/tenants/{tenant}/templates | Create a template |
| POST | /api/v1/tenants/{tenant}/templates/tags | Change 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}/archive | Archive a template |
| PUT | /api/v1/tenants/{tenant}/templates/{template_id}/content | Save the content of a template |
| POST | /api/v1/tenants/{tenant}/templates/{template_id}/convert-to-visual | Convert an HTML template to the visual editor |
| DELETE | /api/v1/tenants/{tenant}/templates/{template_id}/draft | Discard the unpublished draft of a template |
| POST | /api/v1/tenants/{tenant}/templates/{template_id}/duplicate | Duplicate a template |
| POST | /api/v1/tenants/{tenant}/templates/{template_id}/publish | Publish the draft of a template used by an active automation |
| POST | /api/v1/tenants/{tenant}/templates/{template_id}/test | Send a test e-mail of a template |
| POST | /api/v1/tenants/{tenant}/templates/{template_id}/unarchive | Restore an archived template |
| GET | /api/v1/tenants/{tenant}/templates/{template_id}/versions | List 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-recipients | List the test addresses of the company |
| PUT | /api/v1/tenants/{tenant}/test-recipients | Replace the test addresses of the company |
| GET | /api/v1/tenants/{tenant}/unsubscribe-pages | List unsubscribe pages |
| POST | /api/v1/tenants/{tenant}/unsubscribe-pages | Create an unsubscribe page |
| POST | /api/v1/tenants/{tenant}/unsubscribe-pages/preview | Render 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}/copy | Copy an unsubscribe page |
| POST | /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/default | Make an unsubscribe page the default |
| DELETE | /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/default | Stop using an unsubscribe page as the default |
Check e-mail content (merge tags, links, required parts)
POST /api/v1/tenants/{tenant}/content/lint
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: lint_content
Checks e-mail content (merge tags, emoji rules, footer, size, scripts) and answers issue codes.
Body {html, subject, preheader}: {issues: [{code, severity, params}]}, errors first (codes only).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
html | string | ano | |
subject | string | ano | |
preheader | string | ano |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | html, subject |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Antispam check of e-mail content
POST /api/v1/tenants/{tenant}/content/spam-check
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Body {html, subject, preheader}: {score, verdict (ok | spam | blocked), sizeKb, rules: [{code, points, found?}]} of Poštárna's own antispam rules (core/spam_check.py, SmartEmailing's "Antispamová kontrola: X / 5"); found = the phrases, hosts, domains or tags a rule found.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
html | string | ano | |
subject | string | ano | |
preheader | string | ano |
Odpovědi
- 200 OK:
application/jsonSpamCheck
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | html, subject |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List saved editor elements
GET /api/v1/tenants/{tenant}/editor-elements
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
{items: [{id, name, category, kind, mjml, createdAt, updatedAt}]} by category, then name.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Save an editor element
POST /api/v1/tenants/{tenant}/editor-elements
Oprávnění: modul content, úroveň full; klíč s přístupem full
Body {name, category?, kind, mjml}: 201 with the element; 409 conflict name (taken in the category), 400 validation limit (500 elements per tenant) or the field.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
category | string | ne | |
kind | EditorElementKind | ano | |
mjml | string | ano |
Odpovědi
- 201 Created:
application/jsonEditorElement
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Update a saved editor element
PATCH /api/v1/tenants/{tenant}/editor-elements/{element_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Body {name?, category?, mjml?}: the element.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
element_id | path | string | ano | Id of the element (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
category | string | ne | |
mjml | string | ne |
Odpovědi
- 200 OK:
application/jsonEditorElement
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Delete a saved editor element
DELETE /api/v1/tenants/{tenant}/editor-elements/{element_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
element_id | path | string | ano | Id of the element (string of digits). |
Odpovědi
- 204 No content
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List folders of the file manager
GET /api/v1/tenants/{tenant}/file-folders
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Create a folder
POST /api/v1/tenants/{tenant}/file-folders
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
parentId | string or null | ano |
Odpovědi
- 201 Created:
application/jsonFileFolder
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. | |
| 503 | unavailable | storage |
Rename a folder
PATCH /api/v1/tenants/{tenant}/file-folders/{folder_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
folder_id | path | string | ano | Id of the folder (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
parentId | string or null | ne |
Odpovědi
- 200 OK:
application/jsonFileFolder
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. | |
| 503 | unavailable | storage |
Delete a folder
DELETE /api/v1/tenants/{tenant}/file-folders/{folder_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
folder_id | path | string | ano | Id of the folder (string of digits). |
Odpovědi
- 204 No content
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. | |
| 503 | unavailable | storage |
List files of the file manager
GET /api/v1/tenants/{tenant}/files
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
?folderId= (empty or missing = the root), ?q= (name contains, all folders), ?sort= name (default), -name, created, -created, size, -size, ?type=image (pictures only), ?recent=1 (files picked into an e-mail, newest pick first, all folders: folderId and sort are ignored), page, pageSize.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
folderId | query | string | ne | |
page | query | integer | ne | Page number, from 1. default 1, min 1 |
pageSize | query | integer | ne | Items per page, 1 to 100. default 25, min 1, max 100 |
q | query | string | ne | Search text (case and diacritics insensitive). max 200 chars |
recent | query | string | ne | |
sort | query | string | ne | Sort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id). |
type | query | string | ne |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | recent, sort, type |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. | |
| 503 | unavailable | storage |
Upload a file (multipart)
POST /api/v1/tenants/{tenant}/files
Oprávnění: modul content, úroveň full; klíč s přístupem full
multipart/form-data: file (one file), folderId (optional). 201 with the file.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (multipart/form-data)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
file | string (binary) | ano | The file. |
Odpovědi
- 201 Created:
application/jsonStoredFile
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | file |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. | |
| 503 | unavailable | storage |
Save a stock photo to the file manager
POST /api/v1/tenants/{tenant}/files/stock-photo
Oprávnění: modul content, úroveň full; klíč s přístupem full
Body {id, size?, folderId?}: the picture of the photo bank downloaded into the file manager (no hotlinking), in the root folder Fotobanka unless folderId is given; size large (1280 px, default) or web (640 px). An identical picture stored before is returned instead of a copy. 201 {file, photo: {id, pageUrl, user, userUrl}, existing}.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json): Required by the server: id.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
size | one of: large, web | ne | |
folderId | string or null | ne |
Odpovědi
- 201 Created:
application/jsonStockPhotoSaved
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | rate_limited | stock |
| 502 | upstream | stock |
| 503 | unavailable | stock, storage |
Create a video thumbnail image
POST /api/v1/tenants/{tenant}/files/video-thumbnail
Oprávnění: modul content, úroveň full; klíč s přístupem full
Body {url, folderId?}: the thumbnail of a YouTube or Vimeo video as a file (core/video_thumbs.py), in the root folder Videa unless folderId is given; an identical picture already stored is returned instead. 201 {file, provider, videoId, videoUrl, title}. 400 validation url (reason unsupported) for another address, 502 upstream url (reason not_found, http_<status>, network, too_large, invalid, host) when the picture cannot be fetched.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json): Required by the server: url.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
url | string | ano | |
folderId | string or null | ne |
Odpovědi
- 201 Created:
application/jsonVideoThumbnail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | url |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. | |
| 502 | upstream | url |
| 503 | unavailable | storage |
Get a file
GET /api/v1/tenants/{tenant}/files/{asset_id}
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
The file and its uses: {templates, campaigns} whose content names its address (shown before a delete).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
asset_id | path | string | ano | Id of the asset (string of digits). |
Odpovědi
- 200 OK:
application/jsonStoredFileDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Rename or move a file
PATCH /api/v1/tenants/{tenant}/files/{asset_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Body {name, folderId} (any of them): the address stays the same.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
asset_id | path | string | ano | Id of the asset (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
folderId | string or null | ne |
Odpovědi
- 200 OK:
application/jsonStoredFile
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. | |
| 503 | unavailable | storage |
Delete a file
DELETE /api/v1/tenants/{tenant}/files/{asset_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
asset_id | path | string | ano | Id of the asset (string of digits). |
Odpovědi
- 204 No content
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Record that a file was used
POST /api/v1/tenants/{tenant}/files/{asset_id}/picked
Oprávnění: modul content, úroveň full; klíč s přístupem full
The editor picked the file into an e-mail: picked_at = now (the library's recently used tab). The file.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
asset_id | path | string | ano | Id of the asset (string of digits). |
Odpovědi
- 200 OK:
application/jsonStoredFile
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List footers
GET /api/v1/tenants/{tenant}/footers
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
?editor=visual|html (default all), ?q= part of the name, ?sort= id, name, default with '-' for descending.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
editor | query | string | ne | |
q | query | string | ne | Search text (case and diacritics insensitive). max 200 chars |
sort | query | string | ne | Sort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id). |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | editor, sort |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Create a footer
POST /api/v1/tenants/{tenant}/footers
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
editor | one of: visual, html | ano | |
html | string | ano | |
design | EmailDesign or null | ano |
Odpovědi
- 201 Created:
application/jsonFooterDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Get a footer
GET /api/v1/tenants/{tenant}/footers/{footer_id}
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
footer_id | path | string | ano | Id of the footer (string of digits). |
Odpovědi
- 200 OK:
application/jsonFooterDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Rename a footer
PATCH /api/v1/tenants/{tenant}/footers/{footer_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
footer_id | path | string | ano | Id of the footer (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano |
Odpovědi
- 200 OK:
application/jsonFooterDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Delete a footer
DELETE /api/v1/tenants/{tenant}/footers/{footer_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
204; 409 default for the default footer.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
footer_id | path | string | ano | Id of the footer (string of digits). |
Odpovědi
- 204 No content
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Save the content of a footer
PUT /api/v1/tenants/{tenant}/footers/{footer_id}/content
Oprávnění: modul content, úroveň full; klíč s přístupem full
The draft as e-mail content {editor, html, design, baseVersion, saveKind}: EmailContent; 409 version.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
footer_id | path | string | ano | Id of the footer (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
editor | one of: visual, html | ano | |
html | string | ano | |
design | EmailDesign or null | ano | |
baseVersion | number | ano | The version the editor started from; a newer one on the server answers 409 version (saved elsewhere meanwhile). |
saveKind | one of: manual, auto, restore | ne | History entry kind: auto (autosave, journaled), manual (Uložit), restore (a version taken back). Default auto. |
Odpovědi
- 200 OK:
application/jsonEmailContent
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Copy a footer
POST /api/v1/tenants/{tenant}/footers/{footer_id}/copy
Oprávnění: modul content, úroveň full; klíč s přístupem full
Kopírovat patičku: body {suffix} (the word after the name, from the client's language, default 'kopie').
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
footer_id | path | string | ano | Id of the footer (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
suffix | string | ano |
Odpovědi
- 201 Created:
application/jsonFooterDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Make a footer the default
POST /api/v1/tenants/{tenant}/footers/{footer_id}/default
Oprávnění: modul content, úroveň full; klíč s přístupem full
Nastavit jako výchozí: 409 published for a footer that was never published.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
footer_id | path | string | ano | Id of the footer (string of digits). |
Tělo požadavku (application/json)
object
Odpovědi
- 200 OK:
application/jsonFooterDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Stop using a footer as the default
DELETE /api/v1/tenants/{tenant}/footers/{footer_id}/default
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
footer_id | path | string | ano | Id of the footer (string of digits). |
Odpovědi
- 200 OK:
application/jsonFooterDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Publish a footer
POST /api/v1/tenants/{tenant}/footers/{footer_id}/publish
Oprávnění: modul content, úroveň full; klíč s přístupem full
Publikovat: 409 incomplete with {gaps: [link, sender, loop, empty]}.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
footer_id | path | string | ano | Id of the footer (string of digits). |
Tělo požadavku (application/json)
object
Odpovědi
- 200 OK:
application/jsonFooterDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List saved versions of a footer
GET /api/v1/tenants/{tenant}/footers/{footer_id}/versions
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
footer_id | path | string | ano | Id of the footer (string of digits). |
before | query | string | ne | |
limit | query | string | ne |
Odpovědi
- 200 OK:
application/jsonContentVersionList
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Get one version of a footer
GET /api/v1/tenants/{tenant}/footers/{footer_id}/versions/{version_id}
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
footer_id | path | string | ano | Id of the footer (string of digits). |
version_id | path | string | ano | Id of the version (string of digits). |
Odpovědi
- 200 OK:
application/jsonContentVersionDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List landing pages
GET /api/v1/tenants/{tenant}/landing-pages
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
{items: LandingPageSummary[]} without the HTML.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
q | query | string | ne | Search text (case and diacritics insensitive). max 200 chars |
sort | query | string | ne | Sort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id). |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | sort |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Create a landing page
POST /api/v1/tenants/{tenant}/landing-pages
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
active | boolean | ano | |
html | string | ano |
Odpovědi
- 201 Created:
application/jsonLandingPage
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Get a landing page
GET /api/v1/tenants/{tenant}/landing-pages/{landing_page_id}
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
landing_page_id | path | string | ano | Id of the landing page (string of digits). |
Odpovědi
- 200 OK:
application/jsonLandingPage
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Update a landing page
PATCH /api/v1/tenants/{tenant}/landing-pages/{landing_page_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
landing_page_id | path | string | ano | Id of the landing page (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
active | boolean | ne | |
html | string | ne |
Odpovědi
- 200 OK:
application/jsonLandingPage
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Delete a landing page
DELETE /api/v1/tenants/{tenant}/landing-pages/{landing_page_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
landing_page_id | path | string | ano | Id of the landing page (string of digits). |
Odpovědi
- 204 No content
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Copy a landing page
POST /api/v1/tenants/{tenant}/landing-pages/{landing_page_id}/copy
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
landing_page_id | path | string | ano | Id of the landing page (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
suffix | string | ano |
Odpovědi
- 201 Created:
application/jsonLandingPage
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List script templates (Twig)
GET /api/v1/tenants/{tenant}/script-templates
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
{items: [{id, name, content, parses, createdAt, updatedAt}]}; ?q= (name or content contains), ?sort= id, name, content, createdAt, updatedAt with a leading '-' for descending (default -createdAt, SmartEmailing's grid).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
q | query | string | ne | Search text (case and diacritics insensitive). max 200 chars |
sort | query | string | ne | Sort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id). |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | sort |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Create a script template
POST /api/v1/tenants/{tenant}/script-templates
Oprávnění: modul content, úroveň full; klíč s přístupem full
Body {name, content}: 201 with the template; 409 conflict name, 400 validation (field or limit).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
content | string | ano |
Odpovědi
- 201 Created:
application/jsonScriptTemplate
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Get a script template
GET /api/v1/tenants/{tenant}/script-templates/{script_id}
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
script_id | path | string | ano | Id of the script (string of digits). |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Update a script template
PATCH /api/v1/tenants/{tenant}/script-templates/{script_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Body {name?, content?}: the template.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
script_id | path | string | ano | Id of the script (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
content | string | ne |
Odpovědi
- 200 OK:
application/jsonScriptTemplate
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Delete a script template
DELETE /api/v1/tenants/{tenant}/script-templates/{script_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
script_id | path | string | ano | Id of the script (string of digits). |
Odpovědi
- 204 No content
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List SMS templates
GET /api/v1/tenants/{tenant}/sms-templates
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
q | query | string | ne | Search text (case and diacritics insensitive). max 200 chars |
sort | query | string | ne | Sort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id). |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | sort |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Create an SMS template
POST /api/v1/tenants/{tenant}/sms-templates
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
body | string | ano | |
stripDiacritics | boolean | ano | Odeslat bez diakritiky: the text goes without accents (GSM 7-bit). |
Odpovědi
- 201 Created:
application/jsonSmsTemplate
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Get an SMS template
GET /api/v1/tenants/{tenant}/sms-templates/{sms_template_id}
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
sms_template_id | path | string | ano | Id of the sms template (string of digits). |
Odpovědi
- 200 OK:
application/jsonSmsTemplate
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Update an SMS template
PATCH /api/v1/tenants/{tenant}/sms-templates/{sms_template_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
sms_template_id | path | string | ano | Id of the sms template (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
body | string | ne | |
stripDiacritics | boolean | ne | Odeslat bez diakritiky: the text goes without accents (GSM 7-bit). |
Odpovědi
- 200 OK:
application/jsonSmsTemplate
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Delete an SMS template
DELETE /api/v1/tenants/{tenant}/sms-templates/{sms_template_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
sms_template_id | path | string | ano | Id of the sms template (string of digits). |
Odpovědi
- 204 No content
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Copy an SMS template
POST /api/v1/tenants/{tenant}/sms-templates/{sms_template_id}/copy
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
sms_template_id | path | string | ano | Id of the sms template (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
suffix | string | ano |
Odpovědi
- 201 Created:
application/jsonSmsTemplate
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Search stock photos
GET /api/v1/tenants/{tenant}/stock-photos
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Search of the photo bank (core/stock_photos.search_params): ?q, lang (cs, sk, en ...), imageType (all, photo, illustration, vector), orientation (all, horizontal, vertical), category, colors (comma separated), order (popular, latest), minWidth, minHeight, editorsChoice, page, perPage (3 to 200; at most 500 results). safesearch is always on. {total, totalHits, page, perPage, hits, source, sourceUrl}; the answers are cached for 24 hours.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
category | query | string | ne | |
colors | query | string | ne | |
editorsChoice | query | string | ne | |
imageType | query | string | ne | |
lang | query | string | ne | |
minHeight | query | string | ne | |
minWidth | query | string | ne | |
order | query | string | ne | |
orientation | query | string | ne | |
page | query | integer | ne | Page number, from 1. default 1, min 1 |
perPage | query | string | ne | |
q | query | string | ne | Search text (case and diacritics insensitive). max 200 chars |
Odpovědi
- 200 OK:
application/jsonStockResult
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | rate_limited | stock |
| 502 | upstream | stock |
| 503 | unavailable | stock |
Whether the stock photo search is available
GET /api/v1/tenants/{tenant}/stock-photos/status
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
{configured, source}: whether the photo bank has its key (the tab says it is not set up otherwise).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Odpovědi
- 200 OK:
application/jsonStockStatus
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List surveys
GET /api/v1/tenants/{tenant}/surveys
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
q | query | string | ne | Search text (case and diacritics insensitive). max 200 chars |
sort | query | string | ne | Sort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id). |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | sort |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Create a survey
POST /api/v1/tenants/{tenant}/surveys
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
active | boolean | ne | An inactive survey answers 404. |
title | string | ne | |
intro | string | ne | |
pages | array of SurveyPage | ne | |
thanksHtml | string | ne | |
afterUrl | string | ne | Address after the last page instead of the thank-you text. |
oneResponse | boolean | ne | One contact answers once (the recipient's link). |
Odpovědi
- 201 Created:
application/jsonSurvey
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Get a survey
GET /api/v1/tenants/{tenant}/surveys/{survey_id}
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
survey_id | path | string | ano | Id of the survey (string of digits). |
Odpovědi
- 200 OK:
application/jsonSurvey
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Update a survey
PATCH /api/v1/tenants/{tenant}/surveys/{survey_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
survey_id | path | string | ano | Id of the survey (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
active | boolean | ne | An inactive survey answers 404. |
title | string | ne | |
intro | string | ne | |
pages | array of SurveyPage | ne | |
thanksHtml | string | ne | |
afterUrl | string | ne | Address after the last page instead of the thank-you text. |
oneResponse | boolean | ne | One contact answers once (the recipient's link). |
Odpovědi
- 200 OK:
application/jsonSurvey
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Delete a survey
DELETE /api/v1/tenants/{tenant}/surveys/{survey_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
survey_id | path | string | ano | Id of the survey (string of digits). |
Odpovědi
- 204 No content
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Copy a survey
POST /api/v1/tenants/{tenant}/surveys/{survey_id}/copy
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
survey_id | path | string | ano | Id of the survey (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
suffix | string | ano |
Odpovědi
- 201 Created:
application/jsonSurvey
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List responses of a survey
GET /api/v1/tenants/{tenant}/surveys/{survey_id}/responses
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
?page=, ?pageSize= (at most 100): {items: [{id, contactId, email, answers, submittedAt}], total, page, pageSize}, newest first; email '' for an anonymous answer.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
survey_id | path | string | ano | Id of the survey (string of digits). |
page | query | integer | ne | Page number, from 1. default 1, min 1 |
pageSize | query | integer | ne | Items per page, 1 to 100. default 25, min 1, max 100 |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | page |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Summary results of a survey
GET /api/v1/tenants/{tenant}/surveys/{survey_id}/results
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
survey_id | path | string | ano | Id of the survey (string of digits). |
Odpovědi
- 200 OK:
application/jsonSurveyResults
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List templates
GET /api/v1/tenants/{tenant}/templates
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: list_templates
E-mail templates (status active, archived or all) with size, usage and the stored content check.
?status=active (default), archived or all.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
status | query | one of: active, archived, all | ne | Status filter. |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | status |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Create a template
POST /api/v1/tenants/{tenant}/templates
Oprávnění: modul content, úroveň full; klíč s přístupem full · Nástroj MCP: create_template
Creates a template with content {editor: html|visual, html, design}.
Body {name, subject, preheader, tags, content, saveKind?}: 201 with the template; its first content goes to the save history with saveKind (default auto).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
subject | string | ano | |
preheader | string | ano | |
tags | array of string | ne | |
content | object | ano | A copy of a design: a starter, a campaign or another template. |
Odpovědi
- 201 Created:
application/jsonTemplateDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | saveKind |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Change labels of templates
POST /api/v1/tenants/{tenant}/templates/tags
Oprávnění: modul content, úroveň full; klíč s přístupem full
Štítky of e-mail templates (SE ⋮ "Nastavit štítky", bulk "Přiřadit štítky").
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json): Required by the server: ids.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
ids | array of string | ano | |
add | array of string | ne | |
remove | array of string | ne | |
tags | array of string | ne |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | ids |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Get a template with its content
GET /api/v1/tenants/{tenant}/templates/{template_id}
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: get_template
One template with its content (editor, html, design, version).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
Odpovědi
- 200 OK:
application/jsonTemplateDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Update template settings (name, subject, preheader ...)
PATCH /api/v1/tenants/{tenant}/templates/{template_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full · Nástroj MCP: update_template (přes MCP jen s náhledem a potvrzením)
Changes name, subject, preheader or tags.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
tags | array of string | ne | |
subject | string | ne | |
preheader | string | ne | |
linkParams | array of CampaignLinkParam | ne | Google Analytics parameters added to links of the e-shop (as a campaign's linkParams). |
headers | array of CampaignHeader | ne | Own e-mail headers (X-...). |
unsubscribePageId | string or null | ne | Null = the default unsubscribe page. |
footerId | string or null | ne | Null = the default footer of the editor. |
Odpovědi
- 200 OK:
application/jsonTemplateDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Delete a template
DELETE /api/v1/tenants/{tenant}/templates/{template_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full · Nástroj MCP: delete_template (přes MCP jen s náhledem a potvrzením)
Deletes a template (campaigns keep their own copy of the content).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
Odpovědi
- 204 No content
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Archive a template
POST /api/v1/tenants/{tenant}/templates/{template_id}/archive
Oprávnění: modul content, úroveň full; klíč s přístupem full · Nástroj MCP: archive_template
Archives a template.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
Tělo požadavku (application/json)
object
Odpovědi
- 200 OK:
application/jsonTemplateDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Save the content of a template
PUT /api/v1/tenants/{tenant}/templates/{template_id}/content
Oprávnění: modul content, úroveň full; klíč s přístupem full · Nástroj MCP: save_template_content (přes MCP jen s náhledem a potvrzením)
Saves the HTML or MJML content of a template. baseVersion = the version you read (conflict when someone saved since).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
editor | one of: visual, html | ano | |
html | string | ano | |
design | EmailDesign or null | ano | |
baseVersion | number | ano | The version the editor started from; a newer one on the server answers 409 version (saved elsewhere meanwhile). |
saveKind | one of: manual, auto, restore | ne | History entry kind: auto (autosave, journaled), manual (Uložit), restore (a version taken back). Default auto. |
Odpovědi
- 200 OK:
application/jsonEmailContent
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Convert an HTML template to the visual editor
POST /api/v1/tenants/{tenant}/templates/{template_id}/convert-to-visual
Oprávnění: modul content, úroveň full; klíč s přístupem full · Nástroj MCP: convert_template_to_visual
Creates a NEW visual (block) template converted from an HTML template; the original stays. Answers the template and conversion {quality: clean|partial|raw, stats}.
Body {name} (optional, default "<name> (vizuální)"): a NEW visual template converted from an HTML template (core/html_to_mjml.py), 201 with the template and conversion {quality, stats}; the original stays as it is. 409 editor (not an HTML template), 409 content (nothing to convert), 409 name, 400 lint (banned hosts).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano |
Odpovědi
- 201 Created:
application/jsonConvertedTemplate
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Discard the unpublished draft of a template
DELETE /api/v1/tenants/{tenant}/templates/{template_id}/draft
Oprávnění: modul content, úroveň full; klíč s přístupem full
Zahodit změny: the draft goes, the published content stays (409 draft without one). Answers the template.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
Odpovědi
- 200 OK:
application/jsonTemplateDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Duplicate a template
POST /api/v1/tenants/{tenant}/templates/{template_id}/duplicate
Oprávnění: modul content, úroveň full; klíč s přístupem full · Nástroj MCP: duplicate_template
Copies a template under a new name.
Body {name}: the copy (active, writable), 201.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
Tělo požadavku (application/json)
object
Odpovědi
- 201 Created:
application/jsonTemplateDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Publish the draft of a template used by an active automation
POST /api/v1/tenants/{tenant}/templates/{template_id}/publish
Oprávnění: modul content, úroveň full; klíč s přístupem full
Body {password} (a person with a password) or {confirm: <template name>} (Google sign-in, API key): the draft of a template becomes the content its e-mails send (SE "Uložit a publikovat změny", a dangerous action that asks for the password). 401 invalid_credentials (wrong password, counted like a sign-in), 429 after too many, 400 confirm, 409 draft (nothing to publish), 400 lint (hard checks). Answers the template.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
Tělo požadavku (application/json)
Odpovědi
- 200 OK:
application/jsonTemplateDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | confirm |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Send a test e-mail of a template
POST /api/v1/tenants/{tenant}/templates/{template_id}/test
Oprávnění: modul content, úroveň full; klíč s přístupem full · Nástroj MCP: send_template_test
Sends a test e-mail of a template to the account's test addresses only (list_test_recipients), with [TEST] in the subject.
Body {shopId, to}: the shop gives the sender and the footer.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
shopId | string | ano | |
to | string | ano |
Odpovědi
- 200 OK:
application/jsonTestSendResult
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. | |
| 503 | unavailable |
Restore an archived template
POST /api/v1/tenants/{tenant}/templates/{template_id}/unarchive
Oprávnění: modul content, úroveň full; klíč s přístupem full
409 read_only for archive copies of imported originals, 409 lint (codes, hosts) for banned addresses.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
Odpovědi
- 200 OK:
application/jsonTemplateDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List saved content versions of a template
GET /api/v1/tenants/{tenant}/templates/{template_id}/versions
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
?before=<snapshot id>&limit=1..100 (default 50): {items: [{id, version, kind, createdAt, createdBy}], more}, newest first; createdBy = the saver's name or e-mail, null when not known.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
before | query | string | ne | |
limit | query | string | ne |
Odpovědi
- 200 OK:
application/jsonContentVersionList
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Get one content version of a template
GET /api/v1/tenants/{tenant}/templates/{template_id}/versions/{version_id}
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
One snapshot with content {editor, html, design}.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
template_id | path | string | ano | Id of the template (string of digits). |
version_id | path | string | ano | Id of the version (string of digits). |
Odpovědi
- 200 OK:
application/jsonContentVersionDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List the test addresses of the company
GET /api/v1/tenants/{tenant}/test-recipients
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full · Nástroj MCP: list_test_recipients
Addresses that may receive test e-mails.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Replace the test addresses of the company
PUT /api/v1/tenants/{tenant}/test-recipients
Oprávnění: modul settings, úroveň full; klíč s přístupem full
Body {items: [e-mail, ...]} (at most 20): the addresses test e-mails may go to (Nastavení › Odesílání).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json): Required by the server: items.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
items | array of string | ano |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List unsubscribe pages
GET /api/v1/tenants/{tenant}/unsubscribe-pages
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Create an unsubscribe page
POST /api/v1/tenants/{tenant}/unsubscribe-pages
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
active | boolean | ne | Active pages may be the default; an active page cannot be deleted. |
mode | one of: page, redirect | ne | page = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl. |
redirectUrl | string | ne | |
logoUrl | string | ne | |
videoUrl | string | ne | YouTube only. |
language | one of: cs, sk, auto, en, pl, de, hu, it, ro, uk | ne | |
customHtml | string | ne | |
questionEnabled | boolean | ne | |
question | string | ne | |
answers | array of string | ne | |
afterUrl | string | ne | Přesměrování po odhlášení ('' = the thank-you page); merge tags of the contact allowed. |
Odpovědi
- 201 Created:
application/jsonUnsubscribePage
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Render an unsubscribe page preview
POST /api/v1/tenants/{tenant}/unsubscribe-pages/preview
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
The page of unsaved settings ({name, ... as a create}) as HTML with sample values.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
active | boolean | ne | Active pages may be the default; an active page cannot be deleted. |
mode | one of: page, redirect | ne | page = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl. |
redirectUrl | string | ne | |
logoUrl | string | ne | |
videoUrl | string | ne | YouTube only. |
language | one of: cs, sk, auto, en, pl, de, hu, it, ro, uk | ne | |
customHtml | string | ne | |
questionEnabled | boolean | ne | |
question | string | ne | |
answers | array of string | ne | |
afterUrl | string | ne | Přesměrování po odhlášení ('' = the thank-you page); merge tags of the contact allowed. |
Odpovědi
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Get an unsubscribe page
GET /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}
Oprávnění: modul content, úroveň read; klíč s přístupem read nebo full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
unsub_page_id | path | string | ano | Id of the unsub page (string of digits). |
Odpovědi
- 200 OK:
application/jsonUnsubscribePage
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Update an unsubscribe page
PATCH /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
409 default when the default page would stop being active.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
unsub_page_id | path | string | ano | Id of the unsub page (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
active | boolean | ne | Active pages may be the default; an active page cannot be deleted. |
mode | one of: page, redirect | ne | page = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl. |
redirectUrl | string | ne | |
logoUrl | string | ne | |
videoUrl | string | ne | YouTube only. |
language | one of: cs, sk, auto, en, pl, de, hu, it, ro, uk | ne | |
customHtml | string | ne | |
questionEnabled | boolean | ne | |
question | string | ne | |
answers | array of string | ne | |
afterUrl | string | ne | Přesměrování po odhlášení ('' = the thank-you page); merge tags of the contact allowed. |
Odpovědi
- 200 OK:
application/jsonUnsubscribePage
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Delete an unsubscribe page
DELETE /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}
Oprávnění: modul content, úroveň full; klíč s přístupem full
204; 409 active for an active page (deactivate it first).
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
unsub_page_id | path | string | ano | Id of the unsub page (string of digits). |
Odpovědi
- 204 No content
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Copy an unsubscribe page
POST /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/copy
Oprávnění: modul content, úroveň full; klíč s přístupem full
An inactive copy; body {suffix} (default 'kopie').
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
unsub_page_id | path | string | ano | Id of the unsub page (string of digits). |
Tělo požadavku (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
suffix | string | ano |
Odpovědi
- 201 Created:
application/jsonUnsubscribePage
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Make an unsubscribe page the default
POST /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/default
Oprávnění: modul content, úroveň full; klíč s přístupem full
409 active for an inactive page.
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
unsub_page_id | path | string | ano | Id of the unsub page (string of digits). |
Tělo požadavku (application/json)
object
Odpovědi
- 200 OK:
application/jsonUnsubscribePage
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Stop using an unsubscribe page as the default
DELETE /api/v1/tenants/{tenant}/unsubscribe-pages/{unsub_page_id}/default
Oprávnění: modul content, úroveň full; klíč s přístupem full
Parametry
| Název | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | ano | Public id of the company (tenant), a UUID: GET /api/v3/account-info answers it as data.guid; the app shows it on the API keys page. |
unsub_page_id | path | string | ano | Id of the unsub page (string of digits). |
Odpovědi
- 200 OK:
application/jsonUnsubscribePage
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Schémata
BoxPadding
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
top | number | ano | |
right | number | ano | |
bottom | number | ano | |
left | number | ano |
CampaignHeader
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
value | string | ano |
CampaignLinkParam
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
value | string | ano |
ContentVersion
One entry of the content history (Historie uložení).
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
version | number | ano | |
kind | one of: manual, auto, restore | ano | |
createdAt | string | ano | |
createdBy | string or null | ano | Name or e-mail of the user; null for the API or unknown. |
ContentVersionDetail
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
content | object | ano | |
id | string | ano | |
version | number | ano | |
kind | one of: manual, auto, restore | ano | |
createdAt | string | ano | |
createdBy | string or null | ano | Name or e-mail of the user; null for the API or unknown. |
ContentVersionList
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
items | array of ContentVersion | ano | |
more | boolean | ano |
ConvertedTemplate
Result of POST /templates/{id}/convert-to-visual: the new template and how much of it became blocks.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
conversion | object | ano | |
content | EmailContent | ano | What the editor opens: the draft of a template in use, else the published content. |
settings | TemplateSettings | ano | |
draft | object | ano | A 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). |
activeUses | TemplateActiveUses | ano | |
publicUrl | string | ano | Veřejný náhled: a public page with the content (merge tags unfilled). |
id | string | ano | |
name | string | ano | |
subject | string | ano | |
preheader | string | ano | |
editor | one of: visual, html | ano | |
createdAt | string | ano | |
updatedAt | string | ano | |
tags | array of string | ano | |
size | number | ano | Size of the HTML in bytes (Gmail clips messages over 102 kB). |
archived | boolean | ano | Archived templates are not offered for new campaigns; they can be duplicated or restored. |
archivedAt | string or null | ano | |
readOnly | boolean | ano | Archive copy of an imported SmartEmailing original: content, name and tags never change, no delete or restore. |
usage | object | ano | Campaigns made from the template and e-mail nodes of automations naming it. |
lastUsedAt | string or null | ano | Newest such campaign or automation e-mail. |
check | TemplateCheck | ano |
EditorElement
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
name | string | ano | |
category | string | ano | |
kind | EditorElementKind | ano | |
mjml | string | ano | |
createdAt | string | ano | |
updatedAt | string | ano |
EditorElementInput
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
category | string | ne | |
kind | EditorElementKind | ano | |
mjml | string | ano |
EditorElementKind
one of: text, image, button, row, feed, logo, video, divider, spacer, section
EmailContent
E-mail content of a template or a campaign.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
editor | one of: visual, html | ano | |
html | string | ano | HTML with merge tags left in place (compiled from the design, or written by hand); the core personalises and sends it. |
design | EmailDesign or null | ano | Visual editor only. |
version | number | ano | 0 = no content yet; every save adds one. |
updatedAt | string or null | ano |
EmailContentInput
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
editor | one of: visual, html | ano | |
html | string | ano | |
design | EmailDesign or null | ano | |
baseVersion | number | ano | The version the editor started from; a newer one on the server answers 409 version (saved elsewhere meanwhile). |
saveKind | one of: manual, auto, restore | ne | History 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.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
format | mjml-1 | ano | Format version; a later editor migrates older designs. |
mjml | string | ano | |
styles | EmailStyles | ano |
EmailStyles
Global look of a visual design. The editor writes it as MJML attributes; every element can override it.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
fontFamily | string | ano | One of EMAIL_FONTS (web-safe stacks; recipients' clients have no web fonts by default). |
headingFontFamily | string | ano | |
fontSize | number | ano | Base text size in px (12 to 20). |
textColor | string | ano | |
headingColor | string | ano | |
linkColor | string | ano | |
buttonColor | string | ano | |
buttonTextColor | string | ano | |
backgroundColor | string | ano | Around the e-mail. |
contentColor | string | ano | Body of the e-mail. |
width | number | ano | Width of the e-mail in px (480 to 800). |
magic | MagicStyles | ne | Settings 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
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
error | object | ano |
{
"error": {
"code": "validation",
"message": "email"
}
}FileFolder
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
name | string | ano | |
parentId | string or null | ano | null = the root. |
files | number | ano | Files directly in the folder. |
createdAt | string | ano |
FileSource
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
author | string | ano | |
authorUrl | string | ano | |
pageUrl | string | ano |
FooterDetail
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
content | EmailContent | ano | |
publishedHtml | string | ano | The copy e-mails end with ('' before the first Publikovat); the Magic editor shows it (PA-01). |
id | string | ano | |
name | string | ano | |
editor | one of: visual, html | ano | visual = Magic Editor list, html = Smart Editor list. |
isDefault | boolean | ano | E-mails of this editor end with it (instead of the e-shop's standard footer); at most one per editor. |
published | boolean | ano | E-mails use only the published copy (Publikovat). |
publishedAt | string or null | ano | |
unpublishedChanges | boolean | ano | The draft differs from the published copy (or was never published). |
gaps | array of FooterGap | ano | |
createdAt | string | ano | |
updatedAt | string | ano | |
contentUpdatedAt | string or null | ano | |
publicUrl | string | ano | Public preview of the draft (Zkopírovat veřejný odkaz). |
FooterGap
one of: link, sender, loop, empty
FooterInput
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
editor | one of: visual, html | ano | |
html | string | ano | |
design | EmailDesign or null | ano |
FooterSummary
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
name | string | ano | |
editor | one of: visual, html | ano | visual = Magic Editor list, html = Smart Editor list. |
isDefault | boolean | ano | E-mails of this editor end with it (instead of the e-shop's standard footer); at most one per editor. |
published | boolean | ano | E-mails use only the published copy (Publikovat). |
publishedAt | string or null | ano | |
unpublishedChanges | boolean | ano | The draft differs from the published copy (or was never published). |
gaps | array of FooterGap | ano | |
createdAt | string | ano | |
updatedAt | string | ano | |
contentUpdatedAt | string or null | ano | |
publicUrl | string | ano | Public preview of the draft (Zkopírovat veřejný odkaz). |
GridTagsInput
Bulk label change: add and remove, or tags = the new labels of every row.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
ids | array of string | ano | |
add | array of string | ne | |
remove | array of string | ne | |
tags | array of string | ne |
LandingPage
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
html | string | ano | |
id | string | ano | |
name | string | ano | |
active | boolean | ano | An inactive page answers 404 on its address. |
url | string | ano | The public address on the link domain. |
createdAt | string | ano | |
updatedAt | string | ano |
LandingPageInput
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
active | boolean | ano | |
html | string | ano |
LandingPageSummary
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
name | string | ano | |
active | boolean | ano | An inactive page answers 404 on its address. |
url | string | ano | The public address on the link domain. |
createdAt | string | ano | |
updatedAt | string | ano |
LintIssue
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
code | 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 | ano | |
severity | LintSeverity | ano | Errors block the approval of a campaign; warnings do not. |
params | map of string or number | ano |
LintRequest
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
html | string | ano | |
subject | string | ano | |
preheader | string | ano |
LintSeverity
one of: error, warning
MagicBackground
A background of the Magic editor: a plain colour, a linear gradient or a picture (https).
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
type | one of: color, gradient, image | ano | |
from | string | ne | |
to | string | ne | |
angle | number | ne | Gradient direction in degrees (180 = top to bottom). |
image | string | ne | |
fit | one of: cover, repeat, original | ne | Picture: cover the area, tile, or the original size once. |
MagicStyles
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
padding | BoxPadding | ne | Space around the e-mail body, desktop and mobile. |
paddingMobile | BoxPadding | ne | |
darkMode | boolean | ne | Dark mode in the recipient's app (prefers-color-scheme) with its colours. |
darkBackgroundColor | string | ne | |
darkContentColor | string | ne | |
darkTextColor | string | ne | |
darkHeadingColor | string | ne | |
darkLinkColor | string | ne | |
darkButtonColor | string | ne | Dark mode colours of the buttons and the divider (SE: every colour has its "(tmavé schéma)" variant). |
darkButtonTextColor | string | ne | |
darkButton2Color | string | ne | |
darkButton2TextColor | string | ne | |
darkDividerColor | string | ne | |
background | MagicBackground | ne | SE "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). |
bodyBackground | MagicBackground | ne | |
button2Color | string | ne | Secondary button and divider colours. |
button2TextColor | string | ne | |
button2BorderColor | string | ne | |
buttonBorderColor | string | ne | |
dividerColor | string | ne | |
footerDefault | boolean | ne | System footer (SmartEmailing "Patička"): its own default look instead of the e-mail's, and no background. |
footerTransparent | boolean | ne | |
text | object | ne | Text styles per kind; missing keys = defaults. Mobile values override desktop ones under 480 px. |
textMobile | object | ne | |
defaults | object | ne | Defaults of new elements (SmartEmailing "Prvky"). |
ScriptTemplate
A script template (SmartEmailing "Šablony skriptů"): a reusable piece of template script.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
name | string | ano | |
content | string | ano | |
parses | boolean | ano | The piece is a complete script by itself (half of a pair is allowed too). |
createdAt | string | ano | |
updatedAt | string | ano |
ScriptTemplateInput
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
content | string | ano |
SmsTemplate
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
length | number | ano | The counter of the server (screens/sms/smsModel.ts gives the same). |
parts | number | ano | |
capacity | number | ano | |
encoding | one of: gsm, ucs2 | ano | |
createdAt | string | ano | |
updatedAt | string | ano | |
name | string | ano | |
body | string | ano | |
stripDiacritics | boolean | ano | Odeslat bez diakritiky: the text goes without accents (GSM 7-bit). |
SmsTemplateInput
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
body | string | ano | |
stripDiacritics | boolean | ano | Odeslat 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").
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
score | number | ano | |
verdict | one of: ok, spam, blocked | ano | |
sizeKb | number | ano | |
rules | array of object | ano | found = what the rule found in the content (phrases, hosts, domains, HTML tags), at most 5. |
StockPhoto
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
pageUrl | string | ano | |
tags | string | ano | |
type | string | ano | |
previewUrl | string | ano | |
previewWidth | number | ano | |
previewHeight | number | ano | |
webformatUrl | string | ano | |
webformatWidth | number | ano | |
webformatHeight | number | ano | |
largeImageUrl | string | ano | |
imageWidth | number | ano | |
imageHeight | number | ano | |
views | number | ano | |
downloads | number | ano | |
likes | number | ano | |
user | string | ano | |
userUrl | string | ano |
StockPhotoSaved
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
file | StoredFile | ano | |
photo | object | ano | |
existing | boolean | ano |
StockResult
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
total | number | ano | |
totalHits | number | ano | |
page | number | ano | |
perPage | number | ano | |
hits | array of StockPhoto | ano | |
source | string | ano | |
sourceUrl | string | ano |
StockStatus
Fotobanka of the image library (Pixabay through Poštárna's server, one platform key).
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
configured | boolean | ano | |
source | string | ano | |
sourceUrl | string | ano |
StoredFile
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
name | string | ano | |
folderId | string or null | ano | |
contentType | string | ano | |
size | number | ano | |
width | number or null | ano | Pictures only. |
height | number or null | ano | |
url | string | ano | Stable public address on the link domain: renaming or moving the file keeps it. |
createdAt | string | ano | |
pickedAt | string or null | ne | Last time the editor chose it (Zvolit obrázek); null = never. |
source | FileSource or null | ne | Where a picture of the photo bank comes from (Pixabay, its page and author); null for own files. |
StoredFileDetail
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
usage | object | ano | Templates and draft campaigns whose content names the address (shown before a delete). |
id | string | ano | |
name | string | ano | |
folderId | string or null | ano | |
contentType | string | ano | |
size | number | ano | |
width | number or null | ano | Pictures only. |
height | number or null | ano | |
url | string | ano | Stable public address on the link domain: renaming or moving the file keeps it. |
createdAt | string | ano | |
pickedAt | string or null | ne | Last time the editor chose it (Zvolit obrázek); null = never. |
source | FileSource or null | ne | Where a picture of the photo bank comes from (Pixabay, its page and author); null for own files. |
Survey
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
name | string | ano | |
active | boolean | ano | An inactive survey answers 404. |
url | string | ano | Anonymous public page. |
linkTag | string | ano | {{surveylink_<id>}}: each recipient's own link in an e-mail. |
questions | number | ano | |
responses | number | ne | |
createdAt | string | ano | |
updatedAt | string | ano | |
title | string | ano | |
intro | string | ano | |
pages | array of SurveyPage | ano | |
thanksHtml | string | ano | |
afterUrl | string | ano | Address after the last page instead of the thank-you text. |
oneResponse | boolean | ano | One contact answers once (the recipient's link). |
SurveyPage
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
questions | array of SurveyQuestion | ano |
SurveyQuestion
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | 'q' + digits, stable: the answers are kept under it. |
type | one of: number, date, short_text, long_text, single, multiple, dropdown, scale, stars | ano | |
label | string | ano | |
help | string | ano | |
required | boolean | ano | |
options | array of string | ne | single, multiple, dropdown. |
min | number or null | ne | scale (0 or 1 to 3..10), stars (1 to 5), number (optional range). |
max | number or null | ne | |
minLabel | string | ne | |
maxLabel | string | ne |
SurveyResponse
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
contactId | string or null | ano | |
email | string | ano | |
answers | map of string or number or array of string | ano | |
submittedAt | string | ano |
SurveyResults
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
total | number | ano | |
questions | array of object | ano |
SurveySummary
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
name | string | ano | |
active | boolean | ano | |
url | string | ano | Anonymous public page. |
linkTag | string | ano | {{surveylink_<id>}}: each recipient's own link in an e-mail. |
questions | number | ano | |
responses | number | ne | |
createdAt | string | ano | |
updatedAt | string | ano |
TemplateActiveUses
SE "Kryjeme vám záda": active automations (and their e-mails) sending the template, running campaigns made of it.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
automations | number | ano | |
emails | number | ano | |
campaigns | number | ano |
TemplateCheck
Result of the content check stored with every save (server rules with the tenant's).
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
errors | array 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 | ano | |
warnings | array 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 | ano | |
checkedAt | string or null | ano |
TemplateDetail
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
content | EmailContent | ano | What the editor opens: the draft of a template in use, else the published content. |
settings | TemplateSettings | ano | |
draft | object | ano | A 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). |
activeUses | TemplateActiveUses | ano | |
publicUrl | string | ano | Veřejný náhled: a public page with the content (merge tags unfilled). |
id | string | ano | |
name | string | ano | |
subject | string | ano | |
preheader | string | ano | |
editor | one of: visual, html | ano | |
createdAt | string | ano | |
updatedAt | string | ano | |
tags | array of string | ano | |
size | number | ano | Size of the HTML in bytes (Gmail clips messages over 102 kB). |
archived | boolean | ano | Archived templates are not offered for new campaigns; they can be duplicated or restored. |
archivedAt | string or null | ano | |
readOnly | boolean | ano | Archive copy of an imported SmartEmailing original: content, name and tags never change, no delete or restore. |
usage | object | ano | Campaigns made from the template and e-mail nodes of automations naming it. |
lastUsedAt | string or null | ano | Newest such campaign or automation e-mail. |
check | TemplateCheck | ano |
TemplateInput
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ano | |
subject | string | ano | |
preheader | string | ano | |
tags | array of string | ne | |
content | object | ano | A 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).
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | ne | |
tags | array of string | ne | |
subject | string | ne | |
preheader | string | ne | |
linkParams | array of CampaignLinkParam | ne | Google Analytics parameters added to links of the e-shop (as a campaign's linkParams). |
headers | array of CampaignHeader | ne | Own e-mail headers (X-...). |
unsubscribePageId | string or null | ne | Null = the default unsubscribe page. |
footerId | string or null | ne | Null = 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.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
linkParams | array of CampaignLinkParam | ano | Google Analytics parameters added to links of the e-shop (as a campaign's linkParams). |
headers | array of CampaignHeader | ano | Own e-mail headers (X-...). |
unsubscribePageId | string or null | ano | Null = the default unsubscribe page. |
footerId | string or null | ano | Null = the default footer of the editor. |
TemplateSummary
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
name | string | ano | |
subject | string | ano | |
preheader | string | ano | |
editor | one of: visual, html | ano | |
createdAt | string | ano | |
updatedAt | string | ano | |
tags | array of string | ano | |
size | number | ano | Size of the HTML in bytes (Gmail clips messages over 102 kB). |
archived | boolean | ano | Archived templates are not offered for new campaigns; they can be duplicated or restored. |
archivedAt | string or null | ano | |
readOnly | boolean | ano | Archive copy of an imported SmartEmailing original: content, name and tags never change, no delete or restore. |
usage | object | ano | Campaigns made from the template and e-mail nodes of automations naming it. |
lastUsedAt | string or null | ano | Newest such campaign or automation e-mail. |
check | TemplateCheck | ano |
TestSendResult
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
to | string | ano | |
sentAt | string | ano |
UnsubscribePage
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | ano | |
isDefault | boolean | ano | Serves every unsubscribe link of the tenant (Poštárna; without one the standard page). |
createdAt | string | ano | |
updatedAt | string | ano | |
name | string | ano | |
active | boolean | ano | Active pages may be the default; an active page cannot be deleted. |
mode | one of: page, redirect | ano | page = Zobrazit odhlašovací stránku; redirect = skip it, unsubscribe and go to redirectUrl. |
redirectUrl | string | ano | |
logoUrl | string | ano | |
videoUrl | string | ano | YouTube only. |
language | one of: cs, sk, auto, en, pl, de, hu, it, ro, uk | ano | |
customHtml | string | ano | |
questionEnabled | boolean | ano | |
question | string | ano | |
answers | array of string | ano | |
afterUrl | string | ano | Př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.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
file | StoredFile | ano | |
provider | one of: youtube, vimeo | ano | |
videoId | string | ano | |
videoUrl | string | ano | |
title | string | ano |