İçeriğe geç

Endpoint'ler

Custom fields

Contact properties you define, used in custom_fields on contacts.

Yollar temel URL'ye göredir. Her kart, çağrının gerektirdiği izni ve her parametreyi türü ve sınırlarıyla listeler.

GET
/custom-fields

List contact custom fields, including their type and options.

İzin: contacts
GET
/custom-fields/:id

Retrieve a custom field.

İzin: contacts

Yol parametreleri

  • idzorunluinteger

    Custom field ID.

POST
/custom-fields

Create a contact custom field.

Sahip veya admin

JSON gövdesi

  • labelzorunlustring

    1–200 characters.

  • keyisteğe bağlıstring

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

  • typeisteğe bağlıenum

    Default "text".

    İzin verilen değerler:texttextareanumberbooleandateselectmulti_selecturl

  • optionsisteğe bağlıarray of strings

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

  • descriptionisteğe bağlıstring

    Up to 500 characters.

  • ai_enabledisteğe bağlıboolean

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

  • show_in_tableisteğe bağlı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.