Sign in

v1

latestOpenAPI 3.0.02026-07-2415433242.1 KB
candidates

Update partially a candidate details.

patch/candidates/{id}/

Request body

idinteger
external_idstring nullable

Id of the candidate in the API consumer systems

full_namestring required

Full name of the candidate

creatorinteger

User who created the candidate

ownerinteger nullable

ID of the owner of the candidate - default to creator if none is provided

source_type'sourced' | 'applied' | 'referred' | 'agency' | 'other'

Origin of the candidate

source_otherstring nullable

Field to add manual information to the source if the source_type is other

consentboolean nullable

Whether the candidate gave permission to use his data (GDPR,Brazil's LGPD, USA´s CCPA ...)

consent_datestring date-time

Date at which the candidate gave his consent

picturestring uri

Link to the candidate picture

emailstring email nullable

Candidate email

resumestring

Link to the candidate resume

phone_numberstring nullable

Candidate phone number

gender'male' | 'female' | 'other' | 'unknown' nullable

Gender of the candidate

birth_datestring date nullable

Candidate birth date

addressstring

Full address of the candidate

zipcodestring

Code for the city of the address field

latest_degreestring nullable

Latest degree obtained by the candidate

latest_universitystring nullable

Latest university the candidate graduated from

current_companystring nullable

Company where the candidate currently works

current_departmentstring nullable

Department where the candidate works

current_positionstring nullable

Position of the candidate at his current job

descriptionstring

Description of the candidate - can only input text here.

hashstring

Unique hash of the candidate

custom_fieldsobject

Candidate values for custom fields defined in Manatal.

created_atstring date-time

Date at which the candidate was created

updated_atstring date-time

Response

idinteger
external_idstring nullable

Id of the candidate in the API consumer systems

full_namestring required

Full name of the candidate

creatorinteger

User who created the candidate

ownerinteger nullable

ID of the owner of the candidate - default to creator if none is provided

source_type'sourced' | 'applied' | 'referred' | 'agency' | 'other'

Origin of the candidate

source_otherstring nullable

Field to add manual information to the source if the source_type is other

consentboolean nullable

Whether the candidate gave permission to use his data (GDPR,Brazil's LGPD, USA´s CCPA ...)

consent_datestring date-time

Date at which the candidate gave his consent

picturestring uri

Link to the candidate picture

emailstring email nullable

Candidate email

resumestring

Link to the candidate resume

phone_numberstring nullable

Candidate phone number

gender'male' | 'female' | 'other' | 'unknown' nullable

Gender of the candidate

birth_datestring date nullable

Candidate birth date

addressstring

Full address of the candidate

zipcodestring

Code for the city of the address field

latest_degreestring nullable

Latest degree obtained by the candidate

latest_universitystring nullable

Latest university the candidate graduated from

current_companystring nullable

Company where the candidate currently works

current_departmentstring nullable

Department where the candidate works

current_positionstring nullable

Position of the candidate at his current job

descriptionstring

Description of the candidate - can only input text here.

hashstring

Unique hash of the candidate

custom_fieldsobject

Candidate values for custom fields defined in Manatal.

created_atstring date-time

Date at which the candidate was created

updated_atstring date-time