Referencia (endpoints)Campos personalizados

Crear un campo

Sirve para crear un campo personalizado nuevo (por ejemplo «plan» o «fecha de compra») y guardar en Funnelchat datos propios de tu negocio.

POST
/custom-fields

Permiso requerido: Contactos y conversaciones → Editar

Autorización

http
headerAuthorizationBearer <clave>

Cuerpo del pedido

application/json
  1. body
name*string
Largolength <= 254
description?|
Largolength <= 1000
type*integer

Tipo del campo. Se elige al crearlo y no se puede cambiar después. Indica cómo escribir su valor:

typeTipoCómo escribir valueEjemplo
0TextoCualquier texto."Cliente mayorista"
1NuméricoUn número, con punto decimal y sin separador de miles; puede llevar - adelante."1500", "99.90"
2FechaAAAA-MM-DD, una fecha que exista."2026-11-30"
3URLLa dirección completa, con https:// o http://."https://ejemplo.com/pedido/123"
4AlfanuméricoPensado para códigos con letras y números; acepta cualquier texto."AB1234"

La API valida el valor contra el tipo. Al poner un valor con tu clave (POST /contacts/attach-custom-field, o custom_fields en POST /contacts y POST /contacts/update-or-create), un campo numérico, de fecha o de URL solo acepta el formato de la tabla; con otro formato la API responde 422 con un mensaje que dice qué formato espera ese campo, y no lo guarda. Texto y alfanumérico aceptan cualquier texto. value es siempre un texto, también para un número o una fecha ("1500", no 1500).

Es el formato que escribe el panel y el que entienden los filtros de GET /contacts (custom_field_filters), que comparan un campo numérico como número y uno de fecha como fecha. Un valor que no escribió tu clave (desde el panel, un flujo o una importación) puede tener otro formato.

Valor en01234

Cuerpo de la respuesta

OK

application/json
  1. response
id*string

Id opaco: un texto que empieza con fld_. Se usa tal como llega; no se arma ni se interpreta.

Patrón^fld_[A-Za-z0-9]{23}$
name*string
type*integer

Tipo del campo. Se elige al crearlo y no se puede cambiar después. Indica cómo escribir su valor:

typeTipoCómo escribir valueEjemplo
0TextoCualquier texto."Cliente mayorista"
1NuméricoUn número, con punto decimal y sin separador de miles; puede llevar - adelante."1500", "99.90"
2FechaAAAA-MM-DD, una fecha que exista."2026-11-30"
3URLLa dirección completa, con https:// o http://."https://ejemplo.com/pedido/123"
4AlfanuméricoPensado para códigos con letras y números; acepta cualquier texto."AB1234"

La API valida el valor contra el tipo. Al poner un valor con tu clave (POST /contacts/attach-custom-field, o custom_fields en POST /contacts y POST /contacts/update-or-create), un campo numérico, de fecha o de URL solo acepta el formato de la tabla; con otro formato la API responde 422 con un mensaje que dice qué formato espera ese campo, y no lo guarda. Texto y alfanumérico aceptan cualquier texto. value es siempre un texto, también para un número o una fecha ("1500", no 1500).

Es el formato que escribe el panel y el que entienden los filtros de GET /contacts (custom_field_filters), que comparan un campo numérico como número y uno de fecha como fecha. Un valor que no escribió tu clave (desde el panel, un flujo o una importación) puede tener otro formato.

Valor en01234
description*string|null
contact_count?integer
created_at*|
Formatodate-time
curl -X POST "https://example.com/custom-fields" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "type": 0  }'
{  "id": "fld_Ar7McDNiFfizqFzTybtrwHL",  "name": "string",  "type": 0,  "description": "string",  "contact_count": 0,  "created_at": "2019-08-24T14:15:22Z"}

Esto es lo que se copia para tu IA

Cargando…