Create Registration Family Set Status | SchoolSet

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

{
  "status": "success",
  "message": "Family registration status updated successfully.",
  "data": {
    "id": 12345,
    "batch_id": {},
    "name": "Johnson Family",
    "parents": [
      {}
    ],
    "status": "Registered",
    "status_id": 2,
    "by_passed": false,
    "system": [
      {}
    ],
    "file": [
      {}
    ],
    "document_template": [
      {}
    ],
    "form": [
      {}
    ],
    "checkbox": [
      {}
    ],
    "students_data": [
      {
        "student_id": 9876,
        "name": "Emily Johnson",
        "has_admission_card": true,
        "status": "Active"
      }
    ]
  }
}

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.

family_idintegerRequired

family ID identifier.

batch_idintegerRequired

batch ID identifier.

completebooleanRequired

complete value.

Response

Success

statusenum

Allowed values:

messagestring

dataobject