Actualizar Campo Personalizado

Actualiza un campo personalizado existente. Solo se modifican los campos proporcionados en la solicitud.

PATCH https://api.platica.mx/v1/custom-fields/{fieldId}

Parámetros de URL

ParámetroTipoDescripciónRequerido
fieldIdstringIdentificador único del campo personalizado

Cuerpo de la solicitud

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

Parámetros del cuerpo

Todos los parámetros son opcionales, pero la solicitud debe incluir al menos uno.

ParámetroTipoDescripción
descriptionstringDescripción del campo (máx. 500 caracteres)
automaticbooleanSi la IA debe llenar el campo automáticamente desde la conversación
overwritablebooleanSi la IA puede sobrescribir el valor existente del campo
optionsarraySolo select. Reemplaza por completo el catálogo de opciones. Debe quedar al menos una opción activa (no archivada). Máximo 50 opciones.
orderedbooleanSolo select. Indica si las opciones son una secuencia ordenada (etapas/pasos).

Editar las opciones de un campo select

Envía el catálogo completo de opciones en options. Conserva el id de las opciones existentes para no romper los valores ya guardados en los clientes; las opciones sin id se tratan como nuevas.

{
  "ordered": true,
  "options": [
    { "id": "nuevo", "label": "Nuevo" },
    { "id": "contactado", "label": "Contactado" },
    { "id": "cerrado", "label": "Cerrado", "archived": true },
    { "label": "Ganado" }
  ]
}

Respuesta

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

Notas

  • name y type son inmutables después de crear el campo. Para cambiarlos, elimina el campo y créalo de nuevo.
  • En un campo select, para "eliminar" una opción márcala como archived: true en lugar de quitarla del arreglo: así se conservan los valores históricos en los clientes y la opción deja de ofrecerse para nuevas asignaciones.
  • options y ordered solo aplican a campos select; en otros tipos se ignoran.
  • Si el campo no existe o fue eliminado previamente, la API devolverá 404.