BIbindbee
Candidate

Create Candidate Attachment

Changed on

Uploads an attachment for a given candidate.

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

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Path parameters

candidate_idstring uuid required

Request body

file_namestring nullable

The name of the file attached.

attachment_typestring 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_urlstring uri nullable

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

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",
  "attachment_type": "RESUME",
  "file_url": "https://example.com/path/to/resume.pdf",
  "file_content": "SGVsbG8sIFdvcmxkIQ==",
  "content_type": "application/pdf",
  "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "remote_user_id": "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
}

Response

Successful Response

unknown required

Changes

  • 1f9bc0ad4bfbRevision changes
    • breaking

      removed the enum value - of the request property

    • breaking

      removed the enum value COVER_LETTER of the request property

    • breaking

      removed the enum value OFFER_LETTER of the request property

    • breaking

      removed the enum value OTHER of the request property

    • breaking

      removed the enum value RESUME of the request property

    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API