Sign in
Candidate

Create Candidate Attachment

Uploads an attachment for a given candidate.

post/api/ats/v1/candidates/{candidate_id}/attachments

Path parameters

candidate_idstring uuid required

Headers

x-connector-tokenstring required

Request body

file_namestring nullable

The name of the file attached.

file_urlstring uri nullable

The URL where the file is stored and can be retrieved.

attachment_type'RESUME' | 'COVER_LETTER' | 'OFFER_LETTER' | 'OTHER' | '-' nullable

The type of attachment. If the value is not one of the defined enum values, the original value passed through will be returned.

file_contentstring nullable

File in base64 format

content_typestring nullable

The MIME type of the file (e.g., 'application/pdf', 'image/png').

candidatestring uuid nullable

The candidate to whom the attachment belongs.

remote_user_idstring uuid nullable

The id of user using the integration

Example request

{
  "file_name": "resume.pdf",
  "file_url": "https://example.com/path/to/resume.pdf",
  "attachment_type": "RESUME",
  "file_content": "SGVsbG8sIFdvcmxkIQ==",
  "content_type": "application/pdf",
  "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "remote_user_id": "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
}

Response

Successful Response

{"stackTrail":"paths:/api/ats/v1/candidates/{candidate_id}/attachments:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 2 of the 11 revisions of this API.14

  • a606b0cf18c91See the full diff
    • ▲

      for the path request parameter candidate_id, the type/format was changed from string/ to string/uuid

      request-parameter-type-changed

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • eb3486b88e554See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added