/api/applications/ID/offers/ID/letters

Letterheads are document templates that can be used to generate attachments to offers.

In reality, there is also a middle-step in that process — first a Letter is created from the Letterhead. Such a Letter represents a generated (and potentially user-customised) document, where each template marker has already been replaced by actual applicant data. For the purposes of attaching to an offer, the Letter is converted to a PDF and attached to an offer just like a regular uploaded PDF. All of this happens seamlessly in the UI, however, for the API the entire data model is explicitly shown.

Fetching a list of the Letters is usually not useful for the API consumers. The GET calls are only offered for the sake of completeness.

The only useful call here is the one to generate a new letter. As a matter of convenience, such letters get also attached automatically to the offer in question. Read more below.

Get a list of all letters that have been generated from

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

Content-Type: application/json
Content-Length: 1234
X-Count: 1

{
  "1": {
    "id": 1,
    "rendered": "2025-01-02T15:44:09+00:00",
    "letterhead": "/api/letterheads/1",
    "administrator": null
  }
}

TODO

POST /api/applications/123/offers/321/letters
Host: apply.example.edu
Authorization: DREAM apikey="..."

Content-Type: application/json
Content-Length: 0
Location: /api/applications/123/offers/321/letters/1001