Ir al contenido
Desarrolladores

Endpoints

Custom fields

Contact properties you define, used in custom_fields on contacts.

Las rutas son relativas a la URL base. Cada tarjeta indica el permiso que necesita la llamada y cada parámetro, con su tipo y sus límites.

GET
/custom-fields

List contact custom fields, including their type and options.

Permiso: contacts
GET
/custom-fields/:id

Retrieve a custom field.

Permiso: contacts

Parámetros de ruta

  • idobligatoriointeger

    Custom field ID.

POST
/custom-fields

Create a contact custom field.

Propietario o admin

Cuerpo JSON

  • labelobligatoriostring

    1–200 characters.

  • keyopcionalstring

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

  • typeopcionalenum

    Default "text".

    Valores permitidos:texttextareanumberbooleandateselectmulti_selecturl

  • optionsopcionalarray of strings

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

  • descriptionopcionalstring

    Up to 500 characters.

  • ai_enabledopcionalboolean

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

  • show_in_tableopcionalboolean

    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.