Notes
Add a new note
Creates a new note for a candidate
POST
/
note
Add a new note
curl --request POST \
--url https://jobaffinity.fr/restapi/v1/note \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"candidate_id": 123,
"organisation_id": 123,
"text": "<string>"
}
'import requests
url = "https://jobaffinity.fr/restapi/v1/note"
payload = {
"candidate_id": 123,
"organisation_id": 123,
"text": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({candidate_id: 123, organisation_id: 123, text: '<string>'})
};
fetch('https://jobaffinity.fr/restapi/v1/note', 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://jobaffinity.fr/restapi/v1/note",
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([
'candidate_id' => 123,
'organisation_id' => 123,
'text' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://jobaffinity.fr/restapi/v1/note"
payload := strings.NewReader("{\n \"candidate_id\": 123,\n \"organisation_id\": 123,\n \"text\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://jobaffinity.fr/restapi/v1/note")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"candidate_id\": 123,\n \"organisation_id\": 123,\n \"text\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://jobaffinity.fr/restapi/v1/note")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidate_id\": 123,\n \"organisation_id\": 123,\n \"text\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_actions": [
{}
]
}{
"_status": "INVALID",
"invalid": {}
}Authorizations
HTTP Basic Authentication with API credentials
Body
application/json
Identifier of the candidate. Provided by the .id field of the candidate detail resource.
Identifier of the organisation for note visibility. Only users in this organisation will be able to see the note. Provided by the .organisation.id field of the job detail resource.
Note content. Can be HTML formatted (basic formatting tags only; script tags and style attributes are stripped).
⌘I
Add a new note
curl --request POST \
--url https://jobaffinity.fr/restapi/v1/note \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"candidate_id": 123,
"organisation_id": 123,
"text": "<string>"
}
'import requests
url = "https://jobaffinity.fr/restapi/v1/note"
payload = {
"candidate_id": 123,
"organisation_id": 123,
"text": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({candidate_id: 123, organisation_id: 123, text: '<string>'})
};
fetch('https://jobaffinity.fr/restapi/v1/note', 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://jobaffinity.fr/restapi/v1/note",
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([
'candidate_id' => 123,
'organisation_id' => 123,
'text' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://jobaffinity.fr/restapi/v1/note"
payload := strings.NewReader("{\n \"candidate_id\": 123,\n \"organisation_id\": 123,\n \"text\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://jobaffinity.fr/restapi/v1/note")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"candidate_id\": 123,\n \"organisation_id\": 123,\n \"text\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://jobaffinity.fr/restapi/v1/note")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidate_id\": 123,\n \"organisation_id\": 123,\n \"text\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"_actions": [
{}
]
}{
"_status": "INVALID",
"invalid": {}
}