Delete workflow template

DELETE

https://app.schoolset.io/app/api/v1/workflow/template/:id

DELETE

/app/api/v1/workflow/template/:id

1 curl -X DELETE https://app.schoolset.io/app/api/v1/workflow/template/id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

200Deleted

1 {
2   "status": "success",
3   "message": "Workflow template deleted successfully.",
4   "data": {
5     "template": {
6       "id": 42,
7       "name": "Student Enrollment Process",
8       "module_sysname": "enrollment_module",
9       "form_identifier_key": "enroll_form_2024",
10       "stages": [
11         {
12           "id": 101,
13           "name": "Application Review",
14           "color": "#4CAF50",
15           "sort_order": 1,
16           "required_checks": [
17             {}
18           ]
19         }
20       ]
21     },
22     "instances": [
23       {
24         "module_id": 5,
25         "instance_id": 2023,
26         "current_stage_id": 101
27       }
28     ]
29   }
30 }

Deletes a workflow template and returns updated board data.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Path parameters

idstringRequired

Request

This endpoint expects an object.

module_idsstring or nullOptional

module IDs list.

Response

Successful DELETE response for /api/v1/workflow/template/{id}.

statusenum

Allowed values:

messagestring

dataobject