Atividades
Gerencie tarefas e atividades dentro do pipeline de vendas. Agende ligacoes, reunioes, emails e acompanhamentos com suporte a templates e sequencias automatizadas.
Base URL
Todos os endpoints usam o prefixo /api/v1/accounts/{account_id}/pipeline/activities
Listar Atividades
/api/v1/accounts/{account_id}/pipeline/activitiesLista atividades com filtros.
Parametros
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
pipeline_card_id(query) | integer | Nao | Filtrar por card do pipeline |
type(query) | string | Nao | call, meeting, email, task, follow_up (filtra activity_type) |
status(query) | string | Nao | Status da atividade |
priority(query) | string | Nao | Filtrar por prioridade |
assigned_to_id(query) | integer | Nao | Filtrar por responsavel |
overdue(query) | boolean | Nao | true para apenas atividades atrasadas |
upcoming(query) | boolean | Nao | true para apenas atividades futuras |
page(query) | integer | Nao | Pagina (padrao 1) |
per_page(query) | integer | Nao | Itens por pagina (padrao 25) |
curl -s "https://chat.seudominio.com/api/v1/accounts/1/pipeline/activities?status=scheduled" \
-H "api_access_token: YOUR_TOKEN" | jq .{
"activities": [
{
"id": 1,
"pipeline_card_id": 5,
"activity_type": "call",
"status": "scheduled",
"priority": "medium",
"title": "Ligacao de follow-up",
"description": "Confirmar interesse na proposta",
"scheduled_at": "2026-02-20T14:00:00Z",
"due_at": null,
"duration": 30,
"is_overdue": false,
"created_by": { "id": 3, "name": "Maria Santos" },
"assigned_to": { "id": 3, "name": "Maria Santos" },
"created_at": "2026-02-15T10:00:00Z"
}
],
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 15,
"per_page": 25
}
}/api/v1/accounts/{account_id}/pipeline/activitiesCria uma nova atividade.
Parametro obrigatorio na URL
O pipeline_card_id deve ser passado como query param na URL, nao no corpo da requisicao. Todos os campos do corpo devem estar dentro do wrapper activity.
Query Params
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
pipeline_card_id(query) | integer | Sim | ID do card do pipeline ao qual a atividade pertence |
Body (dentro de activity)
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
title | string | Sim | Titulo da atividade |
activity_type | string | Sim | call, meeting, email, task, follow_up |
scheduled_at | string | Nao | Data/hora agendada (ISO 8601) |
duration | integer | Nao | Duracao em minutos |
description | string | Nao | Descricao detalhada |
assigned_to_id | integer | Nao | ID do agente responsavel |
contact_id | integer | Nao | ID do contato associado |
curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/pipeline/activities?pipeline_card_id=5" \
-H "api_access_token: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"activity": {
"activity_type": "meeting",
"title": "Reuniao de apresentacao",
"scheduled_at": "2026-02-20T14:00:00Z",
"duration": 60
}
}'Nota
Para GET, PATCH e DELETE em uma atividade especifica, inclua ?pipeline_card_id=XXX na URL.
/api/v1/accounts/{account_id}/pipeline/activities/{id}?pipeline_card_id={card_id}Retorna detalhes de uma atividade.
/api/v1/accounts/{account_id}/pipeline/activities/{id}?pipeline_card_id={card_id}Atualiza uma atividade. Wrap fields inside activity object.
/api/v1/accounts/{account_id}/pipeline/activities/{id}?pipeline_card_id={card_id}Remove uma atividade.
Acoes da Atividade
/api/v1/accounts/{account_id}/pipeline/activities/{id}/start?pipeline_card_id={card_id}Inicia uma atividade agendada.
/api/v1/accounts/{account_id}/pipeline/activities/{id}/complete?pipeline_card_id={card_id}Marca a atividade como concluida.
/api/v1/accounts/{account_id}/pipeline/activities/{id}/cancel?pipeline_card_id={card_id}Cancela a atividade.
/api/v1/accounts/{account_id}/pipeline/activities/{id}/reschedule?pipeline_card_id={card_id}Reagenda a atividade.
Body
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
scheduled_at | string | Sim | Nova data/hora (ISO 8601) |
/api/v1/accounts/{account_id}/pipeline/activities/searchBusca atividades por texto.
Parametros
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
q(query) | string | Sim | Texto de busca |
/api/v1/accounts/{account_id}/pipeline/activities/analyticsMetricas de atividades (conclusao, atrasos, por tipo).
{
"data": {
"total": 150,
"completed": 98,
"completion_rate": 65.3,
"overdue": 12,
"by_type": {
"call": 45,
"meeting": 30,
"email": 50,
"task": 25
},
"avg_completion_time_hours": 4.2
}
}Operacoes em Lote
/api/v1/accounts/{account_id}/pipeline/activities/bulk_createCria a mesma atividade em multiplos cards de uma vez (max 100 cards).
Body
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
pipeline_card_ids | array | Sim | IDs dos cards onde a atividade sera criada (max 100, escopados a conta). Mais que 100 retorna 400. |
activity | object | Sim | Objeto com os campos da atividade (activity_type, title, scheduled_at, etc.) — os mesmos de Criar Atividade. |
curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/pipeline/activities/bulk_create" \
-H "api_access_token: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"pipeline_card_ids": [5, 9, 12],
"activity": { "activity_type": "call", "title": "Ligacao de prospeccao" }
}'/api/v1/accounts/{account_id}/pipeline/activities/create_from_template?pipeline_card_id={card_id}Cria uma atividade a partir de um template, vinculada ao card informado na query.
Query Params
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
pipeline_card_id(query) | integer | Sim | ID do card ao qual a atividade sera vinculada |
Body
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
template_id | integer | Sim | ID do template de atividade |
activity | object | Nao | Campos da atividade que sobrescrevem os defaults do template |
Sequencias de Atividades
/api/v1/accounts/{account_id}/pipeline/activity_sequencesLista sequencias de atividades.
/api/v1/accounts/{account_id}/pipeline/activity_sequencesCria uma nova sequencia.
Body (pipeline_activity_sequence)
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
name | string | Sim | Nome da sequencia |
description | string | Nao | Descricao |
steps | array | Sim | Array de passos (nao pode estar vazio). Cada passo: {day, activity_type, title, duration} |
curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/pipeline/activity_sequences" \
-H "api_access_token: YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"pipeline_activity_sequence": {
"name": "Cadencia de Vendas",
"steps": [
{ "day": 1, "activity_type": "call", "title": "Ligacao inicial", "duration": 15 },
{ "day": 3, "activity_type": "email", "title": "Email de follow-up", "duration": 5 }
]
}
}'/api/v1/accounts/{account_id}/pipeline/activity_sequences/{id}Detalhes de uma sequencia.
/api/v1/accounts/{account_id}/pipeline/activity_sequences/{id}Atualiza uma sequencia.
/api/v1/accounts/{account_id}/pipeline/activity_sequences/{id}Remove uma sequencia.
Templates de Atividade
/api/v1/accounts/{account_id}/pipeline/activity_templatesLista templates de atividade.
/api/v1/accounts/{account_id}/pipeline/activity_templatesCria um novo template.
Body (pipeline_activity_template)
| Nome | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
name | string | Sim | Nome do template |
activity_type | string | Sim | call, meeting, email, task, follow_up |
title | string | Nao | Titulo padrao |
description | string | Nao | Descricao padrao |
default_duration | integer | Nao | Duracao padrao em minutos |
Formato de resposta
A resposta e retornada dentro de um objeto data: {"data": {"id": 1, ...}}
/api/v1/accounts/{account_id}/pipeline/activity_templates/{id}Remove um template.