Offer comments

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

/api/v10/applications/ID/offers/ID/comments

GET Get the offer comments

Retrieve the text/comments for an offer letter.

GET /api/v10/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/v10/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 text/comments for an offer letter.

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

Raw request body

The request body must contain a valid JSON object. 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 offer.

• 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/v10/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/v10/applications/123/offers/321/comments"

Response headers