SNARTA

Контакты

Свойства контакта

id - идентификатор контакта

  • Строка до 64 символов
  • Обязательно к заполнению

customer_id - идентификатор клиента

  • Строка до 64 символов
  • Обязательно к заполнению

phone - номер телефона

  • Строка до 64 символов
  • Обязательно к заполнению

Показать контакты клиента

GET /v2/customers/[id]/contacts

Параметры URL

id — идентификатор клиента

  • Строка до 64 символов
  • Обязательно к заполнению

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

curl --request GET \
  --url https://api.snarta.com/v2/customers/5ca87755-80af-424a-bfc1-88ed6b6a8d0b/contacts \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb'

Успешный ответ

{
  "contacts": [
    {
      "id": "004f2962-931f-4da4-b148-fc115426a290",
      "customer_id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
      "phone": "+79998887766"
    }
  ]
}

Ответ с ошибкой

{}

Создать контакт клиента

POST /v2/customers/[id]/contacts

Параметры URL

id — идентификатор клиента

  • Строка до 64 символов
  • Обязательно к заполнению

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

curl --request POST \
  --url https://api.snarta.com/v2/customers/5ca87755-80af-424a-bfc1-88ed6b6a8d0b/contacts \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "004f2962-931f-4da4-b148-fc115426a290",
    "phone": "+79998887766"
}'

Успешный ответ

{
  "contact": [
    {
      "id": "004f2962-931f-4da4-b148-fc115426a290",
      "customer_id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
      "phone": "+79998887766"
    }
  ]
}

Ответы с ошибкой

{
  "id": "The id field is required."
}
{}
{
  "id": "Duplicate value."
}

Изменить контакт клиента

PUT /v2/customers/[id]/contacts/[contactID]

Параметры URL

id — идентификатор клиента

  • Строка до 64 символов
  • Обязательно к заполнению

contactID — идентификатор контакта

  • Строка до 64 символов
  • Обязательно к заполнению

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

curl --request PUT \
  --url https://api.snarta.com/v2/customers/5ca87755-80af-424a-bfc1-88ed6b6a8d0b/contacts/004f2962-931f-4da4-b148-fc115426a290 \
  --header 'Authorization: Bearer 49fd7f64-669f-4f65-87a3-7252a1e0faeb' \
  --header 'Content-Type: application/json' \
  --data '{
    "phone": "+79998887766"
}'

Успешный ответ

{
  "contact": [
    {
      "id": "004f2962-931f-4da4-b148-fc115426a290",
      "customer_id": "5ca87755-80af-424a-bfc1-88ed6b6a8d0b",
      "phone": "+79998887766"
    }
  ]
}

Ответы с ошибкой

{
  "id": "The id field is required."
}
{}

Удалить контакт клиента

DELETE /v2/customers/[id]/contacts/[contactID]

Параметры URL

id — идентификатор клиента

  • Строка до 64 символов
  • Обязательно к заполнению

contactID — идентификатор контакта

  • Строка до 64 символов
  • Обязательно к заполнению

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

curl --request DELETE \
  --url https://api.snarta.com/v2/customers/5ca87755-80af-424a-bfc1-88ed6b6a8d0b/contacts/004f2962-931f-4da4-b148-fc115426a290 \
  --header 'Authorization: Bearer 0298fd52-a33e-41f6-a21c-f7cb0b29f90b'

Успешный ответ

{}