Create workflow template | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v1/workflow/template \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "module": "student_enrollment",
  "name": "New Student Admission Process",
  "stages": [
    {
      "name": "Application Received",
      "id": 101,
      "color": "#1E90FF"
    },
    {
      "name": "Document Verification",
      "id": 102,
      "color": "#32CD32"
    },
    {
      "name": "Interview Scheduled",
      "id": 103,
      "color": "#FFD700"
    },
    {
      "name": "Admission Confirmed",
      "id": 104,
      "color": "#FF4500"
    }
  ]
}'

{
  "status": "success",
  "message": "Workflow template created successfully.",
  "data": {
    "template": {
      "id": 42,
      "name": "New Student Admission Process",
      "module_sysname": "student_enrollment",
      "form_identifier_key": "admission_form_2024",
      "stages": [
        {
          "id": 101,
          "name": "Application Received",
          "color": "#1E90FF",
          "sort_order": 1,
          "required_checks": [
            {}
          ]
        },
        {
          "id": 102,
          "name": "Document Verification",
          "color": "#32CD32",
          "sort_order": 2,
          "required_checks": [
            {}
          ]
        },
        {
          "id": 103,
          "name": "Interview Scheduled",
          "color": "#FFD700",
          "sort_order": 3,
          "required_checks": [
            {}
          ]
        },
        {
          "id": 104,
          "name": "Admission Confirmed",
          "color": "#FF4500",
          "sort_order": 4,
          "required_checks": [
            {}
          ]
        }
      ]
    },
    "instances": [
      {
        "module_id": 42,
        "instance_id": 1001,
        "current_stage_id": 101
      },
      {
        "module_id": 42,
        "instance_id": 1002,
        "current_stage_id": 102
      }
    ]
  }
}

Creates a workflow template and returns updated board data.

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.

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 POST response for /api/v1/workflow/template.

statusenum

Allowed values:

messagestring

dataobject