Application closing
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a resource that allows closing an application
URI
/api/v9/applications/ID/closePOST Close an application
Close an application.
Closing an application formally finalizes the application status. It indicates that no further actions will be taken on the application, regardless of the admission decision.
To record the action, DreamApply creates the Application was closed journal event.
Syntax
POST /api/v9/applications/123/close
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/close"Response codes
| Response code | Description |
|---|---|
201 Created | The application was successfully closed |
400 Bad Request | This application cannot be closed, for example, if a request is sent to an already closed application |
404 Not Found | The application was not found |