La API de Contactos te permite administrar los contactos de tu cuenta y usar sus IDs en campos de tipo contact_single o contact_multi de Tableros.
Flujo recomendado
Consulta el esquema
Obtén los campos configurados y usa su id técnico en solicitudes y filtros.
Crea un contacto
Envía los datos que conoces respetando el tipo y las reglas de cada campo.
Guarda el ID
Conserva el id de la respuesta para consultar, actualizar o vincular el contacto.
Consulta o recorre contactos
Consulta un contacto por ID o usa el listado paginado para recorrer la colección.
Actualiza o elimina
Envía únicamente los campos que cambiaron. Elimina el contacto cuando ya no deba estar disponible.
Cada cuenta define su propio esquema. Estos campos son comunes:
Tu cuenta puede incluir campos adicionales. Usa el identificador técnico del campo como propiedad del JSON y respeta su tipo configurado.
No envíes id, createdAt ni updatedAt. La API administra estos campos.
Autenticación
Incluye tu API key en todas las solicitudes:
Consulta Autenticación si todavía no tienes una clave.
Operaciones
Obtener esquema
Consulta los campos, tipos y valores permitidos.
Crear contacto
Agrega un contacto y obtén su ID.
Listar contactos
Recorre contactos con paginación por cursor.
Buscar contactos
Combina filtros, ordenamiento y paginación por página.
Consultar contacto
Obtén un contacto por ID.
Actualizar contacto
Modifica únicamente los campos necesarios.
Eliminar contacto
Retira un contacto de las consultas posteriores.