Nesta área

Sales pipeline

Pipelines (funis) da org. Negócio criado sem `pipelineId` cai no `isDefault`.

get/v1/public/sales/pipelines

Parâmetros

Sem parâmetros.

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/sales/pipelines" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Etapas do pipeline `?pipelineId=` ou, sem ele, do pipeline padrão.

get/v1/public/sales/pipeline-stages

Parâmetros

pipelineIdstringopcional· consulta

Campo	Onde	Tipo	Descrição
`pipelineId`opcional	consulta	string

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/sales/pipeline-stages" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

POST /v1/public/sales/pipeline-stages

post/v1/public/sales/pipeline-stages

Aceita Idempotency-Key

Parâmetros

Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`Idempotency-Key`opcional	cabeçalho	string

Respostas

201

Exemplos

bash

curl -X POST "https://api.cognizy.ai/api/v1/public/sales/pipeline-stages" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

PATCH /v1/public/sales/pipeline-stages/{id}

patch/v1/public/sales/pipeline-stages/{id}

Aceita Idempotency-Key

Parâmetros

idstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Respostas

200

Exemplos

bash

curl -X PATCH "https://api.cognizy.ai/api/v1/public/sales/pipeline-stages/<id>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

DELETE /v1/public/sales/pipeline-stages/{id}

delete/v1/public/sales/pipeline-stages/{id}

Parâmetros

idstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Respostas

204

Exemplos

bash

curl -X DELETE "https://api.cognizy.ai/api/v1/public/sales/pipeline-stages/<id>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

PATCH /v1/public/sales/pipeline-stages/{id}/reorder

patch/v1/public/sales/pipeline-stages/{id}/reorder

Aceita Idempotency-Key

Parâmetros

idstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Respostas

200

Exemplos

bash

curl -X PATCH "https://api.cognizy.ai/api/v1/public/sales/pipeline-stages/<id>/reorder" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

GET /v1/public/sales/deals

get/v1/public/sales/deals

Parâmetros

Sem parâmetros.

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/sales/deals" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

POST /v1/public/sales/deals

post/v1/public/sales/deals

Aceita Idempotency-Key

Parâmetros

Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`Idempotency-Key`opcional	cabeçalho	string

Respostas

201

Exemplos

bash

curl -X POST "https://api.cognizy.ai/api/v1/public/sales/deals" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

GET /v1/public/sales/deals/{id}

get/v1/public/sales/deals/{id}

Parâmetros

idstringobrigatório· caminho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/sales/deals/<id>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

PATCH /v1/public/sales/deals/{id}

patch/v1/public/sales/deals/{id}

Aceita Idempotency-Key

Parâmetros

idstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Respostas

200

Exemplos

bash

curl -X PATCH "https://api.cognizy.ai/api/v1/public/sales/deals/<id>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

DELETE /v1/public/sales/deals/{id}

delete/v1/public/sales/deals/{id}

Parâmetros

idstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Respostas

204

Exemplos

bash

curl -X DELETE "https://api.cognizy.ai/api/v1/public/sales/deals/<id>" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

PATCH /v1/public/sales/deals/{id}/pipeline-stage

patch/v1/public/sales/deals/{id}/pipeline-stage

Aceita Idempotency-Key

Parâmetros

idstringobrigatório· caminho
Idempotency-Keystringopcional· cabeçalho

Campo	Onde	Tipo	Descrição
`id`obrigatório	caminho	string
`Idempotency-Key`opcional	cabeçalho	string

Respostas

200

Exemplos

bash

curl -X PATCH "https://api.cognizy.ai/api/v1/public/sales/deals/<id>/pipeline-stage" \
  -H "Authorization: Bearer $COGNIZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Get deterministic sales-pipeline insights

get/v1/public/sales/insights

Parâmetros

Sem parâmetros.

Respostas

200

Exemplos

bash

curl -X GET "https://api.cognizy.ai/api/v1/public/sales/insights" \
  -H "Authorization: Bearer $COGNIZY_API_KEY"

Toda a referência