Zum Inhalt springen

Endpoints

Custom fields

Contact properties you define, used in custom_fields on contacts.

Pfade sind relativ zur Basis-URL. Jede Karte zeigt die Berechtigung, die der Aufruf braucht, und jeden Parameter mit Typ und Grenzen.

GET
/custom-fields

List contact custom fields, including their type and options.

Berechtigung: contacts
GET
/custom-fields/:id

Retrieve a custom field.

Berechtigung: contacts

Pfadparameter

  • iderforderlichinteger

    Custom field ID.

POST
/custom-fields

Create a contact custom field.

Owner oder Admin

JSON-Body

  • labelerforderlichstring

    1–200 characters.

  • keyoptionalstring

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

  • typeoptionalenum

    Default "text".

    Erlaubte Werte:texttextareanumberbooleandateselectmulti_selecturl

  • optionsoptionalarray of strings

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

  • descriptionoptionalstring

    Up to 500 characters.

  • ai_enabledoptionalboolean

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

  • show_in_tableoptionalboolean

    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.