Offer type

Represents the type of an application offer.

/api/v10/applications/ID/offers/ID/type

GET Get the offer type

Retrieve the type of an offer created for an application.

GET /api/v10/applications/123/offers/321/type
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/offers/321/type"

Response headers

Response codes

Example response

• API version >= 4
• API version < 4

{
    "id": 12,
    "type": "/api/v4/applications/offers/types/12"
}

"Conditionally accepted"

PUT Set the offer type

Set the type for a specific offer created for an application.

The API request first checks if the specified type is a valid offer type configured in DreamApply. Upon successful validation, the specified type is assigned to the application offer.

PUT /api/v10/applications/123/offers/321/type
Host: apply.example.edu
Authorization: DREAM apikey="..."

Raw request body

Depending on the API version, the request body must contain an integer (offer ID) or a JSON string in double quotes indicating the offer type.

• API version >= 4
• API version < 4

18

"Conditionally accepted"

Example request

curl \
  -X PUT \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  -d '18' \
  "https://apply.example.edu/api/v4/applications/123/offers/321/type"

Response headers

Response codes