Update note

cURL

curl --request PUT \
  --url https://api.hirehive.com/v1.0/{company_id}/jobs/{job_id}/notes/{note_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "files": [
    {
      "id": "<string>",
      "type": "inbound_email_attachment",
      "size_in_kb": 123,
      "download_link": "<string>",
      "name": "<string>",
      "original_name": "<string>",
      "content_type": "<string>",
      "file_extension": "<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": [
      {
        "id": "<string>",
        "type": "inbound_email_attachment",
        "size_in_kb": 123,
        "download_link": "<string>",
        "name": "<string>",
        "original_name": "<string>",
        "content_type": "<string>",
        "file_extension": "<string>"
      }
    ],
    "mentioned_users": [
      "<string>"
    ],
    "restricted": true
  }
}

PUT

v1.0

{company_id}

jobs

{job_id}

notes

{note_id}

cURL

curl --request PUT \
  --url https://api.hirehive.com/v1.0/{company_id}/jobs/{job_id}/notes/{note_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "files": [
    {
      "id": "<string>",
      "type": "inbound_email_attachment",
      "size_in_kb": 123,
      "download_link": "<string>",
      "name": "<string>",
      "original_name": "<string>",
      "content_type": "<string>",
      "file_extension": "<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": [
      {
        "id": "<string>",
        "type": "inbound_email_attachment",
        "size_in_kb": 123,
        "download_link": "<string>",
        "name": "<string>",
        "original_name": "<string>",
        "content_type": "<string>",
        "file_extension": "<string>"
      }
    ],
    "mentioned_users": [
      "<string>"
    ],
    "restricted": true
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

company_id

string<string>

required

job_id

string<string>

required

note_id

string<string>

required

Body

application/json

text

string

files

object[] | null

Show child attributes

files.id

string<int32>

files.type

enum<string>

Available options:

inbound_email_attachment,

outbound_email_attachment,

person_note_attachment,

job_note_attachment,

sign_in_branding_logo,

curriculum_vitae,

pdf_previews,

company_logo,

hero_image,

thumb_image,

style_sheet,

profile_images,

public_image,

candidate_file,

pdf_report,

linked_in_share_image,

temp_cv_file,

facebook_linked_in_meta_share_image,

twitter_meta_share_image,

company_export,

logging_file

files.size_in_kb

integer<int32>

files.download_link

string

files.name

string

files.original_name

string

files.content_type

string

files.file_extension

string

mentioned_users

string<int32>[] | null

restricted

boolean

Response

data

object

Show child attributes

data.id

string<int32>

data.date_created

string<date-time>

data.text

string

data.creator

object

Show child attributes

data.creator.name

string

data.creator.user_id

string<int32> | null

data.creator.guest_id

string<int32> | null

data.creator.recruiter

string | null

data.files

object[]

Show child attributes

data.files.id

string<int32>

data.files.type

enum<string>

Available options:

inbound_email_attachment,

outbound_email_attachment,

person_note_attachment,

job_note_attachment,

sign_in_branding_logo,

curriculum_vitae,

pdf_previews,

company_logo,

hero_image,

thumb_image,

style_sheet,

profile_images,

public_image,

candidate_file,

pdf_report,

linked_in_share_image,

temp_cv_file,

facebook_linked_in_meta_share_image,

twitter_meta_share_image,

company_export,

logging_file

data.files.size_in_kb

integer<int32>

data.files.download_link

string

data.files.name

string

data.files.original_name

string

data.files.content_type

string

data.files.file_extension

string

data.mentioned_users

string<int32>[]

data.restricted

boolean

Create note Delete note

⌘I

Getting Started

Endpoints

Webhooks

Authorizations

Path Parameters

Body

Response