📊 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

200Success

application/json

unique_idstring · max: 100 · nullableOptional

namestringRequired

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

date_createdstring · date-timeRead-onlyRequired

last_updatedstring · date-timeRead-onlyRequired

401

Unauthorized

403

Forbidden

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

GET /api/v1.0/organisation/{org_uid}/sales-stages/ HTTP/1.1
Host: skhokho.ai
Accept: */*

[
  {
    "unique_id": "text",
    "name": "text",
    "description": "text",
    "probability": "text",
    "is_active": true,
    "is_closed_won": true,
    "is_closed_lost": true,
    "date_created": "2026-01-01T00:00:00.000Z",
    "last_updated": "2026-01-01T00:00:00.000Z"
  }
]

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

201Success

application/json

unique_idstring · max: 100 · nullableOptional

namestringRequired

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

date_createdstring · date-timeRead-onlyRequired

last_updatedstring · date-timeRead-onlyRequired

400

Bad Request - invalid or missing fields

401

Unauthorized

403

Forbidden

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

POST /api/v1.0/organisation/{org_uid}/sales-stages/create/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "probability": "text",
  "is_active": true,
  "is_closed_won": true,
  "is_closed_lost": true
}

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "probability": "text",
  "is_active": true,
  "is_closed_won": true,
  "is_closed_lost": true,
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

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

200Success

application/json

unique_idstring · max: 100 · nullableOptional

namestringRequired

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

date_createdstring · date-timeRead-onlyRequired

last_updatedstring · date-timeRead-onlyRequired

401

Unauthorized

403

Forbidden

404

Not Found

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

GET /api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/ HTTP/1.1
Host: skhokho.ai
Accept: */*

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "probability": "text",
  "is_active": true,
  "is_closed_won": true,
  "is_closed_lost": true,
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

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

200Success

application/json

unique_idstring · max: 100 · nullableOptional

namestringRequired

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

date_createdstring · date-timeRead-onlyRequired

last_updatedstring · date-timeRead-onlyRequired

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

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

PUT /api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/update/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "probability": "text",
  "is_active": true,
  "is_closed_won": true,
  "is_closed_lost": true
}

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "probability": "text",
  "is_active": true,
  "is_closed_won": true,
  "is_closed_lost": true,
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

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

200Success

application/json

unique_idstring · max: 100 · nullableOptional

namestringRequired

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

date_createdstring · date-timeRead-onlyRequired

last_updatedstring · date-timeRead-onlyRequired

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

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

PATCH /api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/update/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "probability": "text",
  "is_active": true,
  "is_closed_won": true,
  "is_closed_lost": true
}

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "probability": "text",
  "is_active": true,
  "is_closed_won": true,
  "is_closed_lost": true,
  "date_created": "2026-01-01T00:00:00.000Z",
  "last_updated": "2026-01-01T00:00:00.000Z"
}

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

204

No Content

No content

401

Unauthorized

403

Forbidden

404

Not Found

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

DELETE /api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/delete/ HTTP/1.1
Host: skhokho.ai
Accept: */*

No content

Previous🎯 Leads

Next🤝 Clients

Last updated 8 months ago