Create Profile Note

post

https://apiv2.{domain}.ai/api/v2/core/profile-notes

Create a profile note for a candidate. profileId is required. noteType must be one of note, email, other, title_note — email is intended for internal integrations or callers from allowed domains only, as email notes appear in sourcing analytics and recruiter dashboards. positionId is optional.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

exclude

string

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyList

string

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Body Params

profileId

string

required

Profile id of candidate

positionId

string | null

Position id associated with the note

noteType

string | null

enum

Note type of candidate. Valid values: note, email, other. Note: email is intended for internal integrations or callers from allowed domains only — email notes appear in sourcing analytics and recruiter dashboards.

Allowed:

note

string | null

Note of candidate

Headers

Authorization

string

required

The secret key to access the api. It starts with the bearer token

Response

200OK