Application freezing

Represents a resource that allows freezing an application.

URI
/api/v9/applications/ID/freeze

POST Freeze an application

Freeze the application data to prevent further changes by the applicant.

When an application is frozen, the existing scores on the scoresheets to which the application is added are also frozen and cannot be edited by an applicant. Administrators can still update the application data and scores through the administrative portal.

To record the action, DreamApply creates the Application was frozen journal event.

Syntax
POST /api/v9/applications/123/freeze
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

Request
curl
curl \
  -X POST \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/applications/123/freeze"

Response codes

Response codeDescription
201 CreatedThe application was successfully frozen
404 Not FoundThe application was not found