POST
/
api
/
ats
/
v1
/
candidates
/
{candidate_id}
/
attachments
curl --request POST \
  --url https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-connector-token: <x-connector-token>' \
  --data '{
  "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"
}'
"<any>"

Currently this functionality is available for Success Factor and Teamtailor

🚨 Note: File size cannot exceed 5 MB.

​
For SAP Success Factor Integration

If integrating with SAP_SUCCESS_FACTOR, the request body must only contain:

KeyTypeRequiredDescription
file_namestringrequiredName of the file including its extension
file_contentstring (base64)requiredBase64 encoded file content
remote_user_idUUIDrequiredUUID of remote user created by Bindbee

​
For Teamtailor Integration

If integrating with Teamtailor, the request body must only contain:

KeyTypeRequiredDescription
file_namestringrequiredName of the file including its extension
file_urlstringrequiredPublically accessible file url
remote_user_idUUIDrequiredUUID of remote user created by Bindbee

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-connector-token
string
required

Path Parameters

​
candidate_id
string
required

Body

application/json

The AtsAttachmentWriteForCandidate object is used to represent a file attachment linked to a candidate's application within the ATS.

​
file_name
string | null

The name of the file attached.

Example:

"resume.pdf"

​
file_url
string | null

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

Required string length: 1 - 2083
Example:

"https://example.com/path/to/resume.pdf"

​
attachment_type
string | null

The type of attachment, such as 'resume', 'cover letter', etc.

Example:

"RESUME"

​
file_content
string | null

File in base64 format

Example:

"SGVsbG8sIFdvcmxkIQ=="

​
content_type
string | null

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

Example:

"application/pdf"

​
candidate
string | null

The candidate to whom the attachment belongs.

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

​
remote_user_id
string | null

The id of user using the integration

Example:

"018b4bfb-5ece-70b1-ad5e-862a9433aa65"

Response

200
application/json
Successful Response

The response is of type any.