Контакты
- Список контактов
- Получить контакты
- Создать контакт
- Редактировать контакт
- Удалить контакт
- Поиск
- Связать контакт с записями
Список контактов get
https://userID.aircrm.pro/api/contacts
Headers
Content-TypeRequired | string |
application/json |
AuthenticationRequired | string |
{token} |
Query
orderOptional | string |
Отсортируйте запрашиваемые результаты. Пример: ?order=created_at или ?order=created_at|desc |
selectOptional | string |
Выберите только нужные поля (для оптимизации запросов). Пример: ?select=first_name;id |
per_pageOptional | integer |
Укажите количество записей. Пример: ?per_page=20 |
pageOptional | integer |
Номер страницы. Пример: ?page=2 |
qOptional | string |
Поиск по заданному запросу. Пример: ?q=Dmitry |
search_fieldsOptional | string |
Измените поля, по которым будет выполняться поиск. Пример: ?search_fields=email:like;phones.number:= |
search_matchOptional | string |
По умолчанию запросы выполняются с использованием оператора OR для каждого запроса, если вам нужно сопоставить все параметры, используйте AND. Пример: ?search_match=and |
Получить контакты get
https://userID.aircrm.pro/api/contacts/{id}
Headers
Content-TypeRequired | string |
application/json |
AuthenticationRequired | string |
{token} |
Path
idRequired | integer |
ID-записи |
Создать контакт post
https://userID.aircrm.pro/api/contacts
Headers
Content-TypeRequired | string |
application/json |
AuthenticationRequired | string |
{token} |
Body
first_nameRequired | string |
|
last_nameOptional | string |
|
emailOptional | string |
|
phonesOptional | array |
Пример:
|
user_idOptional | integer |
Ответственный за контакт |
source_idOptional | integer |
ID источника |
job_titleOptional | string |
|
streetOptional | string |
|
cityOptional | string |
|
stateOptional | string |
|
postal_codeOptional | string |
|
country_idOptional | integer |
ID страны |
companiesOptional | array |
Массив ID компаний, с которыми связан контакт. |
dealsOptional | array |
Массив ID сделок, с которыми связан контакт. |
...customFieldsOptional | mixed |
Любое дополнительное поле. |
Редактировать контакт put
https://userID.aircrm.pro/api/contacts/{id}
Headers
Content-TypeRequired | string |
application/json |
AuthenticationRequired | string |
{token} |
Path
idRequired | integer |
ID-записи |
Body
first_nameRequired | string |
|
last_nameOptional | string |
|
emailOptional | string |
|
phonesOptional | array |
Пример:
|
user_idOptional | integer |
Ответственный за контакт |
source_idOptional | integer |
ID источника |
job_titleOptional | string |
|
streetOptional | string |
|
cityOptional | string |
|
stateOptional | string |
|
postal_codeOptional | string |
|
country_idOptional | integer |
ID страны |
companiesOptional | array |
Массив ID компаний, с которыми связан контакт. |
dealsOptional | array |
Массив ID сделок, с которыми связан контакт. |
...customFieldsOptional | mixed |
Любое дополнительное поле. |
Удалить контакт delete
https://userID.aircrm.pro/api/contacts/{id}
Headers
Content-TypeRequired | string |
application/json |
AuthenticationRequired | string |
{token} |
Path
idRequired | integer |
ID-записи |
Поиск get
https://userID.aircrm.pro/api/contacts/search?q={query}
Headers
Content-TypeRequired | string |
application/json |
AuthenticationRequired | string |
{token} |
Path
qRequired | string |
Query
takeOptional | integer |
Максимальное количество результатов. Пример: ?take=1 |
orderOptional | string |
Отсортируйте запрашиваемые результаты. Пример: ?order=created_at или ?order=created_at|desc |
selectOptional | string |
Выберите только нужные поля (для оптимизации запросов). Пример: ?select=first_name;id |
search_fieldsOptional | string |
Измените поля, по которым будет выполняться поиск. Пример: ?search_fields=email:like;phones.number:= |
search_matchOptional | string |
По умолчанию запросы выполняются с использованием оператора OR для каждого запроса, если вам нужно сопоставить все параметры, используйте AND. Пример: ?search_match=and |
Связать контакт с записями put
https://userID.aircrm.pro/api/associations/contacts/{id}
Headers
Content-TypeRequired | string |
application/json |
AuthenticationRequired | string |
{token} |
Path
idRequired | integer |
ID-записи |
Обязательно укажите хотя бы одну запись.
Body
companiesOptional | array |
Массив ID компаний для прикрепления |
dealsOptional | array |
Массив ID сделок для прикрепления |
activitiesOptional | array |
Массив ID задач для прикрепления |