{"id":5097,"date":"2023-01-16T13:13:24","date_gmt":"2023-01-16T12:13:24","guid":{"rendered":"https:\/\/help.expertsender.com\/cdp\/api-klienci\/"},"modified":"2026-03-09T10:19:45","modified_gmt":"2026-03-09T09:19:45","slug":"api-klienci","status":"publish","type":"ecdp","link":"https:\/\/help.expertsender.com\/pl\/ecdp\/api-klienci\/","title":{"rendered":"Klienci"},"content":{"rendered":"\n

tworzysz nowe profile, zaktualizujesz dane, kt\u00f3re ju\u017c posiadasz, i pobierzesz informacje o klientach na podstawie wybranych identyfikator\u00f3w.<\/p>\n\n\n\n

<\/div>\n\n\n\n

POST \/customers \u2013 dodawanie lub aktualizacja danych klienta<\/h2>\n\n\n\n

Ta metoda tworzy nowe rekordy klient\u00f3w lub aktualizuje istniej\u0105ce dane klient\u00f3w.<\/p>\n\n\n\n

<\/div>\n\n\n\n

Endpoint<\/h3>\n\n\n\n

POST customers<\/p>\n\n\n\n

Host:<\/strong> https:\/\/api.ecdp.app<\/p>\n\n\n\n

Parametry zapytania<\/h3>\n\n\n\n
Parametr<\/strong><\/td>Lokalizacja<\/strong><\/td>Typ<\/strong><\/td>Wymagany<\/strong><\/td>Opis<\/strong><\/td>Dozwolone warto\u015bci \/ Uwagi<\/strong><\/td><\/tr><\/thead>
x-api-key<\/td>header<\/td>string<\/td>tak<\/td>Klucz API do uwierzytelnienia.<\/td>Dost\u0119pny w Ustawienia > API.<\/td><\/tr>
Content-Type<\/td>header<\/td>string<\/td>tak<\/td>Typ zawarto\u015bci \u017c\u0105dania.<\/td>application\/json.<\/td><\/tr>
mode<\/td>body<\/td>string<\/td>tak<\/td>Tryb operacji.<\/td>Add, Update, AddOrUpdate.<\/td><\/tr>
matchBy<\/td>body<\/td>string<\/td>tak<\/td>Pole identyfikuj\u0105ce klienta.<\/td>Email, PhoneNumber, CrmId, GUID, visitorId. Musi by\u0107 zgodny z ustawieniami w Ustawienia > Klienci > Domy\u015blny tryb dopasowania.<\/td><\/tr>
data<\/td>body<\/td>array<\/td>tak<\/td>Tablica obiekt\u00f3w klient\u00f3w.<\/td>Zobacz struktur\u0119 Customer data<\/strong> poni\u017cej.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/div>\n\n\n\n

Customer data<\/strong><\/h4>\n\n\n\n
Parametr<\/strong><\/td>Lokalizacja<\/strong><\/td>Typ<\/strong><\/td>Wymagany<\/strong><\/td>Opis<\/strong><\/td>Dozwolone warto\u015bci \/ Uwagi<\/strong><\/td><\/tr><\/thead>
email<\/td>body<\/td>string<\/td>warunkowo<\/td>Adres email klienta.<\/td>Wymagany, je\u015bli matchBy=Email. Maksymalnie 320 znak\u00f3w.<\/td><\/tr>
phone<\/td>body<\/td>string<\/td>warunkowo<\/td>Numer telefonu klienta.<\/td>Wymagany, je\u015bli matchBy=PhoneNumber. Maksymalnie 20 znak\u00f3w, bez spacji.<\/td><\/tr>
crmId<\/td>body<\/td>string<\/td>warunkowo<\/td>Identyfikator CRM klienta.<\/td>Wymagany, je\u015bli matchBy=CrmId. Maksymalnie 128 znak\u00f3w.<\/td><\/tr>
visitorId<\/td>body<\/td>string<\/td>nie<\/td>Identyfikator \u015bledzenia odwiedzaj\u0105cego stron\u0119.<\/td>Maksymalnie 38 znak\u00f3w.<\/td><\/tr>
firstName<\/td>body<\/td>string<\/td>nie<\/td>Imi\u0119 klienta.<\/td>Maksymalnie 256 znak\u00f3w.<\/td><\/tr>
lastName<\/td>body<\/td>string<\/td>nie<\/td>Nazwisko klienta.<\/td>Maksymalnie 256 znak\u00f3w.<\/td><\/tr>
dateOfBirth<\/td>body<\/td>string ($date-time)<\/td>nie<\/td>Data urodzenia.<\/td>Format ISO-8601: 2023-07-25T12:35:54.712Z.<\/td><\/tr>
gender<\/td>body<\/td>string<\/td>nie<\/td>P\u0142e\u0107 klienta.<\/td>Male, Female, NotSpecified.<\/td><\/tr>
customAttributes<\/td>body<\/td>array<\/td>nie<\/td>Warto\u015bci atrybut\u00f3w w\u0142asnych.<\/td>Zobacz struktur\u0119 Custom attributes<\/strong>.<\/td><\/tr>
consentsData<\/td>body<\/td>object<\/td>nie<\/td>Informacje o zgodach.<\/td>Zobacz struktur\u0119 Consents data<\/strong>.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/div>\n\n\n\n

Custom atrributes (cechy klienta)<\/strong><\/h4>\n\n\n\n

Informacje dotycz\u0105ce pojedynczej cechy klienta:<\/p>\n\n\n\n

Parametr<\/strong><\/td>Lokalizacja<\/strong><\/td>Typ<\/strong><\/td>Wymagany<\/strong><\/td>Opis<\/strong><\/td>Dozwolone warto\u015bci \/ Uwagi<\/strong><\/td><\/tr><\/thead>
name<\/td>body<\/td>string<\/td>tak<\/td>Nazwa atrybutu.<\/td>Minimum 1, maksymalnie 256 znak\u00f3w.<\/td><\/tr>
value<\/td>body<\/td>string<\/td>nie<\/td>Warto\u015b\u0107 atrybutu.<\/td>Typ danych musi odpowiada\u0107 definicji atrybutu.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/div>\n\n\n\n

Consents data<\/strong><\/h4>\n\n\n\n

Zawiera tablic\u0119 wszystkich zg\u00f3d oraz dodatkowe ustawienia dla statusu \u201eAwaitingConformation\u201d<\/p>\n\n\n\n

Parametr<\/strong><\/td>Lokalizacja<\/strong><\/td>Typ<\/strong><\/td>Wymagany<\/strong><\/td>Opis<\/strong><\/td>Dozwolone warto\u015bci \/ Uwagi<\/strong><\/td><\/tr><\/thead>
consents<\/td>body<\/td>array<\/td>nie<\/td>Tablica danych zg\u00f3d.<\/td>Zobacz struktur\u0119 Consent value.<\/strong><\/td><\/tr>
force<\/td>body<\/td>boolean<\/td>nie<\/td>Ponowne wys\u0142anie potwierdzenia dla zg\u00f3d w statusie AwaitingConfirmation.<\/td>Domy\u015blnie: false.<\/td><\/tr>
confirmationMessageId<\/td>body<\/td>integer<\/td>nie<\/td>ID wiadomo\u015bci potwierdzaj\u0105cej.<\/td>Musi by\u0107 prawid\u0142owym ID wiadomo\u015bci.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/div>\n\n\n\n

Consent value<\/strong><\/h4>\n\n\n\n

Wy\u015bwietla szczeg\u00f3\u0142y pojedynczej zgody.<\/p>\n\n\n\n

Parametr<\/strong><\/td>Lokalizacja<\/strong><\/td>Typ<\/strong><\/td>Wymagany<\/strong><\/td>Opis<\/strong><\/td>Dozwolone warto\u015bci \/ Uwagi<\/strong><\/td><\/tr><\/thead>
id<\/td>body<\/td>integer ($int32)<\/td>tak<\/td>ID zgody.<\/td>Musi istnie\u0107 w Ustawienia > Zgody.<\/td><\/tr>
value<\/td>body<\/td>string<\/td>tak<\/td>Status zgody.<\/td>False, AwaitingConfirmation, True.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/div>\n\n\n\n

Przyk\u0142adowe zapytania<\/h3>\n\n\n\n

Dodanie nowego klienta<\/strong><\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
{<\/span><\/span>\n\u00a0 <\/span>"<\/span>mode<\/span>"<\/span>:<\/span> <\/span>"<\/span>Add<\/span>"<\/span>,<\/span><\/span>\n\u00a0 <\/span>"<\/span>matchBy<\/span>"<\/span>:<\/span> <\/span>"<\/span>Email<\/span>"<\/span>,<\/span><\/span>\n\u00a0 <\/span>"<\/span>data<\/span>"<\/span>:<\/span> <\/span>[<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>email<\/span>"<\/span>:<\/span> <\/span>"<\/span>jan.kowalski@poczta.pl<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>firstName<\/span>"<\/span>:<\/span> <\/span>"<\/span>Jan<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>lastName<\/span>"<\/span>:<\/span> <\/span>"<\/span>Kowalski<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>phone<\/span>"<\/span>:<\/span> <\/span>"<\/span>48123456789<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>gender<\/span>"<\/span>:<\/span> <\/span>"<\/span>M\u0119\u017cczyzna<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>dateOfBirth<\/span>"<\/span>:<\/span> <\/span>"<\/span>1985-03-15T00:00:00.000Z<\/span>"<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>}<\/span><\/span>\n\u00a0 <\/span>]<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
<\/div>\n\n\n\n
Dodanie lub aktualizacja cech oraz zg\u00f3d<\/strong><\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
{<\/span><\/span>\n\u00a0 <\/span>"<\/span>mode<\/span>"<\/span>:<\/span> <\/span>"<\/span>AddOrUpdate<\/span>"<\/span>,<\/span><\/span>\n\u00a0 <\/span>"<\/span>matchBy<\/span>"<\/span>:<\/span> <\/span>"<\/span>Email<\/span>"<\/span>,<\/span><\/span>\n\u00a0 <\/span>"<\/span>data<\/span>"<\/span>:<\/span> <\/span>[<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>email<\/span>"<\/span>:<\/span> <\/span>"<\/span>anna.nowak@poczta.pl<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>firstName<\/span>"<\/span>:<\/span> <\/span>"<\/span>Anna<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>lastName<\/span>"<\/span>:<\/span> <\/span>"<\/span>Nowak<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>phone<\/span>"<\/span>:<\/span> <\/span>"<\/span>48987654321<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>gender<\/span>"<\/span>:<\/span> <\/span>"<\/span>Kobieta<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>customAttributes<\/span>"<\/span>:<\/span> <\/span>[<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>name<\/span>"<\/span>:<\/span> <\/span>"<\/span>j\u0119zyk<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>value<\/span>"<\/span>:<\/span> <\/span>"<\/span>pl<\/span>"<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>},<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>name<\/span>"<\/span>:<\/span> <\/span>"<\/span>Karta sta\u0142ego klienta<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>value<\/span>"<\/span>:<\/span> <\/span>"<\/span>Z\u0142ota<\/span>"<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>],<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>consentsData<\/span>"<\/span>:<\/span> <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>consents<\/span>"<\/span>:<\/span> <\/span>[<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>id<\/span>"<\/span>:<\/span> <\/span>1<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>value<\/span>"<\/span>:<\/span> <\/span>"<\/span>True<\/span>"<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>},<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>id<\/span>"<\/span>:<\/span> <\/span>2<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>value<\/span>"<\/span>:<\/span> <\/span>"<\/span>AwaitingConfirmation<\/span>"<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>],<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>force<\/span>"<\/span>:<\/span> <\/span>false,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>confirmationMessageId<\/span>"<\/span>:<\/span> <\/span>101<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>}<\/span><\/span>\n\u00a0 <\/span>]<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
<\/div>\n\n\n\n
Kody odpowiedzi<\/h3>\n\n\n\n
Kod<\/strong><\/td>Status<\/strong><\/td>Opis<\/strong><\/td><\/tr><\/thead>
201<\/td>Created<\/td>Rekord klienta zosta\u0142 pomy\u015blnie utworzony lub zaktualizowany.<\/td><\/tr>
400<\/td>Bad Request<\/td>Nieprawid\u0142owe parametry, brakuj\u0105ce wymagane pola lub b\u0142\u0105d walidacji.<\/td><\/tr>
401<\/td>Unauthorized<\/td>Brak klucza API lub klucz jest nieprawid\u0142owy.<\/td><\/tr>
403<\/td>Forbidden<\/td>Niewystarczaj\u0105ce uprawnienia do wykonania tej operacji.<\/td><\/tr>
500<\/td>Internal Server Error<\/td>B\u0142\u0105d po stronie serwera. Pon\u00f3w pr\u00f3b\u0119 z wyk\u0142adniczym op\u00f3\u017anieniem.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Odpowied\u017a zawiera statystyki, cechy klienta i status zg\u00f3d.<\/p>\n\n\n\n
<\/div>\n\n\n\n
GET \/customers\/{identifier} \u2013 pobieranie informacji o kliencie<\/h2>\n\n\n\n
Metoda GET pobiera pe\u0142ne dane profilu klienta, wykorzystuj\u0105c jeden z czterech typ\u00f3w identyfikator\u00f3w: ID, adres email, numer telefonu lub ID CRM.<\/p>\n\n\n\n
<\/div>\n\n\n\n
Endpointy<\/h3>\n\n\n\n
ID:<\/strong> GET customers\/id\/{id}<\/p>\n\n\n\n
Email:<\/strong> GET customers\/email\/{email}<\/p>\n\n\n\n
Phone:<\/strong> GET customers\/phone\/{phone}<\/p>\n\n\n\n
CRM ID:<\/strong> GET customers\/crmId\/{crmId}<\/p>\n\n\n\n
Host:<\/strong> https:\/\/api.ecdp.app<\/p>\n\n\n\n
<\/div>\n\n\n\n
Parametry zapytania<\/h3>\n\n\n\n
Parametr<\/strong><\/td>Lokalizacja<\/strong><\/td>Typ<\/strong><\/td>Wymagany<\/strong><\/td>Opis<\/strong><\/td>Dozwolone warto\u015bci \/ Uwagi<\/strong><\/td><\/tr><\/thead>
x-api-key<\/td>header<\/td>string<\/td>tak<\/td>Klucz API do uwierzytelnienia.<\/td>Dost\u0119pny w Ustawienia > API.<\/td><\/tr>
id<\/td>path<\/td>string<\/td>warunkowo<\/td>Wewn\u0119trzny ID klienta.<\/td>Wymagany dla \/customers\/id\/{id}.<\/td><\/tr>
email<\/td>path<\/td>string<\/td>warunkowo<\/td>Adres email klienta.<\/td>Wymagany dla \/customers\/email\/{email}.<\/td><\/tr>
phone<\/td>path<\/td>string<\/td>warunkowo<\/td>Numer telefonu klienta.<\/td>Wymagany dla \/customers\/phone\/{phone}. Bez spacji.<\/td><\/tr>
crmId<\/td>path<\/td>string<\/td>warunkowo<\/td>Identyfikator CRM klienta.<\/td>Wymagany dla \/customers\/crmId\/{crmId}.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/div>\n\n\n\n
Przyk\u0142adowe zapytania i odpowiedzi<\/h3>\n\n\n\n
Pobranie danych klienta z u\u017cyciem ID<\/strong><\/p>\n\n\n\n
Zapytane:<\/strong><\/p>\n\n\n\n
GET \/customers\/id\/12345<\/p>\n\n\n\n
Odpowied\u017a:<\/strong><\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
{<\/span><\/span>\n\u00a0 <\/span>"<\/span>status<\/span>"<\/span>:<\/span> <\/span>200<\/span>,<\/span><\/span>\n\u00a0 <\/span>"<\/span>data<\/span>"<\/span>:<\/span> <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>email<\/span>"<\/span>:<\/span> <\/span>"<\/span>jan.kowalski@poczta.pl<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>phone<\/span>"<\/span>:<\/span> <\/span>"<\/span>48123456789<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>crmId<\/span>"<\/span>:<\/span> <\/span>"<\/span>CRM-001234<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>firstName<\/span>"<\/span>:<\/span> <\/span>"<\/span>Jan<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>lastName<\/span>"<\/span>:<\/span> <\/span>"<\/span>Kowalski<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>dateOfBirth<\/span>"<\/span>:<\/span> <\/span>"<\/span>1985-03-15T00:00:00.000Z<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>gender<\/span>"<\/span>:<\/span> <\/span>"<\/span>M\u0119\u017cczyzna<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>rfmSegment<\/span>"<\/span>:<\/span> <\/span>"<\/span>Czempioni<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>totalSpent<\/span>"<\/span>:<\/span> <\/span>2450.00<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>totalOrders<\/span>"<\/span>:<\/span> <\/span>12<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>totalOrderReturns<\/span>"<\/span>:<\/span> <\/span>1<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>avgOrder<\/span>"<\/span>:<\/span> <\/span>204.17<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>avgPricePoint<\/span>"<\/span>:<\/span> <\/span>68.06<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>lastOrder<\/span>"<\/span>:<\/span> <\/span>"<\/span>2024-01-15T14:30:00.000Z<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>avgTimeBetweenOrdersInDays<\/span>"<\/span>:<\/span> <\/span>28<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>currencySymbol<\/span>"<\/span>:<\/span> <\/span>"<\/span>PLN<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>customAttributes<\/span>"<\/span>:<\/span> <\/span>[<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>name<\/span>"<\/span>:<\/span> <\/span>"<\/span>j\u0119zyk<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>value<\/span>"<\/span>:<\/span> <\/span>"<\/span>pl<\/span>"<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>],<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>consentsData<\/span>"<\/span>:<\/span> <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>consents<\/span>"<\/span>:<\/span> <\/span>[<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>id<\/span>"<\/span>:<\/span> <\/span>1<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>value<\/span>"<\/span>:<\/span> <\/span>"<\/span>True<\/span>"<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>]<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>}<\/span><\/span>\n\u00a0 <\/span>}<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
<\/div>\n\n\n\n
Pobranie danych klienta z u\u017cyciem adresu e-mail<\/strong><\/p>\n\n\n\n
Zapytanie: <\/strong><\/p>\n\n\n\n
GET \/customers\/email\/anna.nowak@poczta.pl<\/p>\n\n\n\n
Odpowied\u017a:<\/strong><\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
{<\/span><\/span>\n\u00a0 <\/span>"<\/span>status<\/span>"<\/span>:<\/span> <\/span>200<\/span>,<\/span><\/span>\n\u00a0 <\/span>"<\/span>data<\/span>"<\/span>:<\/span> <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>email<\/span>"<\/span>:<\/span> <\/span>"<\/span>anna.nowak@ poczta.pl<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>phone<\/span>"<\/span>:<\/span> <\/span>"<\/span>48987654321<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>crmId<\/span>"<\/span>:<\/span> <\/span>"<\/span>CRM-005678<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>firstName<\/span>"<\/span>:<\/span> <\/span>"<\/span>Anna<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>lastName<\/span>"<\/span>:<\/span> <\/span>"<\/span>Nowak<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>dateOfBirth<\/span>"<\/span>:<\/span> <\/span>"<\/span>1990-07-22T00:00:00.000Z<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>gender<\/span>"<\/span>:<\/span> <\/span>"<\/span>Kobieta<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>rfmSegment<\/span>"<\/span>:<\/span> <\/span>"<\/span>Lojalni<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>totalSpent<\/span>"<\/span>:<\/span> <\/span>890.50<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>totalOrders<\/span>"<\/span>:<\/span> <\/span>5<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>totalOrderReturns<\/span>"<\/span>:<\/span> <\/span>0<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>avgOrder<\/span>"<\/span>:<\/span> <\/span>178.10<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>avgPricePoint<\/span>"<\/span>:<\/span> <\/span>44.53<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>lastOrder<\/span>"<\/span>:<\/span> <\/span>"<\/span>2024-02-01T09:15:00.000Z<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>avgTimeBetweenOrdersInDays<\/span>"<\/span>:<\/span> <\/span>45<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>currencySymbol<\/span>"<\/span>:<\/span> <\/span>"<\/span>EUR<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>customAttributes<\/span>"<\/span>:<\/span> <\/span>[<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>name<\/span>"<\/span>:<\/span> <\/span>"<\/span>Karta sta\u0142ego klienta<\/span>"<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>value<\/span>"<\/span>:<\/span> <\/span>"<\/span>Z\u0142ota<\/span>"<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>],<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>"<\/span>consentsData<\/span>"<\/span>:<\/span> <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>consents<\/span>"<\/span>:<\/span> <\/span>[<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>id<\/span>"<\/span>:<\/span> <\/span>1<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>value<\/span>"<\/span>:<\/span> <\/span>"<\/span>True<\/span>"<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>},<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>{<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>id<\/span>"<\/span>:<\/span> <\/span>2<\/span>,<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>"<\/span>value<\/span>"<\/span>:<\/span> <\/span>"<\/span>True<\/span>"<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>}<\/span><\/span>\n\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span>]<\/span><\/span>\n\u00a0\u00a0\u00a0 <\/span>}<\/span><\/span>\n\u00a0 <\/span>}<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
<\/div>\n\n\n\n
Kody odpowiedzi<\/h3>\n\n\n\n
Kod<\/strong><\/td>Status<\/strong><\/td>Opis<\/strong><\/td><\/tr><\/thead>
200<\/td>OK<\/td>Klient zosta\u0142 znaleziony i zwr\u00f3cony.<\/td><\/tr>
400<\/td>Bad Request<\/td>Nieprawid\u0142owy format identyfikatora.<\/td><\/tr>
401<\/td>Unauthorized<\/td>Brak klucza API lub klucz jest nieprawid\u0142owy.<\/td><\/tr>
403<\/td>Forbidden<\/td>Niewystarczaj\u0105ce uprawnienia do wykonania tej operacji.<\/td><\/tr>
404<\/td>Not Found<\/td>Klient o podanym identyfikatorze nie istnieje.<\/td><\/tr>
500<\/td>Internal Server Error<\/td>B\u0142\u0105d po stronie serwera. Pon\u00f3w pr\u00f3b\u0119 z wyk\u0142adniczym op\u00f3\u017anieniem.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/div>\n\n\n\n
DELETE \/customers\/{identyfikator} \u2013 usuwanie danych klienta<\/h2>\n\n\n\n
Trwale usuwa profil klienta z ExpertSender CDP, wykorzystuj\u0105c jeden z czterech typ\u00f3w identyfikator\u00f3w: ID, adres email, numer telefonu lub ID CRM. Opcjonalnie anonimizuje dane klienta w celu zgodno\u015bci z RODO.<\/p>\n\n\n\n
<\/div>\n\n\n\n
Endpointy<\/h3>\n\n\n\n
ID:<\/strong> DELETE customers\/id\/{id}<\/p>\n\n\n\n
Email:<\/strong> DELETE customers\/email\/{email}<\/p>\n\n\n\n
Phone:<\/strong> DELETE customers\/phone\/{phone}<\/p>\n\n\n\n
CRM ID:<\/strong> DELETE customers\/crmId\/{crmId}<\/p>\n\n\n\n
Host:<\/strong> https:\/\/api.ecdp.app<\/p>\n\n\n\n
<\/div>\n\n\n\n
Parametry zapytania<\/h3>\n\n\n\n
Parametr<\/strong><\/td>Lokalizacja<\/strong><\/td>Typ<\/strong><\/td>Wymagany<\/strong><\/td>Opis<\/strong><\/td>Dozwolone warto\u015bci \/ Uwagi<\/strong><\/td><\/tr><\/thead>
x-api-key<\/td>header<\/td>string<\/td>tak<\/td>Klucz API do uwierzytelnienia.<\/td>Dost\u0119pny w Ustawienia > API.<\/td><\/tr>
withAnonymization<\/td>query<\/td>boolean<\/td>nie<\/td>Anonimizacja danych klienta opr\u00f3cz usuni\u0119cia.<\/td>true, false. U\u017cyj dla zgodno\u015bci z prawem do usuni\u0119cia danych (RODO).<\/td><\/tr>
id<\/td>path<\/td>string<\/td>warunkowo<\/td>Wewn\u0119trzny ID klienta.<\/td>Wymagany dla endpointu \/customers\/id\/{id}.<\/td><\/tr>
email<\/td>path<\/td>string<\/td>warunkowo<\/td>Adres email klienta.<\/td>Wymagany dla endpointu \/customers\/email\/{email}.<\/td><\/tr>
phone<\/td>path<\/td>string<\/td>warunkowo<\/td>Numer telefonu klienta.<\/td>Wymagany dla endpointu \/customers\/phone\/{phone}. Tylko cyfry, bez spacji.<\/td><\/tr>
crmId<\/td>path<\/td>string<\/td>warunkowo<\/td>Identyfikator CRM klienta.<\/td>Wymagany dla endpointu \/customers\/crmId\/{crmId}.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/div>\n\n\n\n
Przyk\u0142adowe zapytania i odpowiedzi<\/h3>\n\n\n\n
Usuni\u0119cie klienta po ID<\/strong><\/p>\n\n\n\n
Zapytanie:<\/strong><\/p>\n\n\n\n
DELETE \/customers\/id\/12345<\/p>\n\n\n\n
Odpowied\u017a: <\/strong>200 OK<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
{<\/span><\/span>\n\u00a0 <\/span>"<\/span>status<\/span>"<\/span>:<\/span> <\/span>200<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
<\/div>\n\n\n\n
Usuni\u0119cie klienta po adresie email z anonimizacj\u0105<\/strong><\/p>\n\n\n\n
Zapytanie:<\/strong><\/p>\n\n\n\n
DELETE \/customers\/email\/jan.kowalski@ poczta.pl?withAnonymization=true<\/p>\n\n\n\n
Odpowied\u017a: 200 OK<\/strong><\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
{<\/span><\/span>\n\u00a0 <\/span>"<\/span>status<\/span>"<\/span>:<\/span> <\/span>200<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
<\/div>\n\n\n\n
Odpowied\u017a w przypadku b\u0142\u0119dnego zapytania<\/strong><\/p>\n\n\n\n
W przypadku wyst\u0105pienia b\u0142\u0119du (401, 404), odpowied\u017a zawiera informacje diagnostyczne:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
{<\/span><\/span>\n\u00a0 <\/span>"<\/span>type<\/span>"<\/span>:<\/span> <\/span>"<\/span>string<\/span>"<\/span>,<\/span><\/span>\n\u00a0 <\/span>"<\/span>title<\/span>"<\/span>:<\/span> <\/span>"<\/span>string<\/span>"<\/span>,<\/span><\/span>\n\u00a0 <\/span>"<\/span>status<\/span>"<\/span>:<\/span> <\/span>0<\/span>,<\/span><\/span>\n\u00a0 <\/span>"<\/span>substatus<\/span>"<\/span>:<\/span> <\/span>"<\/span>CanNotGetSegmentWithId<\/span>"<\/span>,<\/span><\/span>\n\u00a0 <\/span>"<\/span>detail<\/span>"<\/span>:<\/span> <\/span>"<\/span>string<\/span>"<\/span>,<\/span><\/span>\n\u00a0 <\/span>"<\/span>instance<\/span>"<\/span>:<\/span> <\/span>"<\/span>string<\/span>"<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Pole<\/strong><\/td>Typ<\/strong><\/td>Opis<\/strong><\/td><\/tr><\/thead>
type<\/td>string<\/td>URI typu b\u0142\u0119du.<\/td><\/tr>
title<\/td>string<\/td>Kr\u00f3tki tytu\u0142 b\u0142\u0119du.<\/td><\/tr>
status<\/td>integer<\/td>Kod statusu HTTP.<\/td><\/tr>
substatus<\/td>string<\/td>Szczeg\u00f3\u0142owy kod b\u0142\u0119du (74 mo\u017cliwe warto\u015bci).<\/td><\/tr>
detail<\/td>string<\/td>Szczeg\u00f3\u0142owy opis b\u0142\u0119du.<\/td><\/tr>
instance<\/td>string<\/td>Identyfikator instancji \u017c\u0105dania.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/div>\n\n\n\n
Kody odpowiedzi<\/h3>\n\n\n\n
Kod<\/strong><\/td>Status<\/strong><\/td>Opis<\/strong><\/td><\/tr><\/thead>
200<\/td>OK<\/td>Klient zosta\u0142 pomy\u015blnie usuni\u0119ty.<\/td><\/tr>
400<\/td>Bad Request<\/td>Nieprawid\u0142owy format identyfikatora lub warto\u015b\u0107 parametru.<\/td><\/tr>
401<\/td>Unauthorized<\/td>Brak klucza API lub klucz jest nieprawid\u0142owy.<\/td><\/tr>
403<\/td>Forbidden<\/td>Niewystarczaj\u0105ce uprawnienia do wykonania tej operacji.<\/td><\/tr>
404<\/td>Not Found<\/td>Klient o podanym identyfikatorze nie istnieje.<\/td><\/tr>
500<\/td>Internal Server Error<\/td>B\u0142\u0105d po stronie serwera. Pon\u00f3w pr\u00f3b\u0119 z wyk\u0142adniczym op\u00f3\u017anieniem.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/div>\n\n\n\n
Walidacja i zasady dzia\u0142ania<\/h2>\n\n\n\n