Skip to main content
GET
/
contacts
/
v1
/
fields
curl -X GET https://api.whaapy.com/contacts/v1/fields \
  -H "Authorization: Bearer wha_TU_API_KEY"

{
  "fields": [
    {
      "id": "field-uuid-1",
      "name": "company",
      "type": "text",
      "description": "Nombre de la empresa",
      "is_required": false,
      "category": "business"
    },
    {
      "id": "field-uuid-2",
      "name": "contract_value",
      "type": "number",
      "description": "Valor del contrato en USD",
      "is_required": false,
      "category": "sales"
    },
    {
      "id": "field-uuid-3",
      "name": "birth_date",
      "type": "date",
      "description": "Fecha de nacimiento",
      "is_required": false,
      "category": "personal"
    },
    {
      "id": "field-uuid-4",
      "name": "website",
      "type": "url",
      "description": "Sitio web del contacto",
      "is_required": false,
      "category": "business"
    }
  ],
  "total_fields": 4
}
Obtén la lista de campos personalizados definidos para tu negocio. Estos campos están tipados y estructurados para consistencia en tu CRM.
Los campos personalizados definidos aquí son diferentes de los custom_fields libres que puedes agregar a cualquier contacto. Estos campos tienen tipos específicos y pueden ser requeridos.

​
Ejemplos

curl -X GET https://api.whaapy.com/contacts/v1/fields \
  -H "Authorization: Bearer wha_TU_API_KEY"

​
Respuesta Exitosa

{
  "fields": [
    {
      "id": "field-uuid-1",
      "name": "company",
      "type": "text",
      "description": "Nombre de la empresa",
      "is_required": false,
      "category": "business"
    },
    {
      "id": "field-uuid-2",
      "name": "contract_value",
      "type": "number",
      "description": "Valor del contrato en USD",
      "is_required": false,
      "category": "sales"
    },
    {
      "id": "field-uuid-3",
      "name": "birth_date",
      "type": "date",
      "description": "Fecha de nacimiento",
      "is_required": false,
      "category": "personal"
    },
    {
      "id": "field-uuid-4",
      "name": "website",
      "type": "url",
      "description": "Sitio web del contacto",
      "is_required": false,
      "category": "business"
    }
  ],
  "total_fields": 4
}

​
Tipos de Campo

TipoDescripciónEjemplo de valor
textTexto libre"Acme Corporation"
numberValor numérico50000
dateFecha (ISO 8601)"2026-01-28"
emailEmail válido"ceo@acme.com"
phoneNúmero de teléfono"+5215512345678"
urlURL válida"https://acme.com"

​
Campos de la Respuesta

CampoTipoDescripción
fieldsarrayArray de definiciones de campos
fields[].idstringUUID único del campo
fields[].namestringNombre del campo (snake_case)
fields[].typestringTipo de dato del campo
fields[].descriptionstringDescripción del campo
fields[].is_requiredbooleanSi el campo es obligatorio
fields[].categorystringCategoría para agrupar campos
total_fieldsnumberTotal de campos definidos

​
custom_fields vs Field Definitions

custom_fields (libres)

  • Objeto JSON en cada contacto
  • Sin tipos definidos
  • Flexibilidad total
  • Ejemplo: { "any_key": "any_value" }

Field Definitions (tipados)

  • Definidos a nivel de negocio
  • Tipos específicos (text, number, date, etc.)
  • Pueden ser requeridos
  • Validación automática
Usa Field Definitions para datos estructurados que necesitan consistencia (valor de contrato, fecha de renovación). Usa custom_fields para datos ad-hoc que varían por contacto.

​
Próximos Pasos

Crear Contacto

Usar campos personalizados

Actualizar Contacto

Modificar campos personalizados

Búsqueda Avanzada

Filtrar por campos personalizados

Listar Tags

Ver tags disponibles