Offer comments

Represents the offer letter text/comments for the application offer.

/api/v9/applications/ID/offers/ID/comments

GET Get the offer comments

A request with the GET verb returns the offer letter text (“comments”) for this particular offer (identified by offer ID).

GET /api/v9/applications/123/offers/321/comments
Host: apply.example.edu
Authorization: DREAM apikey="..."

Example request

curl \
  -X GET \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  "https://apply.example.edu/api/v9/applications/123/offers/321/comments"

Response headers

Response codes

Example response

"Hello\n\nCongratulations, you are now accepted to ...."

PUT Set the offer comments

Set the offer letter text (“comments”) to the application offer (identified by its ID).

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

Raw request body

The request body must contain a valid JSON object. In the JSON structure, you can use either plain text or text formatted using the Textile markup.

Upon successful validation, the provided text is saved as the offer letter text (“comments”) for the application.

• Plain text
• Textile formatted text

"Hello,\n\nThank you for your application!..."

"Hello,\n\nThank you for your application!\n\nPlease upload the following documents using the **Tasks** section in the portal:\n\n* Passport copy\n* Transcript copy"

Example request

• Plain text
• Textile formatted text

curl \
  -X PUT \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  -d '"Hello,\n\nThank you for your application!..."' \
  "https://apply.example.edu/api/v9/applications/123/offers/321/comments"

curl \
  -X PUT \
  -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
  -d '"Hello,\n\nThank you for your application!\n\nPlease upload the following documents using the **Tasks** section in the portal:\n\n* Passport copy\n* Transcript copy"' \
  "https://apply.example.edu/api/v9/applications/123/offers/321/comments"

Response headers