Crear Campo Personalizado

Crea un nuevo campo personalizado para los contactos de tu workspace. El identificador (fieldId) se deriva automáticamente del name.

POST https://api.platica.mx/v1/custom-fields

Cuerpo de la solicitud

{
  "name": "Nivel de membresía",
  "type": "text",
  "description": "Tipo de membresía actual del cliente",
  "automatic": true,
  "overwritable": false
}

Parámetros del cuerpo

Parámetro	Tipo	Descripción	Requerido	Valor por defecto
`name`	string	Nombre del campo (1-100 caracteres)	✓	—
`type`	string	Tipo del campo. Uno de: `text`, `textList`, `number`, `numberList`, `date`, `email`, `phone`, `imageUrl`, `imageUrlList`, `fileUrl`, `fileUrlList`, `select`	✓	—
`description`	string	Descripción del campo (máx. 500 caracteres)	—	`""`
`automatic`	boolean	Si la IA debe llenar el campo automáticamente desde la conversación	—	`false`
`overwritable`	boolean	Si la IA puede sobrescribir el valor existente del campo	—	`false`
`options`	array	Solo `select`. Catálogo de opciones (requerido y no vacío para `select`). Cada opción: `{ "label": string, "id"?: string, "color"?: string, "order"?: number, "archived"?: boolean }`. Máximo 50 opciones.	Condicional	—
`ordered`	boolean	Solo `select`. Indica si las opciones son una secuencia ordenada (etapas/pasos). Solo afecta el orden de visualización; no restringe a qué opción se puede asignar.	—	`false`

Respuesta

{
  "status": "success",
  "message": "Custom field created successfully",
  "data": {
    "id": "nivel_de_membresia"
  }
}

Campos de selección (`select`)

Un campo select (selección/estatus) almacena una opción de un catálogo predefinido. El valor guardado en cada cliente es el id de la opción (no la etiqueta).

{
  "name": "Etapa de venta",
  "type": "select",
  "description": "Etapa actual del cliente en el embudo",
  "ordered": true,
  "options": [
    { "label": "Nuevo" },
    { "label": "Contactado" },
    { "label": "Cerrado" }
  ]
}

En este ejemplo se generan las opciones con ids nuevo, contactado y cerrado. Puedes fijar un id propio o un color (hex) por opción; si omites el id, se deriva de la etiqueta.

Notas

El id del campo se genera automáticamente a partir del name: se convierte a minúsculas, se eliminan acentos y se reemplazan los caracteres no alfanuméricos por guiones bajos _.
Cada workspace puede tener hasta 25 campos personalizados activos. Si se alcanza el límite, la API devolverá 400.
Si ya existe un campo con el mismo id derivado, la API devolverá 409. Usa un nombre distinto o actualiza el campo existente.
Los tipos terminados en List (textList, numberList, imageUrlList, fileUrlList) almacenan múltiples valores por contacto.
En los campos select, el id de cada opción es un slug estable derivado de su etiqueta y no cambia si la renombras. Las etiquetas no pueden estar vacías y los ids deben ser únicos dentro del campo.
Para asignar el valor de un select a un cliente, envía el id o la etiqueta de una opción activa en customFields (ver Crear un Cliente ).
name y type son inmutables después de crear el campo. Para cambiarlos, elimina el campo y créalo de nuevo. Las options y ordered de un select sí se pueden editar después (ver Actualizar Campo Personalizado ).