Vai al contenuto
Sviluppatori

Endpoint

Custom fields

Contact properties you define, used in custom_fields on contacts.

I percorsi sono relativi all'URL di base. Ogni scheda indica il permesso richiesto dalla chiamata e ogni parametro, con tipo e limiti.

GET
/custom-fields

List contact custom fields, including their type and options.

Permesso: contacts
GET
/custom-fields/:id

Retrieve a custom field.

Permesso: contacts

Parametri del percorso

  • idobbligatoriointeger

    Custom field ID.

POST
/custom-fields

Create a contact custom field.

Proprietario o admin

Corpo JSON

  • labelobbligatoriostring

    1–200 characters.

  • keyopzionalestring

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

  • typeopzionaleenum

    Default "text".

    Valori consentiti:texttextareanumberbooleandateselectmulti_selecturl

  • optionsopzionalearray of strings

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

  • descriptionopzionalestring

    Up to 500 characters.

  • ai_enabledopzionaleboolean

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

  • show_in_tableopzionaleboolean

    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.