Delete Registration | SchoolSet

curl -X DELETE https://app.schoolset.io/app/api/v2/registration/list/delete/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "status": "success",
  "message": "Registration record deleted successfully.",
  "data": {
    "id": "reg-2024-0456",
    "batch_id": null,
    "name": "Johnson Family Registration",
    "parents": [
      {
        "parent_id": "p-1001",
        "name": "Emily Johnson",
        "relation": "Mother",
        "contact_number": "+1-555-123-4567",
        "email": "emily.johnson@example.com"
      }
    ],
    "status": "deleted",
    "status_id": 3,
    "by_passed": false,
    "system": [
      {
        "last_updated": "2024-06-10T09:15:00Z",
        "updated_by": "admin_user_23"
      }
    ],
    "file": [
      {
        "file_id": "file-789",
        "file_name": "registration_form.pdf",
        "uploaded_at": "2024-05-01T12:00:00Z"
      }
    ],
    "document_template": [
      {
        "template_id": "tmpl-456",
        "template_name": "Standard Registration Template"
      }
    ],
    "form": [
      {
        "form_id": "form-321",
        "form_name": "Family Details Form"
      }
    ],
    "checkbox": [
      {
        "checkbox_id": "chk-654",
        "label": "Terms and Conditions Accepted",
        "checked": true
      }
    ],
    "students_data": [
      {
        "student_id": 2024,
        "name": "Michael Johnson",
        "has_admission_card": true,
        "status": "withdrawn"
      }
    ]
  }
}

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.

Path parameters

idstringRequired

Response

Success

statusenum

Allowed values:

messagestring

dataobject