Skip to main content
POST
preview_offer

Authorizations

Authorization
string
header
required

Company API key minted at Settings → API. Prefix hf_. Accepted on hiring data routes. Not accepted on MCP.

Path Parameters

application_id
string
required

Application UUID.

Body

application/json
subject
string

Optional. The email's subject. Blank uses your Offer template's.

body
string

Optional. The letter in markdown, as you'd send it. Blank uses your Offer template. Tokens like {{first_name}} are filled; {{pay}}, {{start_date}}, and {{respond_by}} are filled from the fields below.

pay
string

Optional. Pay as the letter should say it, like "$185,000 a year". Required when the letter has {{pay}}.

start_date
string

Optional. YYYY-MM-DD. Required when the letter has {{start_date}}; written out as November 2, 2026.

respond_by
string

Optional. YYYY-MM-DD, the date you'd like an answer by. Required when the letter has {{respond_by}}. Text in the letter, not an expiry.

Response

200 - application/pdf

Success

The response is of type file.