Aller au contenu

Endpoints

Custom fields

Contact properties you define, used in custom_fields on contacts.

Les chemins sont relatifs à l’URL de base. Chaque carte indique la permission requise par l’appel et chaque paramètre, avec son type et ses limites.

GET
/custom-fields

List contact custom fields, including their type and options.

Permission : contacts
GET
/custom-fields/:id

Retrieve a custom field.

Permission : contacts

Paramètres de chemin

  • idobligatoireinteger

    Custom field ID.

POST
/custom-fields

Create a contact custom field.

Propriétaire ou admin

Corps JSON

  • labelobligatoirestring

    1–200 characters.

  • keyfacultatifstring

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

  • typefacultatifenum

    Default "text".

    Valeurs autorisées :texttextareanumberbooleandateselectmulti_selecturl

  • optionsfacultatifarray of strings

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

  • descriptionfacultatifstring

    Up to 500 characters.

  • ai_enabledfacultatifboolean

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

  • show_in_tablefacultatifboolean

    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.