Añadir campos personalizados

Este método permite añadir uno o varios campos personalizados a una entidad (leads, compañías, contactos).

Limitaciones
El método está disponible solo para usuarios administradores.

Encabezado de tipo de datos cuando la solicitud es exitosa
Content-Type: application/hal+json

Encabezado de tipo de datos en caso de un error
Content-Type: application/problem+json

Parámetros de respuesta
Para añadir un campo personalizado, se debe pasar un objeto campo.

ParámetroTipo de datoDescripción¿Es el campo obligatorio?Tipos de campos admitidos
typestringTipo de campo.✅Disponible para todos los tipos de campo.
namestringNombre del campo.✅Disponible para todos los tipos de campo.
codestringCódigo del campo que se puede utilizar para actualizar el valor del campo sin pasar el ID del campo en la solicitud.❌Disponible para todos los tipos de campo.
sortintOrdenación de los campos en el grupo de campos.❌Disponible para todos los tipos de campo.
group_idstringID del grupo de campos.❌Disponible para todos los campos de leads, contactos y compañías.
is_api_onlyboolDefine si el campo es editable solo a través de la API.❌Disponible para todos los campos de leads, contactos y compañías.
required_statusesarray|nullArreglo de los campos requeridos para cambiar el estado de un lead.❌Disponible para todos los campos de leads, contactos y compañías.
required_statuses[0]objectModelo del campo disponible.❌Disponible para todos los campos de leads, contactos y compañías.
required_statuses[0][status_id]intID de la etapa que requiere que el campo actual tenga un valor antes de que el lead pueda ser movido.❌Disponible para todos los campos de leads, contactos y compañías.
required_statuses[0][pipeline_id]intID del pipeline que requiere que el campo actual tenga un valor antes de que el lead pueda ser movido.❌Disponible para todos los campos de leads, contactos y compañías.
remindstring|nullConfiguración de recordatorios de cumpleaños (nunca, día – día antes del evento, semana – semana antes del evento, mes – mes antes del evento).❌Disponible solo para los campos de tipo cumpleaños.
enumsarrayArreglo de valores disponibles para el campo.✅Disponible para los siguientes tipos de campo::
-multiselección
-botón de radio
-seleccionar
enums[0]objectModelo de valor disponible para el campo.✅Disponible para los siguientes tipos de campo::
-multiselección
-botón de radio
-seleccionar
enums[0][value]stringValor.✅Disponible para los siguientes tipos de campo::
-multiselección
-botón de radio
-seleccionar
enums[0][sort]stringOrdenación de valores.✅Disponible para los siguientes tipos de campo::
-multiselección
-botón de radio
-seleccionar
Path Params
string
enum
required

Tipo de entidad

Allowed:
Body Params
RAW_BODY
array of objects
RAW_BODY
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json