Lists
Contact lists with explicit membership (manual and form lists) and the lists bound to an e-shop (read only membership).
Technická referencia je v angličtine (rovnako ako strojovo čitateľný dokument OpenAPI). Celú skupinu pre AI agenta načítate z /api/openapi.json?tag=Lists.
Prihlásenie: Authorization: Bearer pst_... alebo HTTP Basic (e-mail člena firmy a API kľúč).
Operácie
| Metóda | Cesta | Popis |
|---|---|---|
| GET | /api/v1/tenants/{tenant}/lists | List contact lists |
| POST | /api/v1/tenants/{tenant}/lists | Create a list |
| POST | /api/v1/tenants/{tenant}/lists/merge | Merge lists into a new list (background) |
| POST | /api/v1/tenants/{tenant}/lists/tags | Change labels of lists |
| GET | /api/v1/tenants/{tenant}/lists/{list_id} | Get a list |
| PATCH | /api/v1/tenants/{tenant}/lists/{list_id} | Update a list |
| DELETE | /api/v1/tenants/{tenant}/lists/{list_id} | Delete a list (only the list, with its contacts, or keeping contacts in other lists) |
| POST | /api/v1/tenants/{tenant}/lists/{list_id}/autofill | Fill empty name day, gender and salutations of the members |
| POST | /api/v1/tenants/{tenant}/lists/{list_id}/copy | Copy a list with its members |
| GET | /api/v1/tenants/{tenant}/lists/{list_id}/members | List members of a list |
| POST | /api/v1/tenants/{tenant}/lists/{list_id}/members | Add contacts to a list |
| POST | /api/v1/tenants/{tenant}/lists/{list_id}/members/remove | Remove contacts from a list |
| POST | /api/v1/tenants/{tenant}/lists/{list_id}/members/unsubscribe | Unsubscribe contacts from a list |
List contact lists
GET /api/v1/tenants/{tenant}/lists
Oprávnenie: modul contacts, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: list_lists
Contact lists with member counts by bucket. shop = lists of the shop and of the whole company.
Filtry of the grid (routes_grid.py): ?tag= (repeatable, every label), ?idFrom=&idTo=, ?createdFrom=&createdTo= (calendar days), ?membersFrom=&membersTo= (members of any state except removed), ?activeFrom=&activeTo= (SE's Počet aktivních kontaktů), ?publicName= (part of the public name).
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
page | query | integer | nie | Page number, from 1. default 1, min 1 |
pageSize | query | integer | nie | Items per page, 1 to 100. default 25, min 1, max 100 |
publicName | query | string | nie | |
q | query | string | nie | Search text. max 200 chars |
shop | query | string | nie | Shop id filter. |
sort | query | string | nie | Sort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id). |
tag | query | string | nie | Tag filter. |
Odpovede
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | publicName, q, sort, tag |
| 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 list
POST /api/v1/tenants/{tenant}/lists
Oprávnenie: modul contacts, úroveň full; kľúč s prístupom full · Nástroj MCP: create_list
Creates a manual list.
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
Telo požiadavky (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | áno | |
publicName | string | áno | |
shopId | string or null | áno | |
notifyOnUnsubscribe | boolean | áno | |
notifyOnAdd | boolean | áno | |
note | string | áno | |
tags | array of string | nie | |
signatureHtml | string | nie | |
senderEmail | string | nie | |
senderName | string | nie | SE's sendername and replyto of a list (API only in SE, SZ-04). |
replyTo | string | nie |
Odpovede
- 201 Created:
application/jsonContactListDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | replyTo, senderEmail, senderName, signatureHtml, tags |
| 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. | |
| 409 | conflict | locked, name |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Merge lists into a new list (background)
POST /api/v1/tenants/{tenant}/lists/merge
Oprávnenie: modul contacts, úroveň full; kľúč s prístupom full
Bulk action Sloučit seznamy kontaktů (SZ-07): body {listIds (2 to 100), name, deleteSources}. Creates the new list named name now (409 conflict name_taken) and merges the members in the background (202 {list, jobId}; the notification list_merged tells when it is done). A contact in more lists keeps its most cautious state, nobody is subscribed again. deleteSources deletes the original lists afterwards (only the lists; 409 conflict locked when one of them is a system list).
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
Telo požiadavky (application/json): Required by the server: listIds, name.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
listIds | array of string | áno | |
name | string | áno | |
deleteSources | boolean | áno |
Odpovede
- 200 OK:
application/jsonListMergeResult
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | listIds, replyTo, senderEmail, senderName, signatureHtml, tags |
| 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. | |
| 409 | conflict | locked, name |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Change labels of lists
POST /api/v1/tenants/{tenant}/lists/tags
Oprávnenie: modul contacts, úroveň full; kľúč s prístupom full
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
Telo požiadavky (application/json): Required by the server: ids.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
ids | array of string | áno | |
add | array of string | nie | |
remove | array of string | nie | |
tags | array of string | nie |
Odpovede
- 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 list
GET /api/v1/tenants/{tenant}/lists/{list_id}
Oprávnenie: modul contacts, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: get_list
One list with counts and settings.
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
list_id | path | string | áno | Id of the list (string of digits). |
Odpovede
- 200 OK:
application/jsonContactListDetail
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 list
PATCH /api/v1/tenants/{tenant}/lists/{list_id}
Oprávnenie: modul contacts, úroveň full; kľúč s prístupom full · Nástroj MCP: update_list
Changes a list (name, public name, notifications, note).
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
list_id | path | string | áno | Id of the list (string of digits). |
Telo požiadavky (application/json)
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | nie | |
publicName | string | nie | |
shopId | string or null | nie | |
notifyOnUnsubscribe | boolean | nie | |
notifyOnAdd | boolean | nie | |
note | string | nie | |
tags | array of string | nie | |
signatureHtml | string | nie | |
senderEmail | string | nie | |
senderName | string | nie | SE's sendername and replyto of a list (API only in SE, SZ-04). |
replyTo | string | nie |
Odpovede
- 200 OK:
application/jsonContactListDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | replyTo, senderEmail, senderName, signatureHtml, tags |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 409 | conflict | locked, name |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Delete a list (only the list, with its contacts, or keeping contacts in other lists)
DELETE /api/v1/tenants/{tenant}/lists/{list_id}
Oprávnenie: modul contacts, úroveň full; kľúč s prístupom full · Nástroj MCP: delete_list (cez MCP len s náhľadom a potvrdením)
Deletes a manual list (memberships go, contacts stay).
SE's Smazat seznam with its three ways (?mode=, SZ-08): list (default) = only the list, its contacts stay (204); with_contacts = the list and its contacts, keep_used = the list and those of its contacts that are in no other list or segment: both run in the background (202 {jobId}; the notification list_deleted tells when it is done). Unsubscribed contacts keep their suppression, contacts a campaign was just sent to stay. 409 conflict locked for a system list.
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
list_id | path | string | áno | Id of the list (string of digits). |
mode | query | string | nie |
Odpovede
- 200 OK:
application/jsonListJobQueued
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | mode |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 409 | conflict | locked |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Fill empty name day, gender and salutations of the members
POST /api/v1/tenants/{tenant}/lists/{list_id}/autofill
Oprávnenie: modul contacts, úroveň full; kľúč s prístupom full
Row menu "Doplnit svátek, pohlaví a pozdrav" (SZ-06, core/contact_autofill.py): fills only empty fields of the members; {members, contacts, fields: {column: contacts}}.
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
list_id | path | string | áno | Id of the list (string of digits). |
Telo požiadavky (application/json)
object
Odpovede
- 200 OK:
application/jsonListAutofillResult
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 list with its members
POST /api/v1/tenants/{tenant}/lists/{list_id}/copy
Oprávnenie: modul contacts, úroveň full; kľúč s prístupom full
Row menu "Vytvořit kopii seznamu" (SZ-06): body {name}; 201 with the new list (members in their states, no automation starts), 404 unknown list, 409 conflict name_taken.
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
list_id | path | string | áno | Id of the list (string of digits). |
Telo požiadavky (application/json): Required by the server: name.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | áno |
Odpovede
- 201 Created:
application/jsonContactListDetail
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | replyTo, senderEmail, senderName, signatureHtml, tags |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 409 | conflict | locked, name |
| 429 | 429 rate_limited: wait Retry-After seconds. |
List members of a list
GET /api/v1/tenants/{tenant}/lists/{list_id}/members
Oprávnenie: modul contacts, úroveň read; kľúč s prístupom read alebo full · Nástroj MCP: list_list_members
Members of a list. bucket: active, unconfirmed, unsubscribed, bounced, complained, blacklisted.
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
list_id | path | string | áno | Id of the list (string of digits). |
bucket | query | one of: active, unconfirmed, unsubscribed, bounced, complained, blacklisted | nie | Bucket filter. |
createdFrom | query | string | nie | |
createdTo | query | string | nie | |
engagement | query | string | nie | |
import | query | string | nie | |
list | query | string | nie | |
listState | query | string | nie | |
page | query | integer | nie | Page number, from 1. default 1, min 1 |
pageSize | query | integer | nie | Items per page, 1 to 100. default 25, min 1, max 100 |
q | query | string | nie | Search text. max 200 chars |
shop | query | string | nie | Only objects of this shop (shop id). |
sort | query | string | nie | Sort fields separated by commas, "-" = descending, at most 3 (e.g. name,-id). |
source | query | string | nie | |
state | query | string | nie | |
status | query | string | nie | Status filter. |
tab | query | string | nie |
Odpovede
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | q, 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. | |
| 404 | not_found | |
| 409 | conflict | locked, name |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Add contacts to a list
POST /api/v1/tenants/{tenant}/lists/{list_id}/members
Oprávnenie: modul contacts, úroveň full; kľúč s prístupom full · Nástroj MCP: add_list_members (cez MCP len s náhľadom a potvrdením)
Adds contacts to a manual list (1 to 1000 ids). Never re-subscribes anyone who unsubscribed.
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
list_id | path | string | áno | Id of the list (string of digits). |
Telo požiadavky (application/json): Required by the server: contactIds.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
contactIds | array of string | áno |
Odpovede
- 200 OK:
application/jsonAddMembersResult
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | contactIds |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 409 | conflict | locked |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Remove contacts from a list
POST /api/v1/tenants/{tenant}/lists/{list_id}/members/remove
Oprávnenie: modul contacts, úroveň full; kľúč s prístupom full · Nástroj MCP: remove_list_members (cez MCP len s náhľadom a potvrdením)
Removes contacts from a manual list.
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
list_id | path | string | áno | Id of the list (string of digits). |
Telo požiadavky (application/json): Required by the server: contactIds.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
contactIds | array of string | áno |
Odpovede
- 200 OK:
application/jsonRemoveMembersResult
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | contactIds |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 409 | conflict | locked |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Unsubscribe contacts from a list
POST /api/v1/tenants/{tenant}/lists/{list_id}/members/unsubscribe
Oprávnenie: modul contacts, úroveň full; kľúč s prístupom full
Unsubscribes the given members from this list only (body {contactIds}); 409 locked for lists filled by an e-shop connection. Answers {unsubscribed: n}.
Parametre
| Názov | Kde | Typ | Povinné | Popis |
|---|---|---|---|---|
tenant | path | string (uuid) | áno | 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. |
list_id | path | string | áno | Id of the list (string of digits). |
Telo požiadavky (application/json): Required by the server: contactIds.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
contactIds | array of string | áno |
Odpovede
- 200 OK:
application/jsonobject
Chyby
| Stav | Kód | Hodnoty message |
|---|---|---|
| 400 | validation | contactIds |
| 401 | 401 unauthorized: missing, unknown, revoked, expired or idle API key. | |
| 403 | 403 forbidden: message tenant (another company), scope (read-only key), api_key (person only), or the module the key's roles lack. | |
| 404 | not_found | |
| 409 | conflict | locked |
| 429 | 429 rate_limited: wait Retry-After seconds. |
Schémy
AddMembersResult
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
added | number | áno | |
alreadyMember | number | áno | Already confirmed or unconfirmed in the list. |
skipped | number | áno | Unsubscribed from the list, unsubscribed, bounced, complained or suppressed: never re-subscribed by hand. |
ContactListDetail
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
notifyOnUnsubscribe | boolean | áno | |
notifyOnAdd | boolean | áno | |
note | string | áno | Private note for the team. |
signatureHtml | string | áno | SE's Podpis v e-mailu pro tento seznam kontaktů (HTML), sanitized: {{cl_signature}} of e-mails to the list. |
senderEmail | string | áno | SE's e-mail odesílatele of the list (lower case, '' = none): the signature goes into every e-mail sent from this address, and the list's e-mail notices go to the account's user with this address. |
id | string | áno | |
name | string | áno | |
publicName | string | áno | Name shown on the unsubscribe page; empty = the name is used. |
shopId | string or null | áno | null = list of the whole tenant, not bound to one e-shop. |
systemKind | one of: form, shop_contacts, shop_newsletter, shop_unsubscribed, null | áno | |
locked | boolean | áno | System lists cannot be deleted. |
manualMembers | boolean | áno | False for lists filled by an e-shop connection: members are not added or removed by hand (409). |
tags | array of string | áno | Labels (štítky), at most 20. |
counts | ListCounts | áno | |
createdAt | string | áno |
ContactListSummary
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
id | string | áno | |
name | string | áno | |
publicName | string | áno | Name shown on the unsubscribe page; empty = the name is used. |
shopId | string or null | áno | null = list of the whole tenant, not bound to one e-shop. |
systemKind | one of: form, shop_contacts, shop_newsletter, shop_unsubscribed, null | áno | |
locked | boolean | áno | System lists cannot be deleted. |
manualMembers | boolean | áno | False for lists filled by an e-shop connection: members are not added or removed by hand (409). |
tags | array of string | áno | Labels (štítky), at most 20. |
counts | ListCounts | áno | |
createdAt | string | áno |
Error
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
error | object | áno |
{
"error": {
"code": "validation",
"message": "email"
}
}GridTagsInput
Bulk label change: add and remove, or tags = the new labels of every row.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
ids | array of string | áno | |
add | array of string | nie | |
remove | array of string | nie | |
tags | array of string | nie |
ListAutofillResult
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
members | number | áno | |
contacts | number | áno | |
fields | map of number | áno |
ListCounts
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
total | number | áno | Members without the removed state; the sum of byBucket. |
byBucket | object | áno |
ListInput
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name | string | áno | |
publicName | string | áno | |
shopId | string or null | áno | |
notifyOnUnsubscribe | boolean | áno | |
notifyOnAdd | boolean | áno | |
note | string | áno | |
tags | array of string | nie | |
signatureHtml | string | nie | |
senderEmail | string | nie | |
senderName | string | nie | SE's sendername and replyto of a list (API only in SE, SZ-04). |
replyTo | string | nie |
ListJobQueued
202 of a deletion with contacts or of a merge: the work runs in the background, a notification tells when done.
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
jobId | string or null | áno | |
queued | boolean | nie |
ListMember
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
listState | one of: unsubscribed, confirmed, unconfirmed | áno | State in this list; removed members are never returned. |
bucket | one of: active, unsubscribed, bounced, complained, blacklisted, unconfirmed | áno | |
addedAt | string | áno | |
changedAt | string | áno | |
id | string | áno | |
email | string | áno | |
firstName | string | áno | |
lastName | string | áno | |
status | one of: pending, subscribed, unsubscribed, bounced, complained, customer | áno | |
engagement | one of: A, B, C, D, E, N | áno | |
excluded | boolean | áno | SE "Vyloučené": long inactive yet mailed often (recomputed weekly with the engagement). |
shopId | string or null | áno | Main e-shop (contacts.shop_id), null when unknown. |
suppressionReason | one of: invalid, manual, unsubscribed, hard_bounce, complaint, soft_bounce_limit, null | áno | Set when the address is on the tenant suppression list. |
blacklisted | boolean | nie | On the tenant's blacklist ("Na blacklistu"): a manual entry, or an entry of SmartEmailing's blacklist that keeps its own reason (migration 0180). Older servers leave it out: then suppressionReason 'manual' decides. |
blacklistedAt | string or null | nie | When the address went on the blacklist (the suppression's time), null when it is not on it ("Přidán na blacklist"). |
state | one of: active, bounced, blacklisted | nie | SmartEmailing's 3-value contact state; older servers leave it out (contactState derives it). |
createdAt | string | áno | |
extra | map of boolean or string or number or null | nie | Values of the extra columns asked for (ContactQuery.fields): dates as YYYY-MM-DD, times as ISO. |
ListMergeInput
Bulk action Sloučit seznamy kontaktů (SZ-07).
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
listIds | array of string | áno | |
name | string | áno | |
deleteSources | boolean | áno |
ListMergeResult
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
list | ContactListDetail | áno | |
jobId | string or null | áno |
RemoveMembersResult
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
removed | number | áno |