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ámetroTipoDescripciónRequeridoValor por defecto
namestringNombre del campo (1-100 caracteres)✓—
typestringTipo del campo. Uno de: text, textList, number, numberList, date, email, phone, imageUrl, imageUrlList, fileUrl, fileUrlList✓—
descriptionstringDescripción del campo (máx. 500 caracteres)—""
automaticbooleanSi la IA debe llenar el campo automáticamente desde la conversación—false
overwritablebooleanSi la IA puede sobrescribir el valor existente del campo—false

Respuesta

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

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.
  • name y type son inmutables después de crear el campo. Para cambiarlos, elimina el campo y créalo de nuevo.
Anterior Listar Campos Personalizados Siguiente Actualizar Campo Personalizado