Offer decision

Represents an offer decision resource.

/api/v10/applications/ID/offers/ID/decision
Host: apply.example.edu
Authorization: DREAM apikey="..."

GET Get the offer decision

Retrieve the offer decision that an applicant has made or the offer decision made by an Administrator on behalf of the applicant.

The API request can return one of the following decisions:

• Final: The offer was accepted by the applicant
• Declined: The offer was declined by the applicant
• None: No decision yet

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

Response headers

Response codes

Example response

"Declined"

PUT Set the offer decision

Set the offer decision on behalf of the applicant. For example, you can mark an offer as Declined or Final (accepted).

When an applicant makes a decision through the DreamApply portal, DreamApply enforces the rules configured for the offer type. For example, setting an offer as Final (accepted) can automatically decline all other offers on the application. Or the offer type can be configured as exclusive, and the application cannot have more than one Final offer.

This API request does not enforce these rules. This gives you full control over the applicant’s offer decisions, but also makes you responsible for maintaining a consistent state.

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

Raw request body

The request body must contain the offer decision value enclosed in double quotes: None, Final or Declined.

"Declined"

Example request

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

Response headers

Response codes