Engage / API v1
Referência

Clientes

Cadastre e consulte clientes da sua conta. Cada cliente representa uma pessoa do seu CRM. Pode ser estendido com campos customizados.

Endpoints

Modelo do cliente

  • idstring (uuid)
    Identificador único do cliente, gerado pelo Engage.
  • namestring
    Nome do cliente.
  • emailstring
    E-mail do cliente.
  • phonestring | null
    Telefone do cliente. Opcional.
  • statusstring
    active, inactive, vip ou churned. Pode vir nulo se nunca foi definido.
  • preferredChannelstring
    email, whatsapp, sms ou phone.
  • tagsstring[]
    Lista de tags associadas ao cliente.
  • locationstring | null
    Cidade ou região do cliente. Opcional.
  • companystring | null
    Empresa do cliente. Opcional.
  • birthDatestring (ISO 8601) | null
    Data de nascimento. Opcional.
  • createdAtstring (ISO 8601)
    Data e hora de cadastro.
  • customFieldsobject
    Campos customizados configurados para a entidade Cliente. Presente apenas em respostas de busca.