In this area

Sales pipeline

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

get/v1/public/sales/pipelines

Parameters

No parameters.

Responses

200

Examples

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

Parameters

pipelineIdstringoptional· query

Field	In	Type	Description
`pipelineId`optional	query	string

Responses

200

Examples

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

Accepts Idempotency-Key

Parameters

Idempotency-Keystringoptional· header

Field	In	Type	Description
`Idempotency-Key`optional	header	string

Responses

201

Examples

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}

Accepts Idempotency-Key

Parameters

idstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`id`required	path	string
`Idempotency-Key`optional	header	string

Responses

200

Examples

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}

Parameters

idstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`id`required	path	string
`Idempotency-Key`optional	header	string

Responses

204

Examples

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

Accepts Idempotency-Key

Parameters

idstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`id`required	path	string
`Idempotency-Key`optional	header	string

Responses

200

Examples

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

Parameters

No parameters.

Responses

200

Examples

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

Accepts Idempotency-Key

Parameters

Idempotency-Keystringoptional· header

Field	In	Type	Description
`Idempotency-Key`optional	header	string

Responses

201

Examples

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}

Parameters

idstringrequired· path

Field	In	Type	Description
`id`required	path	string

Responses

200

Examples

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}

Accepts Idempotency-Key

Parameters

idstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`id`required	path	string
`Idempotency-Key`optional	header	string

Responses

200

Examples

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}

Parameters

idstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`id`required	path	string
`Idempotency-Key`optional	header	string

Responses

204

Examples

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

Accepts Idempotency-Key

Parameters

idstringrequired· path
Idempotency-Keystringoptional· header

Field	In	Type	Description
`id`required	path	string
`Idempotency-Key`optional	header	string

Responses

200

Examples

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

Parameters

No parameters.

Responses

200

Examples

bash

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

Full reference