Create attachment

post

https://harvest.greenhouse.io/v3/attachments

Attach a file to an existing application. Supply the bytes inline as base64-encoded content, or point Greenhouse at a publicly fetchable url and we will download the file on your behalf — exactly one of the two is required. type controls how the attachment is classified in Greenhouse (resume, cover_letter, offer_letter, etc.); uploading a resume or cover_letter replaces any prior attachment of that type by reclassifying the existing one as other. Filenames are validated against the organization's blocklisted-extensions list (for example, .html is rejected for take_home_test).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

application_id

integer

required

Id of the application the attachment will be associated with.

filename

string

required

Filename to store the attachment under, including extension. Extensions present in the organization's blocklisted-extensions list are rejected.

type

string

enum

required

Classification of the attachment. resume, cover_letter, and take_home_test are candidate-supplied documents; offer_packet, offer_letter, and signed_offer_letter are offer documents; midfunnel_agreement and automated_agreement are e-signed documents; form_attachment is generated by Greenhouse forms; other is the free-form bucket.

content

string

required

Base64-encoded file contents. Provide either content or url, not both.

url

string

Publicly fetchable URL Greenhouse should download the file from. Provide either url or content, not both.

visibility

string

enum

Who can see the attachment within Greenhouse. public is visible to site admins, job admins, and assigned interviewers; admin_only is restricted to site admins and assigned job admins; private is restricted to admins with explicit private-candidate access. Defaults are inferred from type when omitted.

Allowed:

Responses

401

Unauthorized

403

Forbidden

422

Unprocessable Content

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful