πŸ“Š Sales Funnel

Sales pipeline stages and workflow configuration

List sales stages

get
/api/v1.0/organisation/{org_uid}/sales-stages/

Get a list of active sales stages

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_uid}/sales-stages/

Create sales stage

post
/api/v1.0/organisation/{org_uid}/sales-stages/create/

Create a new sales stage. Stage name is required.

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
Body
unique_idstring Β· max: 100 Β· nullableOptional
namestring Β· min: 1Required
descriptionstring Β· nullableOptional
probabilitystring Β· decimalOptional

Probability of winning deals in this stage (0-100)

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
is_activebooleanOptional
is_closed_wonbooleanOptional
is_closed_lostbooleanOptional
Responses
post
/api/v1.0/organisation/{org_uid}/sales-stages/create/

Get sales stage

get
/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/

Retrieve a specific sales stage

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Responses
chevron-right
200Success
application/json
get
/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/

Update sales stage

put
/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/update/

Update a specific sales stage (full or partial update).

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Body
unique_idstring Β· max: 100 Β· nullableOptional
namestring Β· min: 1Required
descriptionstring Β· nullableOptional
probabilitystring Β· decimalOptional

Probability of winning deals in this stage (0-100)

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
is_activebooleanOptional
is_closed_wonbooleanOptional
is_closed_lostbooleanOptional
Responses
chevron-right
200Success
application/json
put
/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/update/

Update sales stage

patch
/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/update/

Update a specific sales stage (full or partial update).

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Body
unique_idstring Β· max: 100 Β· nullableOptional
namestring Β· min: 1Optional
descriptionstring Β· nullableOptional
probabilitystring Β· decimalOptional

Probability of winning deals in this stage (0-100)

Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
is_activebooleanOptional
is_closed_wonbooleanOptional
is_closed_lostbooleanOptional
Responses
chevron-right
200Success
application/json
patch
/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/update/

Delete sales stage

delete
/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/delete/

Delete a specific sales stage

Authorizations
sessionidstringRequired
Path parameters
org_uidstringRequired
unique_idstringRequired
Responses
delete
/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/delete/

No content

Last updated