Skip to main content
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>"
}
'
{
  "_actions": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

HTTP Basic Authentication with API credentials

Body

application/json
​
candidate_id
integer
required

Identifier of the candidate. Provided by the .id field of the candidate detail resource.

​
organisation_id
integer
required

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.

​
text
string
required

Note content. Can be HTML formatted (basic formatting tags only; script tags and style attributes are stripped).

Response

Note created successfully

​
_status
enum<string>
Available options:
OK,
INVALID
​
_actions
object[]