POST
/
v1.0
/
{company_id}
/
candidates
/
{candidate_id}
/
notes
curl --request POST \
  --url https://api.hirehive.com/v1.0/{company_id}/candidates/{candidate_id}/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "<string>",
  "files": [
    {
      "name": "<string>",
      "original_name": "<string>",
      "content_type": "<string>",
      "file_extension": "<string>",
      "id": "<string>",
      "type": "inbound_email_attachment",
      "size_in_kb": 123,
      "download_link": "<string>"
    }
  ],
  "mentioned_users": [
    "<string>"
  ],
  "restricted": true
}'
{
  "data": {
    "id": "<string>",
    "date_created": "2023-11-07T05:31:56Z",
    "text": "<string>",
    "creator": {
      "name": "<string>",
      "user_id": "<string>",
      "guest_id": "<string>",
      "recruiter": "<string>"
    },
    "files": [
      {
        "name": "<string>",
        "original_name": "<string>",
        "content_type": "<string>",
        "file_extension": "<string>",
        "id": "<string>",
        "type": "inbound_email_attachment",
        "size_in_kb": 123,
        "download_link": "<string>"
      }
    ],
    "mentioned_users": [
      "<string>"
    ],
    "restricted": true,
    "share": {
      "id": "<string>",
      "application_id": "<string>",
      "message": "<string>",
      "metadata": {
        "expires_at": "2023-11-07T05:31:56Z",
        "visits": 123,
        "expired": true,
        "revoked": true
      },
      "guest": {
        "id": "<string>",
        "email": "<string>"
      },
      "sender": {
        "id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>"
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
company_id
string
required
​
candidate_id
string
required

Query Parameters

​
application_id
string

Body

application/json
​
text
string
​
files
object[] | null
​
mentioned_users
string[] | null
​
restricted
boolean

Response

201
application/json
​
data
object

Was this page helpful?

Suggest editsRaise issue