Flag

Represents a single flag assigned to an application. For a specific flag configured in DreamApply, see Flag (global).

/api/v10/applications/ID/flags/ID

GET Get a flag

Retrieve information about the flag association for an application.

This API request does not return the flag itself. It represents a relationship between an application and a flag. Follow the flag URI in the response to retrieve further information about the flag.

GET /api/v10/applications/123/flags/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v10/applications/123/flags/1"

Response headers

Response codes

Example response

{
  "assigned": "2025-12-09T13:26:29+00:00",
  "flag": "/api/v10/applications/flags/2"
}

PUT Assign a flag

Assign a specific flag to an application.

This API request does not create a new flag. It creates a relationship (association) between an existing flag and an application. The flag to be assigned must already exist in DreamApply.

To assign a flag:

1. Use POST /api/v10/applications/flags to create a flag.
2. Use this API request to set the flag to any number of applications.

PUT /api/v10/applications/123/flags/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

curl \
  -X PUT \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v10/applications/123/flags/1"

Response headers

Response codes

DELETE Delete a flag

Remove a flag from an application.

This API request does not delete the flag itself. It only removes an association between the flag and the application.

DELETE /api/v10/applications/123/flags/1
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

curl \
  -X DELETE \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v10/applications/123/flags/1"

Response headers

Response codes