Skip to content

Atividades

Endpoints para registro de interações e atividades com clientes.

Registrar Atividade de Cliente

POST /api/activities

Cria uma nova atividade (ex: interação por email, SMS ou WhatsApp) para um cliente e atualiza suas informações de último contato.

Casos de uso:

  • Registrar follow-up após feedback negativo
  • Documentar comunicações de campanha
  • Manter histórico de interações com cliente

Corpo da Requisição

json
{
  "client_id": "ef9fa264-3850-4bd2-875e-2b40a4dd432f",
  "name": "Envio de mensagem de boas-vindas",
  "description": "Foi enviado um WhatsApp com informações do programa de fidelidade",
  "type": "whatsapp"
}
CampoTipoObrigatórioDescrição
client_idstringSimID do cliente (formato UUID)
namestringSimNome da atividade (3-250 caracteres)
descriptionstringSimDescrição da atividade (3-250 caracteres)
typestringSimTipo da atividade: whatsapp, email ou sms

Tipos de Atividade

TipoDescrição
whatsappMensagem via WhatsApp
emailEmail enviado
smsSMS enviado

Exemplo de Requisição

bash
curl -X POST "https://api-b2s.experienciab2s.com/api/activities" \
     -H "Authorization: Bearer SEU_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "client_id": "ef9fa264-3850-4bd2-875e-2b40a4dd432f",
       "name": "Envio de mensagem de boas-vindas",
       "description": "Foi enviado um WhatsApp com informações do programa de fidelidade",
       "type": "whatsapp"
     }'

Resposta de Sucesso (201)

json
{
  "message": "Activity created with success"
}

Códigos de Resposta

CódigoDescrição
201Atividade criada com sucesso
400Erro de validação
403Token inválido ou usuário não autorizado
404Token ou cliente não encontrado

Integration Documentation