# 📊 Sales Funnel

Sales pipeline stages and workflow configuration

## List sales stages

> Get a list of active sales stages

```json
{"openapi":"3.0.3","info":{"title":"Skhokho API","version":"v1.0"},"tags":[{"name":"Sales Stages","description":"Sales pipeline stages and workflow configuration"}],"servers":[{"url":"https://skhokho.ai","description":"Production"},{"url":"http://102.209.118.152:8000/","description":"Local"},{"url":"https://dev.skhokho.ai","description":"Development"}],"security":[{"cookieAuth":[]},{"basicAuth":[]}],"components":{"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"sessionid"},"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"SalesStage":{"type":"object","properties":{"unique_id":{"type":"string","nullable":true,"maxLength":100},"name":{"type":"string"},"description":{"type":"string","nullable":true},"probability":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","title":"Win Probability %","description":"Probability of winning deals in this stage (0-100)"},"is_active":{"type":"boolean"},"is_closed_won":{"type":"boolean"},"is_closed_lost":{"type":"boolean"},"date_created":{"type":"string","format":"date-time","readOnly":true},"last_updated":{"type":"string","format":"date-time","readOnly":true}},"required":["date_created","last_updated","name"]}}},"paths":{"/api/v1.0/organisation/{org_uid}/sales-stages/":{"get":{"operationId":"organisation_sales_stages_list","description":"Get a list of active sales stages","summary":"List sales stages","parameters":[{"in":"path","name":"org_uid","schema":{"type":"string"},"required":true}],"tags":["Sales Stages"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesStage"}}}},"description":""},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}}}}
```

## Create sales stage

> Create a new sales stage. Stage name is required.

```json
{"openapi":"3.0.3","info":{"title":"Skhokho API","version":"v1.0"},"tags":[{"name":"Sales Stages","description":"Sales pipeline stages and workflow configuration"}],"servers":[{"url":"https://skhokho.ai","description":"Production"},{"url":"http://102.209.118.152:8000/","description":"Local"},{"url":"https://dev.skhokho.ai","description":"Development"}],"security":[{"cookieAuth":[]},{"basicAuth":[]}],"components":{"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"sessionid"},"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"SalesStageRequest":{"type":"object","properties":{"unique_id":{"type":"string","nullable":true,"maxLength":100},"name":{"type":"string","minLength":1},"description":{"type":"string","nullable":true},"probability":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","title":"Win Probability %","description":"Probability of winning deals in this stage (0-100)"},"is_active":{"type":"boolean"},"is_closed_won":{"type":"boolean"},"is_closed_lost":{"type":"boolean"}},"required":["name"]},"SalesStage":{"type":"object","properties":{"unique_id":{"type":"string","nullable":true,"maxLength":100},"name":{"type":"string"},"description":{"type":"string","nullable":true},"probability":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","title":"Win Probability %","description":"Probability of winning deals in this stage (0-100)"},"is_active":{"type":"boolean"},"is_closed_won":{"type":"boolean"},"is_closed_lost":{"type":"boolean"},"date_created":{"type":"string","format":"date-time","readOnly":true},"last_updated":{"type":"string","format":"date-time","readOnly":true}},"required":["date_created","last_updated","name"]}}},"paths":{"/api/v1.0/organisation/{org_uid}/sales-stages/create/":{"post":{"operationId":"organisation_sales_stages_create_create","description":"Create a new sales stage. Stage name is required.","summary":"Create sales stage","parameters":[{"in":"path","name":"org_uid","schema":{"type":"string"},"required":true}],"tags":["Sales Stages"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesStageRequest"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SalesStageRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SalesStageRequest"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesStage"}}},"description":""},"400":{"description":"Bad Request - invalid or missing fields"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}}}}
```

## Get sales stage

> Retrieve a specific sales stage

```json
{"openapi":"3.0.3","info":{"title":"Skhokho API","version":"v1.0"},"tags":[{"name":"Sales Stages","description":"Sales pipeline stages and workflow configuration"}],"servers":[{"url":"https://skhokho.ai","description":"Production"},{"url":"http://102.209.118.152:8000/","description":"Local"},{"url":"https://dev.skhokho.ai","description":"Development"}],"security":[{"cookieAuth":[]},{"basicAuth":[]}],"components":{"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"sessionid"},"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"SalesStage":{"type":"object","properties":{"unique_id":{"type":"string","nullable":true,"maxLength":100},"name":{"type":"string"},"description":{"type":"string","nullable":true},"probability":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","title":"Win Probability %","description":"Probability of winning deals in this stage (0-100)"},"is_active":{"type":"boolean"},"is_closed_won":{"type":"boolean"},"is_closed_lost":{"type":"boolean"},"date_created":{"type":"string","format":"date-time","readOnly":true},"last_updated":{"type":"string","format":"date-time","readOnly":true}},"required":["date_created","last_updated","name"]}}},"paths":{"/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/":{"get":{"operationId":"organisation_sales_stages_retrieve","description":"Retrieve a specific sales stage","summary":"Get sales stage","parameters":[{"in":"path","name":"org_uid","schema":{"type":"string"},"required":true},{"in":"path","name":"unique_id","schema":{"type":"string"},"required":true}],"tags":["Sales Stages"],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesStage"}}},"description":""},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}}}
```

## Update sales stage

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

```json
{"openapi":"3.0.3","info":{"title":"Skhokho API","version":"v1.0"},"tags":[{"name":"Sales Stages","description":"Sales pipeline stages and workflow configuration"}],"servers":[{"url":"https://skhokho.ai","description":"Production"},{"url":"http://102.209.118.152:8000/","description":"Local"},{"url":"https://dev.skhokho.ai","description":"Development"}],"security":[{"cookieAuth":[]},{"basicAuth":[]}],"components":{"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"sessionid"},"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"SalesStageRequest":{"type":"object","properties":{"unique_id":{"type":"string","nullable":true,"maxLength":100},"name":{"type":"string","minLength":1},"description":{"type":"string","nullable":true},"probability":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","title":"Win Probability %","description":"Probability of winning deals in this stage (0-100)"},"is_active":{"type":"boolean"},"is_closed_won":{"type":"boolean"},"is_closed_lost":{"type":"boolean"}},"required":["name"]},"SalesStage":{"type":"object","properties":{"unique_id":{"type":"string","nullable":true,"maxLength":100},"name":{"type":"string"},"description":{"type":"string","nullable":true},"probability":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","title":"Win Probability %","description":"Probability of winning deals in this stage (0-100)"},"is_active":{"type":"boolean"},"is_closed_won":{"type":"boolean"},"is_closed_lost":{"type":"boolean"},"date_created":{"type":"string","format":"date-time","readOnly":true},"last_updated":{"type":"string","format":"date-time","readOnly":true}},"required":["date_created","last_updated","name"]}}},"paths":{"/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/update/":{"put":{"operationId":"organisation_sales_stages_update_update","description":"Update a specific sales stage (full or partial update).","summary":"Update sales stage","parameters":[{"in":"path","name":"org_uid","schema":{"type":"string"},"required":true},{"in":"path","name":"unique_id","schema":{"type":"string"},"required":true}],"tags":["Sales Stages"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesStageRequest"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/SalesStageRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/SalesStageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesStage"}}},"description":""},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}}}
```

## Update sales stage

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

```json
{"openapi":"3.0.3","info":{"title":"Skhokho API","version":"v1.0"},"tags":[{"name":"Sales Stages","description":"Sales pipeline stages and workflow configuration"}],"servers":[{"url":"https://skhokho.ai","description":"Production"},{"url":"http://102.209.118.152:8000/","description":"Local"},{"url":"https://dev.skhokho.ai","description":"Development"}],"security":[{"cookieAuth":[]},{"basicAuth":[]}],"components":{"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"sessionid"},"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"PatchedSalesStageRequest":{"type":"object","properties":{"unique_id":{"type":"string","nullable":true,"maxLength":100},"name":{"type":"string","minLength":1},"description":{"type":"string","nullable":true},"probability":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","title":"Win Probability %","description":"Probability of winning deals in this stage (0-100)"},"is_active":{"type":"boolean"},"is_closed_won":{"type":"boolean"},"is_closed_lost":{"type":"boolean"}}},"SalesStage":{"type":"object","properties":{"unique_id":{"type":"string","nullable":true,"maxLength":100},"name":{"type":"string"},"description":{"type":"string","nullable":true},"probability":{"type":"string","format":"decimal","pattern":"^-?\\d{0,3}(?:\\.\\d{0,2})?$","title":"Win Probability %","description":"Probability of winning deals in this stage (0-100)"},"is_active":{"type":"boolean"},"is_closed_won":{"type":"boolean"},"is_closed_lost":{"type":"boolean"},"date_created":{"type":"string","format":"date-time","readOnly":true},"last_updated":{"type":"string","format":"date-time","readOnly":true}},"required":["date_created","last_updated","name"]}}},"paths":{"/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/update/":{"patch":{"operationId":"organisation_sales_stages_update_partial_update","description":"Update a specific sales stage (full or partial update).","summary":"Update sales stage","parameters":[{"in":"path","name":"org_uid","schema":{"type":"string"},"required":true},{"in":"path","name":"unique_id","schema":{"type":"string"},"required":true}],"tags":["Sales Stages"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchedSalesStageRequest"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PatchedSalesStageRequest"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/PatchedSalesStageRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesStage"}}},"description":""},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}}}
```

## Delete sales stage

> Delete a specific sales stage

```json
{"openapi":"3.0.3","info":{"title":"Skhokho API","version":"v1.0"},"tags":[{"name":"Sales Stages","description":"Sales pipeline stages and workflow configuration"}],"servers":[{"url":"https://skhokho.ai","description":"Production"},{"url":"http://102.209.118.152:8000/","description":"Local"},{"url":"https://dev.skhokho.ai","description":"Development"}],"security":[{"cookieAuth":[]},{"basicAuth":[]}],"components":{"securitySchemes":{"cookieAuth":{"type":"apiKey","in":"cookie","name":"sessionid"},"basicAuth":{"type":"http","scheme":"basic"}}},"paths":{"/api/v1.0/organisation/{org_uid}/sales-stages/{unique_id}/delete/":{"delete":{"operationId":"organisation_sales_stages_delete_destroy","description":"Delete a specific sales stage","summary":"Delete sales stage","parameters":[{"in":"path","name":"org_uid","schema":{"type":"string"},"required":true},{"in":"path","name":"unique_id","schema":{"type":"string"},"required":true}],"tags":["Sales Stages"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.skhokho.ai/customers-crm/sales-funnel.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.