Сделка — сущность, которая объединяет один или более контактов. У нее есть ответственный пользователь. В CRM чаще всего эта сущность называется «заказом» или «сделкой».

Пример: один и тот же клиент написал по поводу покупки новых дверей и половых покрытий. Клиент пытается закрыть две разные задачи и нуждается в консультации двух разных менеджеров. Поэтому необходимо создать две разные сделки с одним и тем же контактом, но разными ответственными менеджерами.

Методы

• GET /v2/deals — получение списка сделок.
• GET /v2/deals/{deal_id} — получение сделки по ID.
• POST /v2/deals — добавление сделок.
• PATCH /v2/deals — обновление сделок.
• DELETE /v2/deals — удаление сделок.

Модель сделки

Параметры, которые нужны при создании, обновлении сделок, а также приходят в ответах на запросы.

Все параметры находятся в объекте deals или data: показали в примерах запросов и ответов к каждому методу, какой объект используется.

Добавление сделок

Метод POST /v2/deals

Параметры запроса
Описаны выше в разделе «Модель сделки». Передавайте параметры в объекте deals

Пример запроса:

curl -L 'https://tech.wazzup24.com/v2/deals'
-H 'Authorization: Bearer <client_access_token>'
-H 'Content-Type: application/json'
-d '{
"deals": [
{
"id": "deal1",
"responsible_user_id": "222",
"name": "TestDeal",
"uri": "https://example.com/deal/123",
"contacts": [
"chat1"
],
"closed": false
}
]
}'

Пример ответа:

{
"data": {
"processed": 1
},
"meta": {
"timestamp": 1759495852
}
}

Результат: Сделка, список сделок добавлены.

Получение списка сделок

Метод помогает получить информацию о сделках, которые вы ранее передали в Wazzup.

Метод GET /v2/deals

Пример:

curl -L 'https://tech.wazzup24.com/v2/deals?offset=0&limit=10'
-H 'Authorization: Bearer <client_access_token>'

Пример ответа:

{
"data": [
{
"id": "deal1",
"name": "TestDeal",
"responsible_user_id": "222",
"uri": "https://example.com/deal/123",
"contacts": ["chat1"],
"closed": false
}
],
"meta": {
"timestamp": 1759496750
}
}

Результат: Список всех ранее созданных сделок.

Получение сделки по ID

Метод GET /v2/deals/{deal_id}

Path-параметры
deal_id — ID сделки в CRM.

Пример:

curl -L 'https://tech.wazzup24.com/v2/deals/deal1' -H 'Authorization: Bearer <client_access_token>'

Пример ответа:

{
"data": [
{
"id": "deal1",
"name": "TestDeal",
"responsible_user_id": "222",
"uri": "https://example.com/deal/123",
"contacts": ["chat1"],
"closed": false
}
],
"meta": {
"timestamp": 1759496750
}
}

Результат: Сделка с id: deal1, если такая существует.

Обновление сделок

Метод PATCH /v2/deals

Пример:

curl -L -X PATCH 'https://tech.wazzup24.com/v2/deals'
-H 'Authorization: Bearer <client_access_token>'
-H 'Content-Type: application/json'
-d '{
"deals": [
{
"id": "deal1",
"responsible_user_id": "222",
"name": "TestDeal",
"uri": "https://example.com/deal/123",
"contacts": [
"contact-id-123"
],
"closed": false
}
]
}'

Пример ответа:

{
"data": {
"processed": 1
},
"meta": {
"timestamp": 1759495852
}
}

Результат: Если сделка существует, ее данные обновлены.

Удаление сделок

Метод DELETE /v2/deals

Пример:

curl -L -X DELETE 'https://tech.wazzup24.com/v2/deals'
-H 'Authorization: Bearer <client_access_token>'
-H 'Content-Type: application/json'
-d '{
"deal_ids": [
"deal1"
]
}'

Пример ответа:

{
"data": null,
"meta": {
"timestamp": 1759393502
}
}

Результат: Сделка id: deal1 удалена.