Pular para o conteúdo

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

GET/api/v1/accounts/{account_id}/pipeline/activities

Lista atividades com filtros.

Parametros

NomeTipoObrigatorioDescricao
card_id(query)integerNaoFiltrar por card do pipeline
type(query)stringNaocall, meeting, email, task, follow_up
status(query)stringNaoscheduled, in_progress, completed, cancelled
owner_id(query)integerNaoFiltrar por responsavel
start_date(query)stringNaoData inicio (YYYY-MM-DD)
end_date(query)stringNaoData fim (YYYY-MM-DD)
bash
curl -s "https://chat.seudominio.com/api/v1/accounts/1/pipeline/activities?status=scheduled" \
  -H "api_access_token: YOUR_TOKEN" | jq .
200Lista de atividades
json
{
  "data": [
    {
      "id": 1,
      "type": "call",
      "title": "Ligacao de follow-up",
      "description": "Confirmar interesse na proposta",
      "status": "scheduled",
      "scheduled_at": "2026-02-20T14:00:00Z",
      "duration_minutes": 30,
      "card": { "id": 5, "title": "Deal Empresa XYZ" },
      "owner": { "id": 3, "name": "Maria Santos" },
      "created_at": "2026-02-15T10:00:00Z"
    }
  ],
  "meta": { "total": 15 }
}
POST/api/v1/accounts/{account_id}/pipeline/activities

Cria 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

NomeTipoObrigatorioDescricao
pipeline_card_id(query)integerSimID do card do pipeline ao qual a atividade pertence

Body (dentro de activity)

NomeTipoObrigatorioDescricao
titlestringSimTitulo da atividade
activity_typestringSimcall, meeting, email, task, follow_up
scheduled_atstringNaoData/hora agendada (ISO 8601)
durationintegerNaoDuracao em minutos
descriptionstringNaoDescricao detalhada
assigned_to_idintegerNaoID do agente responsavel
contact_idintegerNaoID do contato associado
bash
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.

GET/api/v1/accounts/{account_id}/pipeline/activities/{id}?pipeline_card_id={card_id}

Retorna detalhes de uma atividade.

PATCH/api/v1/accounts/{account_id}/pipeline/activities/{id}?pipeline_card_id={card_id}

Atualiza uma atividade. Wrap fields inside activity object.

DELETE/api/v1/accounts/{account_id}/pipeline/activities/{id}?pipeline_card_id={card_id}

Remove uma atividade.

Acoes da Atividade

POST/api/v1/accounts/{account_id}/pipeline/activities/{id}/start?pipeline_card_id={card_id}

Inicia uma atividade agendada.

POST/api/v1/accounts/{account_id}/pipeline/activities/{id}/complete?pipeline_card_id={card_id}

Marca a atividade como concluida.

POST/api/v1/accounts/{account_id}/pipeline/activities/{id}/cancel?pipeline_card_id={card_id}

Cancela a atividade.

POST/api/v1/accounts/{account_id}/pipeline/activities/{id}/reschedule?pipeline_card_id={card_id}

Reagenda a atividade.

Body

NomeTipoObrigatorioDescricao
scheduled_atstringSimNova data/hora (ISO 8601)
GET/api/v1/accounts/{account_id}/pipeline/activities/analytics

Metricas de atividades (conclusao, atrasos, por tipo).

200Analytics de atividades
json
{
  "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

POST/api/v1/accounts/{account_id}/pipeline/activities/bulk_create

Cria multiplas atividades de uma vez.

Body

NomeTipoObrigatorioDescricao
activitiesarraySimArray de atividades a criar
POST/api/v1/accounts/{account_id}/pipeline/activities/create_from_template

Cria atividades a partir de um template.

Body

NomeTipoObrigatorioDescricao
template_idintegerSimID do template
card_idintegerSimCard para associar
start_datestringSimData base para agendamento

Sequencias de Atividades

GET/api/v1/accounts/{account_id}/pipeline/activity_sequences

Lista sequencias de atividades.

POST/api/v1/accounts/{account_id}/pipeline/activity_sequences

Cria uma nova sequencia.

Body (pipeline_activity_sequence)

NomeTipoObrigatorioDescricao
namestringSimNome da sequencia
descriptionstringNaoDescricao
stepsarraySimArray de passos (nao pode estar vazio). Cada passo: {day, activity_type, title, duration}
bash
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 }
      ]
    }
  }'
GET/api/v1/accounts/{account_id}/pipeline/activity_sequences/{id}

Detalhes de uma sequencia.

PATCH/api/v1/accounts/{account_id}/pipeline/activity_sequences/{id}

Atualiza uma sequencia.

DELETE/api/v1/accounts/{account_id}/pipeline/activity_sequences/{id}

Remove uma sequencia.

Templates de Atividade

GET/api/v1/accounts/{account_id}/pipeline/activity_templates

Lista templates de atividade.

POST/api/v1/accounts/{account_id}/pipeline/activity_templates

Cria um novo template.

Body (pipeline_activity_template)

NomeTipoObrigatorioDescricao
namestringSimNome do template
activity_typestringSimcall, meeting, email, task, follow_up
titlestringNaoTitulo padrao
descriptionstringNaoDescricao padrao
default_durationintegerNaoDuracao padrao em minutos

Formato de resposta

A resposta e retornada dentro de um objeto data: {"data": {"id": 1, ...}}

DELETE/api/v1/accounts/{account_id}/pipeline/activity_templates/{id}

Remove um template.