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"
}
'import requests
url = "https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments"
payload = {
"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"
}
headers = {
"x-connector-token": "<x-connector-token>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-connector-token': '<x-connector-token>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
})
};
fetch('https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-connector-token: <x-connector-token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments"
payload := strings.NewReader("{\n \"file_name\": \"resume.pdf\",\n \"file_url\": \"https://example.com/path/to/resume.pdf\",\n \"attachment_type\": \"RESUME\",\n \"file_content\": \"SGVsbG8sIFdvcmxkIQ==\",\n \"content_type\": \"application/pdf\",\n \"candidate\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\",\n \"remote_user_id\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-connector-token", "<x-connector-token>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments")
.header("x-connector-token", "<x-connector-token>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"file_name\": \"resume.pdf\",\n \"file_url\": \"https://example.com/path/to/resume.pdf\",\n \"attachment_type\": \"RESUME\",\n \"file_content\": \"SGVsbG8sIFdvcmxkIQ==\",\n \"content_type\": \"application/pdf\",\n \"candidate\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\",\n \"remote_user_id\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-connector-token"] = '<x-connector-token>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file_name\": \"resume.pdf\",\n \"file_url\": \"https://example.com/path/to/resume.pdf\",\n \"attachment_type\": \"RESUME\",\n \"file_content\": \"SGVsbG8sIFdvcmxkIQ==\",\n \"content_type\": \"application/pdf\",\n \"candidate\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\",\n \"remote_user_id\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Create Candidate Attachment
Uploads an attachment for a given candidate.
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"
}
'import requests
url = "https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments"
payload = {
"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"
}
headers = {
"x-connector-token": "<x-connector-token>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-connector-token': '<x-connector-token>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
})
};
fetch('https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-connector-token: <x-connector-token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments"
payload := strings.NewReader("{\n \"file_name\": \"resume.pdf\",\n \"file_url\": \"https://example.com/path/to/resume.pdf\",\n \"attachment_type\": \"RESUME\",\n \"file_content\": \"SGVsbG8sIFdvcmxkIQ==\",\n \"content_type\": \"application/pdf\",\n \"candidate\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\",\n \"remote_user_id\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-connector-token", "<x-connector-token>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments")
.header("x-connector-token", "<x-connector-token>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"file_name\": \"resume.pdf\",\n \"file_url\": \"https://example.com/path/to/resume.pdf\",\n \"attachment_type\": \"RESUME\",\n \"file_content\": \"SGVsbG8sIFdvcmxkIQ==\",\n \"content_type\": \"application/pdf\",\n \"candidate\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\",\n \"remote_user_id\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bindbee.dev/api/ats/v1/candidates/{candidate_id}/attachments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-connector-token"] = '<x-connector-token>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"file_name\": \"resume.pdf\",\n \"file_url\": \"https://example.com/path/to/resume.pdf\",\n \"attachment_type\": \"RESUME\",\n \"file_content\": \"SGVsbG8sIFdvcmxkIQ==\",\n \"content_type\": \"application/pdf\",\n \"candidate\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\",\n \"remote_user_id\": \"018b4bfb-5ece-70b1-ad5e-862a9433aa65\"\n}"
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}For SAP Success Factor Integration
If integrating with SAP_SUCCESS_FACTOR, the request body must only contain:| Key | Type | Required | Description |
|---|---|---|---|
file_name | string | required | Name of the file including its extension |
file_content | string (base64) | required | Base64 encoded file content |
remote_user_id | UUID | required | UUID of remote user created by Bindbee |
For Teamtailor Integration
If integrating with Teamtailor, the request body must only contain:| Key | Type | Required | Description |
|---|---|---|---|
file_name | string | required | Name of the file including its extension |
file_url | string | required | Publically accessible file url |
remote_user_id | UUID | required | UUID of remote user created by Bindbee |
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Body
The AtsAttachmentWriteForCandidate object is used to represent a file attachment linked to a candidate's application within the ATS.
The name of the file attached.
"resume.pdf"
The URL where the file is stored and can be retrieved.
1 - 2083"https://example.com/path/to/resume.pdf"
The type of attachment. If the value is not one of the defined enum values, the original value passed through will be returned.
RESUME, COVER_LETTER, OFFER_LETTER, OTHER, - "RESUME"
File in base64 format
"SGVsbG8sIFdvcmxkIQ=="
The MIME type of the file (e.g., 'application/pdf', 'image/png').
"application/pdf"
The candidate to whom the attachment belongs.
"018b4bfb-5ece-70b1-ad5e-862a9433aa65"
The id of user using the integration
"018b4bfb-5ece-70b1-ad5e-862a9433aa65"
Response
Successful Response
Was this page helpful?