| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name |
?string | ➖ | The name of an applicant. | Elon Musk |
coverLetter |
?string | ➖ | N/A | I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ... |
headline |
?string | ➖ | Typically a list of previous companies where the contact has worked or schools that the contact has attended | PepsiCo, Inc, Central Perk |
emails |
array<Components\Email> | ➖ | N/A | |
customFields |
array<Components\CustomField> | ➖ | N/A | |
phoneNumbers |
array<Components\PhoneNumber> | ➖ | N/A | |
addresses |
array<Components\Address> | ➖ | N/A | |
websites |
array<Components\Websites> | ➖ | N/A | |
socialLinks |
array<Components\SocialLinks> | ➖ | N/A | |
stageId |
?string | ➖ | N/A | 12345 |
recruiterId |
?string | ➖ | N/A | 12345 |
coordinatorId |
?string | ➖ | N/A | 12345 |
confidential |
?bool | ➖ | N/A | false |
anonymized |
?bool | ➖ | N/A | true |
passThrough |
array<Components\PassThroughBody> | ➖ | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. | |
firstName |
?string | ➖ | The first name of the person. | Elon |
lastName |
?string | ➖ | The last name of the person. | Musk |
middleName |
?string | ➖ | Middle name of the person. | D. |
initials |
?string | ➖ | The initials of the person, usually derived from their first, middle, and last names. | EM |
birthday |
\DateTime | ➖ | The date of birth of the person. | 2000-08-12 |
photoUrl |
?string | ➖ | The URL of the photo of a person. | https://unavatar.io/elon-musk |
title |
?string | ➖ | The job title of the person. | CEO |
applicationIds |
array<string> | ➖ | N/A | [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6" ] |
applications |
array<string> | ➖ | N/A | [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6" ] |
followers |
array<string> | ➖ | N/A | [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6" ] |
sources |
array<string> | ➖ | N/A | [ "Job site" ] |
tags |
array<string> | ➖ | N/A | [ "New" ] |
archived |
?bool | ➖ | N/A | false |
ownerId |
?string | ➖ | N/A | 54321 |
recordUrl |
?string | ➖ | N/A | https://app.intercom.io/contacts/12345 |
deleted |
?bool | ➖ | Flag to indicate if the object is deleted. | true |