Create Registration Set Status | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v2/registration/list/set-status \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "requirement_id": 42,
  "family_id": 105
}'

{
  "status": "success",
  "message": "Registration status updated successfully.",
  "data": {
    "id": 105,
    "batch_id": {},
    "name": "Spring 2024 Enrollment",
    "parents": [
      {}
    ],
    "status": "Pending Review",
    "status_id": 3,
    "by_passed": false,
    "system": [
      {}
    ],
    "file": [
      {}
    ],
    "document_template": [
      {}
    ],
    "form": [
      {}
    ],
    "checkbox": [
      {}
    ],
    "students_data": [
      {
        "student_id": 789,
        "name": "Emily Johnson",
        "has_admission_card": true,
        "status": "Registered"
      }
    ]
  }
}

Returns or updates registration records for families in the selected academic year.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

requirement_idintegerRequired

requirement ID identifier.

family_idintegerRequired

family ID identifier.

student_idinteger or nullOptional

student ID identifier.

statusinteger or nullOptional

status status value.

fileinteger or nullOptional

file upload or file reference.

checkedboolean or nullOptional

checked value.

Response

Success

statusenum

Allowed values:

messagestring

dataobject