Funil

Funis de venda e suas etapas.

11 rotas. Todas exigem a chave de API no header Authorization, salvo quando marcadas como públicas. Abrir este módulo no Swagger.

Listar os funis da empresa com as etapas

GET /companie/funnel

Use o id das etapas (funnel_step[].id) para criar oportunidades ou movê-las de etapa.

Respostas

Status	Descrição
200	Funis com as etapas.
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Criar funil

POST /companie/funnel

Corpo (application/json)

Campo	Tipo	Obrigatório	Descrição
companie_user_id	número	sim
title	string	sim
is_duplicated_opp_funnel	boolean	sim
ai_context	string ou null
access_type	profile · user
profiles	número[]
profile_access	object[]
profile_access[].profile_id	número	sim
profile_access[].view_all_opportunities	boolean
user_access	object[]
user_access[].companie_user_id	número	sim
user_access[].view_all_opportunities	boolean

Respostas

Status	Descrição
200	Funil criado.
400	Parâmetros inválidos. (ValidationError)
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Listar os funis liberados para um usuário

GET /companie/funnel/filterProfileUser/{companieUserId}

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
companieUserId	URL	string	sim

Respostas

Status	Descrição
200	Funis visíveis ao usuário.
400	Parâmetros inválidos. (ValidationError)
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Editar funil

PUT /companie/funnel/{id}

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
id	URL	string	sim

Corpo (application/json)

Campo	Tipo	Obrigatório	Descrição
title	string	sim
is_duplicated_opp_funnel	boolean	sim
ai_context	string ou null
access_type	profile · user
profiles	número[]
profile_access	object[]
profile_access[].profile_id	número	sim
profile_access[].view_all_opportunities	boolean
user_access	object[]
user_access[].companie_user_id	número	sim
user_access[].view_all_opportunities	boolean

Respostas

Status	Descrição
200	Funil atualizado.
400	Parâmetros inválidos. (ValidationError)
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Excluir funil

DELETE /companie/funnel/{id}

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
id	URL	string	sim

Respostas

Status	Descrição
200	Funil excluído.
400	Parâmetros inválidos. (ValidationError)
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Listar as etapas de um funil

GET /companie/funnel/step/funnel/{funnelId}

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
funnelId	URL	string	sim

Respostas

Status	Descrição
200	Etapas na ordem do funil.
400	Parâmetros inválidos. (ValidationError)
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Listar todas as etapas da empresa

GET /companie/funnel/step

Respostas

Status	Descrição
200	Etapas de todos os funis.
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Criar etapa

POST /companie/funnel/step

Corpo (application/json)

Campo	Tipo	Obrigatório	Descrição
funnel_id	número	sim
title	string	sim
obs	string ou null
activities	object[]
activities[].id	número	sim
activities[].companie_whatsapp_messages_default_id	número ou null
activities[].business_days	número

Respostas

Status	Descrição
200	Etapa criada.
400	Parâmetros inválidos. (ValidationError)
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Editar etapa

PUT /companie/funnel/step/{id}

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
id	URL	string	sim

Corpo (application/json)

Campo	Tipo	Obrigatório	Descrição
title	string	sim
obs	string ou null
activities	object[]
activities[].id	número	sim
activities[].companie_whatsapp_messages_default_id	número ou null
activities[].business_days	número
path	string ou null

Respostas

Status	Descrição
200	Etapa atualizada.
400	Parâmetros inválidos. (ValidationError)
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Excluir etapa

DELETE /companie/funnel/step/{id}

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
id	URL	string	sim

Respostas

Status	Descrição
200	Etapa excluída.
400	Parâmetros inválidos. (ValidationError)
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger

Reordenar as etapas de um funil

PUT /companie/funnel/step/order/{funnelId}

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição
funnelId	URL	string	sim

Corpo (application/json)

Campo	Tipo	Obrigatório	Descrição
new_order	número[]	sim

Respostas

Status	Descrição
200	Ordem atualizada.
400	Parâmetros inválidos. (ValidationError)
401	Chave ausente, inválida, revogada ou vencida. (ErrorCode)
403	Acesso via API desligado, empresa inativa ou rota não permitida. (ErrorCode)
429	Limite de requisições excedido. (ErrorCode)

Testar no Swagger