Endpointy
| Metoda | Ścieżka | Opis |
|——–|———|——|
| GET | /crm/contacts.json | Lista kontaktów |
| GET | /crm/contacts/:id.json | Pojedynczy kontakt |
| POST | /crm/contacts.json | Utworzenie kontaktu |
| PATCH | /crm/contacts/:id.json | Aktualizacja kontaktu |
| DELETE | /crm/contacts/:id.json | Usunięcie kontaktu |
| GET | /crm/contacts/search.json | Wyszukiwanie |
Autoryzacja: Authorization: Bearer TOKEN (uprawnienie: crm)
Pola contact
| Pole | Typ | Wymagane | Opis |
|——|—–|———-|——|
| name | string | nie | Pełna nazwa |
| first_name | string | nie | Imię |
| last_name | string | nie | Nazwisko |
| position | string | nie | Stanowisko |
| email | string | nie | E-mail |
| phone | string | nie | Telefon |
| mobile_phone | string | nie | Telefon komórkowy |
| kind | string | tak | buyer lub supplier |
| client_id | integer | nie | ID klienta |
| status_id | integer | nie | ID statusu |
| responsible_id | integer | nie | ID odpowiedzialnego |
| department_id | integer | nie | ID działu |
| category_id | integer | nie | ID kategorii |
| external_id | string | nie | Zewnętrzne ID |
| street | string | nie | Ulica |
| post_code | string | nie | Kod pocztowy |
| city | string | nie | Miasto |
| country | string | nie | Kod kraju |
| www | string | nie | Strona internetowa |
| description | text | nie | Opis |
| note | text | nie | Notatka |
| fields | object | nie | Własne pola (JSONB) |
Filtrowanie
| Parametr | Opis |
|———-|——|
| q | Wyszukiwanie pełnotekstowe |
| client_id | Filtruj po kliencie |
| extracted_email | Szukaj po e-mailu |
| status_id | Filtruj po statusie |
Przykład utworzenia
{
"api_token": "TOKEN",
"contact": {
"first_name": "Jan",
"last_name": "Kowalski",
"email": "jan@firma.pl",
"phone": "+48123456789",
"position": "Kierownik IT",
"kind": "buyer",
"client_id": 123
}
}