API

Atividades

Registrar e acompanhar atividades e interações via API.

Atividades

Registre interações, tarefas e eventos vinculados a clientes, negócios ou contratos. Atividades formam o histórico de relacionamento no CRM.

GET /v1/activities

Lista todas as atividades do time.

Query Parameters

ParâmetroTipoPadrãoDescrição
pagenumber1Página atual
limitnumber20Itens por página (máx: 100)
typestringFiltrar por tipo (ver tabela abaixo)
client_idstringFiltrar por cliente
deal_idstringFiltrar por negócio
completedstringtrue ou false
searchstringBuscar por título ou descrição
sortstring-created_atCampos: title, type, occurred_at, due_date, priority, created_at

Tipos de Atividade

TipoDescrição
callLigação telefônica
meetingReunião
emailEmail enviado/recebido
noteAnotação
taskTarefa
follow_upFollow-up
deadlinePrazo/deadline
hearingAudiência
case_eventEvento de caso
contract_eventEvento de contrato

Request

curl -X GET "https://app.sonar.marketing/api/v1/activities?type=task&completed=false" \
  -H "Authorization: Bearer snr_live_sua_chave_aqui"

Response

{
  "success": true,
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "type": "task",
      "title": "Enviar proposta comercial",
      "description": "Preparar e enviar proposta para gestão de redes sociais",
      "occurred_at": "2026-02-15T10:30:00Z",
      "duration_minutes": null,
      "is_completed": false,
      "due_date": "2026-02-20",
      "priority": "high",
      "tags": ["proposta"],
      "client_id": "cli-uuid",
      "deal_id": "deal-uuid",
      "contract_id": null,
      "assigned_to": "user-uuid",
      "created_by": "user-uuid",
      "created_at": "2026-02-15T10:30:00Z",
      "updated_at": "2026-02-15T10:30:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 8,
    "pages": 1
  }
}

POST /v1/activities

Cria uma nova atividade.

Request Body

CampoTipoObrigatórioDescrição
titlestringSimTítulo
typestringNãoTipo (padrão: task)
descriptionstringNãoDescrição
occurred_atstringNãoQuando ocorreu (padrão: agora)
duration_minutesnumberNãoDuração em minutos
is_completedbooleanNãoJá concluída? (padrão: false)
due_datestringNãoData limite YYYY-MM-DD
prioritystringNãolow, medium, high
tagsarrayNãoTags
client_idstringNãoUUID do cliente
deal_idstringNãoUUID do negócio
contract_idstringNãoUUID do contrato
assigned_tostringNãoUUID do responsável

Request

curl -X POST https://app.sonar.marketing/api/v1/activities \
  -H "Authorization: Bearer snr_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Enviar proposta comercial",
    "type": "task",
    "priority": "high",
    "due_date": "2026-02-20",
    "deal_id": "deal-uuid",
    "client_id": "cli-uuid"
  }'

GET /v1/activities/:id

Busca uma atividade por UUID.

PUT /v1/activities/:id

Atualiza campos. Aceita: title, description, type, occurred_at, duration_minutes, is_completed, due_date, priority, tags, client_id, deal_id, contract_id, assigned_to.

DELETE /v1/activities/:id

Marca a atividade como concluída (soft delete).

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "is_completed": true,
    "completed_at": "2026-02-20T15:30:00Z"
  }
}

On this page