Chat Pró Oratrix: API Externa — CRM Pipeline

Chat Pró Oratrix: API Externa — CRM Pipeline

:parrot: SERVIÇO

Serviço: Chat Pró Oratrix

:hammer_and_wrench: VOCÊ VAI PRECISAR

  • URL base: https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}.
  • Token de autenticação {token}.

:receipt: VISÃO GERAL

A família CRM Pipeline permite criar, listar, consultar, atualizar e excluir pipelines e etapas (stages) pela API externa.

:compass: PASSO A PASSO GUIADO

  1. Use https://api-pro1.oratrixchat.com.br/v2/api/external/{ApiID}.
  2. Envie Authorization: Bearer {token}.
  3. Use as rotas abaixo:
Método Endpoint Finalidade
POST /pipeline/create Criar pipeline
POST /pipeline/delete/{id} Excluir pipeline
GET /pipeline/list Listar pipelines
GET /pipeline/show/{id} Consultar pipeline
POST /pipeline/update/{id} Atualizar pipeline
POST /stage/create Criar etapa
POST /stage/delete/{id} Excluir etapa
GET /stage/list Listar etapas
GET /stage/show/{id} Consultar etapa
POST /stage/update/{id} Atualizar etapa

Campos documentados

  • /pipeline/create: name, description.
  • /pipeline/update/{id}: name.
  • /stage/create: name, pipelineId, order, color.
  • /stage/list: aceita page, limit e pipelineId.
  • /stage/update/{id}: name.

:warning: OBSERVAÇÕES IMPORTANTES

  • :warning: Preserve os nomes pipeline e stage nos endpoints.
  • :warning: Confirme o id antes de atualizar ou excluir.
  • :warning: Não exponha o {token}.
  • :warning: 400 indica parâmetros inválidos ou ausentes; 401, falha de autenticação/permissão.

:gear: DICAS E BOAS PRÁTICAS

  • Liste o pipeline antes de alterar suas etapas.
  • Defina order e color de forma consistente ao criar stages.
  • Teste exclusões em ambiente controlado.

:bar_chart: RESULTADO ESPERADO

A integração poderá administrar pipelines e etapas do CRM via API externa.

:receipt: RESUMO FINAL

Use as rotas /pipeline/* e /stage/* a partir da URL base oficial com Authorization: Bearer {token}.

:label: KEYWORDS

API, CRM, Pipeline, Stage, integração

:robot: Peça ajuda ao ChatGPT da Oratrix

A I.A. da Oratrix no ChatGPT poderá tirar dúvidas e te guiar passo a passo no suporte.