Contacts File
While email is not required for each contact, it is Beamery's best practice that all contacts be added with a valid email address.
| Field Name | Type | Required | Description | Example |
|
ID |
String |
|
This is a unique identifier of the contact.
The same ID must be used in supporting files
in order for the data in those files to me
tied to the contact. |
efa64c3a-bb5c-4995-86d1-aec3722e7c27 |
| FirstName | String |
|
The first name of the candidate | Joe |
| LastName | String |
|
The last name of the candidate. | Doe |
| MiddleNames | List of strings | List of candidate middle names separated by five (5) semicolons. Please remove all leading/trailing white space! | Percival;;;;;Wulfric;;;;;Brian | |
| Emails | List of strings | List of candidate emails separated by five (5) semicolons. Please remove all leading/trailing white space! | joe.doe@beamery.com ;;;;;joedoe@gmailcom | |
| PhoneNumbers | List of strings | List of candidate phone numbers separated by five (5) semicolons. Please remove all leading/trailing white space! | 01388000000;;;;;+44(0)7888888888 | |
| SocialLinks | List of strings | List of candidate social links separated by five (5) semicolons. Please remove all leading/trailing white space! | https://www.linkedin.com/in/ pkilovatiy | |
| Address | String | Candidate's residential address | 2701 Stacy Ln, Austin, TX 78704, USA | |
| Country | String | Country associated with the address mentioned above | United States | |
| Tags | List of strings | List of profile tags separated by five (5) semicolons. Please remove all leading/trailing white space! | Powerlifting;;;;;Anime;;;;Beamery Engineering | |
| Languages | List of strings | List of contact's spoken languages separated by five (5) semicolons. Please remove all leading/trailing white space! | British English;;;;;Japanese | |
| Source | String | This is the human readable value of the Source of the contact. | Direct | |
| Skills | List of strings | List of candidate skills separated by five (5) semicolons. Please remove all leading/trailing white space! | Java;;;;;Python;;;;;Project Management | |
| GlobalTags | List of strings | List of Global Tags separated by five (5) semicolons. Please remove all leading/trailing white space! | Silver Medalist | |
| Pool | String | Name of the talent pool where candidate should be added to. Pool must exist in customer's tenant prior to validation/contact load. | Developers - North America | |
| PoolStep | String |
|
Pool step is required for all pool types except for 'General' pool types. | Engaged |
| AssignedTo | String | Email address of the recruiter user account candidate should be assigned to. Such user must exist in the tenant. | joe.doe@beamery.com | |
| GDPRConsent | String |
set the gdprConsent field on the profile. Must be either "TRUE" or "FALSE" case sensitive New Field, please consult your IC if your company can use it |
TRUE | |
| DoNotContact | String |
set the Do Not Contact field on the profile. Must be either "TRUE" or "FALSE" case sensitive New Field, please consult your IC if your company can use it |
TRUE | |
| GDPRConsentDate | String |
set the gdprConsentDate field on the profile. Must in in ISO format; format is "YYYY-MM-DDTHH:mm:ss.sssZ" New Field, please consult your IC if your company can use it |
2024-07-23T15:00:00.000Z | |
| ContactType | String |
sets the contact type field on the profile. Must be "internal", "external", & "alumni" New Field, please consult your IC if your company can use it |
internal | |
| PrimaryEmail | String |
sets the primary email on the profile in case more than one email exists. If it's not provided then the first email in the Emails field is used as primary email New Field, please consult your IC if your company can use it |
joedoe@gmailcom |
Experience File
| Field Name | Type | Required | Description | Example |
| ID | String | This is a unique identifier of the contact. If the historical experience is to be created for a contact, the contact must also exist in the contacts file and the referenced in the Contacts CSV must match. | efa64c3a-bb5c-4995-86d1-aec3722e7c27 | |
| Role | String | This is the title the contact had for the given role. | Data Scientist | |
| OrganisationName | String | The name of the organisation where the contact was employed. | Beamery | |
| StartDate | Date | This is the start date of when the contact started the given role. Note that format is YEAR-MONTH-DAY | 2020-02-17 | |
| EndDate | Date | This is the end date of when the contact completed the given role. Note that format is YEAR-MONTH-DAY | 2022-08-17 | |
| Current | Boolean | Is the contact currently employed at this organisation? | True | |
| Description | String | A description of the given experience. | Data scientist responsible for helping improve AI functionality for candidate matching. |
Education File
| Field Name | Type | Required | Description | Example |
| ID | String | This is a unique identifier of the contact. If the education is to be created for a contact, the contact must also exist in the contact file and the ID referenced in the contacts.csv must match. | efa64c3a-bb5c-4995-86d1-aec3722e7c27 | |
| Degree | String | This is the degree type that the contact studied. | Bachelors | |
| Program | String | This is the field of study that was taken. | Engineering | |
| OrganisationName | String | This is the institute where the studying took place. | Northwestern University | |
| StartDate | Date | This is the start date of when the contact completed the given education. Note that format is YEAR-MONTH-DAY | 2020-02-17 | |
| EndDate | Date | This is the end date of when the contact completed the given education. Note that format is YEAR-MONTH-DAY | 2022-08-17 | |
| Current | Boolean | This highlights whether the given education is the contact's current education or not ie. they are currently in education. | True |
Custom Fields File
| Field Name | Type | Required | Description | Example |
| ID | String | This is a unique identifier of the contact. If the custom field data is to be created for a contact, the contact's ID must also exist in the contacts file. |
efa64c3a-bb5c-4995-86d1-aec3722e7c27 | |
| Name | String | The name of the custom field in Beamery. The name of the custom field must match what's in the file exactly, including spaces, punctuation and capitalization | Are you open to relocation? | |
| Value | String | The value in the custom field. Must match exactly, including spaces, punctuation and capitalization. | Yes |
Notes File
| Field Name | Type | Required | Description | Example |
| ID | String | This is a unique identifier of the contact. If the notes are to be added for a contact, the contact must also exist in the contacts file and the ID referenced in the Contacts CSV must match. |
efa64c3a-bb5c-4995-86d1-aec3722e7c27 | |
| Text | String | This is the note text. Please wrap all text in double quotes to allow for handling of additional comma's and special characters. | “Candidate would be a great cultural fit!” | |
| IsPrivate | String | Mark the note as private? | false | |
| PublishedAt | DateTime | This is date Note that format is in ISO format which includes the date and time. | 2022-09-15T11:09:50.160Z |
Attachments File
All attachments need to be uniquely identifiable and have a maximum size limit of 10MB for an individual file.
Note: Files that are to be loaded as attachments in Beamery, must be uploaded to the SFTP server in a designated folder, DataMigration/Attachments .
| Field Name | Type | Required | Description | Example |
| ID | String | This is a unique identifier of the contact. If an attachment is to be added for a contact, the contact must also exist in the contacts file and the ID referenced in the Contacts CSV must match. | efa64c3a-bb5c-4995-86d1-aec3722e7c27 | |
| FileName | String |
The name of the attachment. .txt .doc / .docx .jpg / .jpeg / .tif / .png |
Dwayne_Johnson_Resume.pdf |
| ID | FileName |
| efa64c3a-bb5c-4995-86d1-aec3722e7c27 | Dwayne_Johnson_Resume.pdf |
ID
Sample Value: efa64c3a-bb5c-4995-86d1-aec3722e7c27
A string field.
ID is a reference to Contacts CSV
This field cannot be null .
FileName
Sample Value: Attachments-Sub-Folder/8qw2mApLPX.pdf
A string field.
This denotes the unique name of he attachment and the path to it. The path should start from the attachment folder as root folder
This field cannot be null .
Examples
Example 1
If the file path is
/incoming/attachments/filename.pdf
the attachments.csv file will be in
/incoming/
and the path for the file record (in the filename field in the attachments.csv file) will be
filename.pdf
Example 2
If the file path is
/incoming/import/attachments/attachment_sub_folder/filename.pdf
the attachments.csv file will be in
/incoming/import/
and the path for the file record (in the 'FileName' field in the attachments.csv file) will be
attachment_sub_folder/filename.pdf