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

الـ Endpoints

Custom fields

Contact properties you define, used in custom_fields on contacts.

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

GET
/custom-fields

List contact custom fields, including their type and options.

الصلاحية: contacts
GET
/custom-fields/:id

Retrieve a custom field.

الصلاحية: contacts

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

  • idمطلوبinteger

    Custom field ID.

POST
/custom-fields

Create a contact custom field.

المالك أو الـ admin

الـ body بصيغة JSON

  • labelمطلوبstring

    1–200 characters.

  • keyاختياريstring

    lower_snake_case, starts with a letter, up to 64 characters. Derived from the label when omitted.

  • typeاختياريenum

    Default "text".

    القيم المسموحة:texttextareanumberbooleandateselectmulti_selecturl

  • optionsاختياريarray of strings

    Required for select and multi_select, not allowed otherwise. Up to 200 unique options.

  • descriptionاختياريstring

    Up to 500 characters.

  • ai_enabledاختياريboolean

    Let the AI read and fill this field. Default true.

  • show_in_tableاختياريboolean

    Show as a column in the contacts table. Default false.

  • Answers 201. 409 conflict when the key already exists; 422 when the key is a built-in contact field.