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âmetro | Tipo | Padrão | Descrição |
|---|---|---|---|
page | number | 1 | Página atual |
limit | number | 20 | Itens por página (máx: 100) |
type | string | — | Filtrar por tipo (ver tabela abaixo) |
client_id | string | — | Filtrar por cliente |
deal_id | string | — | Filtrar por negócio |
completed | string | — | true ou false |
search | string | — | Buscar por título ou descrição |
sort | string | -created_at | Campos: title, type, occurred_at, due_date, priority, created_at |
Tipos de Atividade
| Tipo | Descrição |
|---|---|
call | Ligação telefônica |
meeting | Reunião |
email | Email enviado/recebido |
note | Anotação |
task | Tarefa |
follow_up | Follow-up |
deadline | Prazo/deadline |
hearing | Audiência |
case_event | Evento de caso |
contract_event | Evento 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
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
title | string | Sim | Título |
type | string | Não | Tipo (padrão: task) |
description | string | Não | Descrição |
occurred_at | string | Não | Quando ocorreu (padrão: agora) |
duration_minutes | number | Não | Duração em minutos |
is_completed | boolean | Não | Já concluída? (padrão: false) |
due_date | string | Não | Data limite YYYY-MM-DD |
priority | string | Não | low, medium, high |
tags | array | Não | Tags |
client_id | string | Não | UUID do cliente |
deal_id | string | Não | UUID do negócio |
contract_id | string | Não | UUID do contrato |
assigned_to | string | Não | UUID 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"
}
}