Update workflow template | SchoolSet

curl -X PUT https://app.schoolset.io/app/api/v1/workflow/template/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Student Enrollment Process",
  "stages": [
    {
      "name": "Application Review",
      "id": 17,
      "color": "#4A90E2"
    }
  ]
}'

{
  "status": "success",
  "message": "Workflow template updated successfully.",
  "data": {
    "template": {
      "id": 1,
      "name": "Student Enrollment Process",
      "module_sysname": "enrollment_module",
      "form_identifier_key": "enroll_form_2024",
      "stages": [
        {
          "id": 1,
          "name": "Application Review",
          "color": "#4A90E2",
          "sort_order": 1,
          "required_checks": [
            {}
          ]
        }
      ]
    },
    "instances": [
      {
        "module_id": 101,
        "instance_id": 2024,
        "current_stage_id": 1
      }
    ]
  }
}

Updates a workflow template and returns refreshed 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.

namestringRequired

Must not be greater than 255 characters.

stageslist of objectsRequired

Must have at least 1 items.

form_identifier_keystring or nullOptional

Must not be greater than 191 characters.

Response

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

statusenum

Allowed values:

messagestring

dataobject