Skip to navigation
UNSW Advance Institution APIApplications

Withdraw an application

View as Markdown

Moves the application to WITHDRAWN and closes any assessment that had started, so it stops appearing in an assessor’s queue. NOT REVERSIBLE: there is no un-withdraw, and reinstating means sending a new application. 404 if unknown, 409 if already withdrawn or if its assessment workflow has no WITHDRAWN status to move to.

Authentication

AuthorizationBearer

Paste a Keycloak access token (no "Bearer " prefix)

Path parameters

idstringRequiredformat: "uuid"

Request

Optionally, why. Stored on the application as statusDetail and shown to officers.
reasonstringOptional
Why it was withdrawn. Optional.

Response

The application is WITHDRAWN.
idstringOptionalformat: "uuid"
applicantIdstringOptionalformat: "uuid"
programCodestringOptional
yearintegerOptional
streamstringOptional
intakeCodestringOptional

Your own code for the intake the applicant is starting, e.g. "5269" for Term 3 2026.

Optional, but worth sending: our officers work applications in intake order, and one with no intake cannot be prioritised against the rest.

Send the code rather than the name. These are YOUR term codes, loaded from the intake schedule you supply us, so a code you use is a code we hold; one we do not recognise is refused with a 400 naming it.

intakestringOptional
The intake's name, e.g. "Term 3 2026". Null when no intake is set.
statusstringOptional

Application status: RECEIVED, READY, PROCESSING, WITHDRAWN or FAILED.

statusDetailstringOptional

Failure detail when status is FAILED; null otherwise.

workflowStatusstringOptional

Assessment workflow status once processed (e.g. DECIDED, CREDIT_TEAM_REVIEW); null while RECEIVED.

qualificationslist of objectsOptional
sourceNamestringOptional
The system this record was fed from, in your own vocabulary. Free text, and required whenever you send a sourceRef.
sourceRefstringOptional

Your own unique id for this application, e.g. an application number. Unique per sourceName.

sourceslist of objectsOptional

Your own references for this record, one per system you keep it in. A person or an application known by a different id in SITS than elsewhere carries both.

Optional. sourceName and sourceRef still work exactly as before and count as the FIRST entry here, so nothing you have already built needs to change. Send both forms and they are combined, with duplicates collapsed.

Order matters: the first entry is the one echoed back as sourceRef, and the one shown in lists and in the change feed.

specialisationslist of objectsOptional
The specialisations this application is for, in the order they were chosen. Empty when there are none.
submittedAtdatetimeOptional
updatedAtdatetimeOptional

Errors

400
Bad Request Error
404
Not Found Error
409
Conflict Error