v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB

Profile Note

Create Profile Note

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.

post/api/v2/core/profile-notes

Query parameters

excludestring

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.

keyListstring

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.

Headers

Authorizationstring required

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

Request body

profileIdstring required

Profile id of candidate

positionIdstring nullable

Position id associated with the note

noteType'note' | 'email' | 'other' nullable

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.

notestring nullable

Note of candidate

Response

creatorEmailstring nullable

creator email of candidate

idstring nullable

Note id of candidate

noteTypestring nullable

Note type of candidate

notestring nullable

Note of candidate

profileIdstring nullable

Profile id of candidate

positionIdstring nullable

Position id associated with the note

createdTimeinteger nullable

created time of candidate in datetime format