Додати тег контакту

Позначте один контакт тегами
Написано Микола
Оновлено 2 місяці тому

Ви можете додати тег до вже існуючого контакту.

➡️ Запит

URL https://api.helpcrunch.com/v1/customers/<customer_id>/tags
Метод PUT
Headers Authorization: Bearer <your_api_key>

customer_id - це ID контакту, наданий HelpCrunch. Він необхідний для цього методу і виглядає як комбінація чисел (наприклад, 1568834).

Приклад тіла запиту

{
    "tags": [
        {
            "name": "Lead",
            "color": "#ccc"
        },
        {
            "name": "Black Friday"
        },
        {
            "name": "PPC"
        }
    ]
}

Кілька порад

  • Якщо ви вкажете неіснуючий тег, його буде створено автоматично, додано до вашого облікового запису та додано до контакту.
  • Тегу можна призначити будь-який колір CSS. Якщо ви не вкажете колір, за замовчуванням застосується колір #c377e0.


✅ Відповідь на успішний запит

Якщо ваш запит пройшов успішно, ви отримаєте код успішного статусу 200 OK разом із наведеним нижче тілом відповіді.

{
    "id": 7831827,
    "name": "Hakim Zarakim",
    "email": "hzarakim@example.com",
    "userId": "example_22",
    "company": "example",
    "phone": null,
    "firstSeen": 1593547200,
    "lastSeen": 1593547200,
    "location": {
        "regionCode": "London",
        "countryCode": "EN",
        "city": "London"
    },
    "device": null,
    "unsubscribed": false,
    "blocked": false,
    "source": null,
    "referer": null,
    "locale": "en",
    "notes": "He has never heard about magic",
    "lastPage": null,
    "tags": [
        {
            "name": "Paid",
            "color": "#fbfbfb"
        },
        {
            "name": "Lead",
            "color": "#cсс"
        },
        {
            "name": "Black Friday",
            "color": "#c377e0"
        },
        {
            "name": "PPC",
            "color": "#c377e0"
        },
    ],
    "customData": [
        {
            "property": "Subscription status",
            "value": "Suspended"
        },
        {
            "property": "Number of payments",
            "value": 13
        }
    ]
}

🛑 Відповіді з помилками

Ви можете отримати один із наведених нижче кодів статусу помилки та відповіді.

401 Unauthorized

{
    "errors": [
        {
            "code": "invalid_token",
            "message": "Invalid token"
        }
    ]
}

404 Not Found

{
    "errors": [
        {
            "code": "entity_not_found",
            "message": "Customer not found"
        }
    ]
}

429 Too Many Requests

{
    "errors": [
        {
            "code": "too_many_requests",
            "message": "You have exceeded your requests limit"
        }
    ]
}
Чи була наша стаття корисною?