MODULE GUIDE · 11 OCT 2026

Admissions & applicant journey

Connect family enquiries, counsellor follow-ups, reviewed applications and student admission.

Try guided demo →Download guide ↓

OVERVIEW

What you can do

Enquiry pipeline

Contact attempts

Application stages

Guardian details

Campus visits

Document review

Applicant access links

Student placement

Parent invitation

BEFORE YOU BEGIN

Access & setup

Intended access: Assigned account with the required permissions.

An assigned school account with the required permissions.
The academic, student or staff setup used by this workflow.

Required permission keys

admission:manageadmission:viewadmission:updateadmission:createstudent:create

Use the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.

STEP BY STEP

How the workflow works

01
Record or select an enquiry and log the next follow-up
An assigned school account with the required permissions.
02
Open a linked application and review guardian details
Contact attempts is part of the documented workflow.
03
Receive and verify required documents and review readiness
Application stages is part of the documented workflow.
04
Select session, class and section before admitting the applicant
Review the result in the connected record or workspace before moving on.

Request fields to understand

Source-declared fields used by related operations; each operation has its own validation and scope.

Field	Declared type	Input
`purpose`	'APPLICANT' \| 'PARENT_INVITE'	Required by declaration
`version`	string	Required by declaration
`studentName`	string	Required by declaration
`classApplying`	string	Required by declaration
`guardianName`	string	Required by declaration
`phone`	string	Required by declaration
`email`	string	Optional
`relationship`	string	Required by declaration
`dateOfBirth`	string	Optional
`previousSchool`	string	Optional
`address`	string	Optional
`preferredAt`	string	Required by declaration
`notes`	string	Optional
`kind`	string	Required by declaration
`password`	string	Required by declaration
`summary`	string	Required by declaration
`channel`	string	Optional
`outcome`	string	Optional
`status`	string	Required by declaration
`followUpAt`	string	Optional
`byStaffId`	string	Optional
`counsellorId`	string	Required by declaration
`reason`	string	Optional
`parentName`	string	Required by declaration

CURRENT BEHAVIOUR

Rules & current limits

Application access links and parent invitations are separate from an existing family login. Admission is subject to readiness and school/session ownership.

Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.

LEARN BY DOING

Try admissions & applicant journey

Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.

Launch guided demo →

FOR IMPLEMENTERS

API & permissions reference

This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.

37 source-declared operations

GET/api/v1/admissions/applications/:id/access-links

List

admission:manage

POST/api/v1/admissions/applications/:id/access-links

Issue

admission:manage

Declared request fields: purpose (required).

DELETE/api/v1/admissions/applications/:id/access-links

Revoke

admission:manage

Declared request fields: purpose (required).

GET/api/v1/admissions/work-queue

Queue

admission:view

GET/api/v1/admissions/documents/:id/file

File

admission:view

GET/api/v1/admissions/portal

Get

Public/capability access as implemented

PATCH/api/v1/admissions/portal/draft

Save

Public/capability access as implemented

Declared request fields: version (required), studentName (required), classApplying (required), guardianName (required), phone (required), email (optional), relationship (required), dateOfBirth (optional), previousSchool (optional), address (optional).

POST/api/v1/admissions/portal/submit

Submit

Public/capability access as implemented

Declared request fields: version (required).

POST/api/v1/admissions/portal/visit-request

Visit

Public/capability access as implemented

Declared request fields: preferredAt (required), notes (optional).

POST/api/v1/admissions/portal/documents

Upload

Public/capability access as implemented

Declared request fields: kind (required).

GET/api/v1/admissions/portal/documents/:id/file

File

Public/capability access as implemented

GET/api/v1/admissions/parent-invitation

Get

Public/capability access as implemented

POST/api/v1/admissions/parent-invitation/accept

Public/capability access as implemented

Declared request fields: password (required).

GET/api/v1/admissions/enquiries/due

Leads due a follow-up, oldest overdue first

admission:view

GET/api/v1/admissions/enquiries/funnel

Pipeline by stage and by source, with conversion

admission:view

GET/api/v1/admissions/enquiries

List

admission:view

GET/api/v1/admissions/enquiries/:id/follow-ups

History

admission:view

POST/api/v1/admissions/enquiries/:id/follow-ups

Record a contact attempt and move the lead on

admission:update

Declared request fields: summary (required), channel (optional), outcome (optional), status (optional), followUpAt (optional), byStaffId (optional).

POST/api/v1/admissions/enquiries/:id/reassign

Reassign

admission:manage

Declared request fields: counsellorId (required).

POST/api/v1/admissions/enquiries/:id/reopen

Put a converted/lost enquiry back in play

admission:update

Declared request fields: reason (optional).

POST/api/v1/admissions/enquiries

Create

admission:create

Declared request fields: studentName (required), parentName (optional), phone (optional), email (optional), classApplying (optional), source (optional), notes (optional).

PATCH/api/v1/admissions/enquiries/:id

Update

admission:update

Declared request fields: status (optional).

POST/api/v1/admissions/enquiries/:id/convert

Convert

admission:update, student:create

Declared request fields: admissionNo (required), firstName (optional), lastName (optional), sessionId (optional), classId (optional), sectionId (optional).

DELETE/api/v1/admissions/enquiries/:id

Remove

admission:update

GET/api/v1/admissions/applications

List

admission:view

GET/api/v1/admissions/applications/funnel

Where applicants are, and how many converted

admission:view

POST/api/v1/admissions/applications

Open an application, optionally from an enquiry

admission:create

Declared request fields: studentName (required), enquiryId (optional), applicationNo (optional), classApplying (optional), applicationFee (optional), feePaid (optional), formData (optional).

PATCH/api/v1/admissions/applications/:id

Update

admission:update

Declared request fields: studentName (optional), classApplying (optional), applicationFee (optional), feePaid (optional), interviewAt (optional), testScore (optional), formData (optional).

POST/api/v1/admissions/applications/:id/advance

Move the application one legal step

admission:manage

Declared request fields: status (required), reason (optional), interviewAt (optional), testScore (optional).

POST/api/v1/admissions/applications/:id/admit

Turn a selected applicant into a student

admission:manage

Declared request fields: admissionNo (required), firstName (optional), lastName (optional), sessionId (optional), classId (optional), sectionId (optional).

GET/api/v1/admissions/applications/:id/journey

Get

admission:view

PATCH/api/v1/admissions/applications/:id/journey/guardian

Guardian

admission:update

Declared request fields: name (required), phone (required), email (optional), relationship (required).

PATCH/api/v1/admissions/applications/:id/journey/visit

Visit

admission:update

Declared request fields: scheduledAt (required), status (required), host (required), notes (optional).

PATCH/api/v1/admissions/applications/:id/journey/documents

Document

admission:update

Declared request fields: uploadId (optional), kind (required), status (required), reference (optional), notes (optional).

POST/api/v1/admissions/applications/:id/journey/documents/review

Review

admission:manage

Declared request fields: uploadId (optional), kind (required), status (required), reference (optional), notes (optional).

POST/api/v1/admissions/applications/:id/journey/parent-access

Parent Access

admission:manage

Declared request fields: password (required).

POST/api/v1/admissions/public/:schoolCode/enquiries

Create

Public/capability access as implemented

Declared request fields: studentName (required), parentName (required), phone (required), email (optional), classApplying (required), message (optional), website (optional), consent (required).

Open the actual application

ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.

/en/school/admissionsOpen ↗

Admissions & applicant journey

What you can do

Enquiry pipeline

Contact attempts

Application stages

Guardian details

Campus visits

Document review

Applicant access links

Student placement

Parent invitation

Access & setup

How the workflow works

Record or select an enquiry and log the next follow-up

Open a linked application and review guardian details

Receive and verify required documents and review readiness

Select session, class and section before admitting the applicant

Request fields to understand

Rules & current limits

Try admissions & applicant journey

API & permissions reference

Open the actual application

Keep exploring