انتقل إلى المحتوى

الـ Endpoints

Tags

The workspace tag list that contact tags come from.

المسارات نسبية للـ base URL. كل كارت بيوضّح الصلاحية اللي الاستدعاء محتاجها وكل parameter، مع نوعه وحدوده.

GET
/tags

List workspace tags.

الصلاحية: contacts
POST
/tags

Create a workspace tag.

الصلاحية: contacts

الـ body بصيغة JSON

  • nameمطلوبstring

    1–80 characters. Must be unique (case-insensitive), else 409.

  • colorاختياريenum | null

    Tag color.

    القيم المسموحة:chart-1chart-2chart-3chart-4chart-5chart-6chart-7chart-8

PATCH
/tags/:id

Rename or recolor a tag. A rename updates every contact that has it. Send name, color, or both.

الصلاحية: contacts

معاملات المسار

  • idمطلوبinteger

    Tag ID.

الـ body بصيغة JSON

  • nameاختياريstring

    1–80 characters.

  • colorاختياريenum | null

    Tag color.

    القيم المسموحة:chart-1chart-2chart-3chart-4chart-5chart-6chart-7chart-8

DELETE
/tags/:id

Delete a tag and remove it from every contact. The response includes contacts_updated.

الصلاحية: contacts

معاملات المسار

  • idمطلوبinteger

    Tag ID.