Understand the different types of fields available for mapping contact attributes in Employee Email.
Employee Email provides two types of fields for mapping your synced contact data. Use the following fields with a Contact API integration:
- Default Fields
- Custom Fields
There are 7 Default Fields for contact data that are pre-set when an organization’s Employee Email account is created. You cannot delete or modify the default fields, but their values can be updated or modified.
Every field has the following two names:
- Name used as an attribute in the API
- Name that appears in the user interface of the web app or Studio
| Attribute Name | User Interface Name | Notes |
|---|---|---|
firstName | First Name | |
lastName | Last Name | |
email | This is the default Unique Contact ID for each contact. You can change your organization’s Unique Contact ID to a different field such as employee number. A valid email should contain no empty spaces and a single @ symbol. | |
location | Location | |
department | Department | |
jobTitle | Job Title | |
phone | Phone |
This is a JSON sample request of the default fields.
1{2 "firstName": "User",3 "lastName": "User",4 "email": "user@email.com",5 "location": "San Francisco",6 "department": "Marketing",7 "phone": "999-999-999"8}
Each organization can add an unlimited number of Custom Fields to represent attributes they want to map from their own data sources. These fields are specific to the organization and can be modified at any time.
Every field has the following two names:
- Name used as an attribute in the API
- Name that appears in the user interface of the web app or Studio
The names of these attributes in the API follow the same capitalization and spacing rules as the Default Fields.
No capital letters are used, except as a substitute instead of a space between words.
For example, a field named Start Date is referenced as startDate in the API.
On the API side, all custom fields are embedded within an object called customFields.
In the following JSON example, there are two Custom Fields:
team(Team)birthday(Birthday)
1{2 "firstName": "User",3 "lastName": "User",4 "email": "user@email.com",5 "location": "San Francisco",6 "department": "Department",7 "jobTitle": "Sales",8 "customFields": {9 "team": "Team 01",10 "birthday": "1950-01-02"11 }12}