Μετάβαση στο περιεχόμενο
Προγραμματιστές

Endpoints

Custom fields

Contact properties you define, used in custom_fields on contacts.

Οι διαδρομές είναι σχετικές με το βασικό URL. Κάθε κάρτα δείχνει το δικαίωμα που απαιτεί η κλήση και κάθε παράμετρο, με τον τύπο και τα όριά της.

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

Σώμα 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.