Move workflow item | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v1/workflow/move \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "module": "student_enrollment",
  "module_id": 42
}'

{
  "status": "success",
  "message": "Workflow item moved successfully to the next stage.",
  "data": {
    "template": {
      "id": 5,
      "name": "Enrollment Process",
      "module_sysname": "student_enrollment",
      "form_identifier_key": "enroll_form_2024",
      "stages": [
        {
          "id": 10,
          "name": "Application Received",
          "color": "#FFCC00",
          "sort_order": 1,
          "required_checks": [
            {}
          ]
        }
      ]
    },
    "instances": [
      {
        "module_id": 42,
        "instance_id": 101,
        "current_stage_id": 10
      }
    ]
  }
}

Moves a workflow item to another stage in the workflow board.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

modulestringRequired

Must not be greater than 100 characters.

module_idintegerRequired

module ID identifier.

stage_idinteger or nullOptional

stage ID identifier.

Response

Successful POST response for /api/v1/workflow/move.

statusenum

Allowed values:

messagestring

dataobject