Skip to content
Developers

Endpoints

Custom fields

Contact properties you define, used in custom_fields on contacts.

Paths are relative to the base URL. Each card lists the permission the call needs and every parameter, with its type and limits.

GET
/custom-fields

List contact custom fields, including their type and options.

Permission: contacts
GET
/custom-fields/:id

Retrieve a custom field.

Permission: contacts

Path parameters

  • idrequiredinteger

    Custom field ID.

POST
/custom-fields

Create a contact custom field.

Owner or admin

JSON body

  • labelrequiredstring

    1–200 characters.

  • keyoptionalstring

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

  • typeoptionalenum

    Default "text".

    Allowed values: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.