Standard Fields

Following are the Standard Contact Fields that can be submitted through the API. You can also submit Custom Contact Fields. A red asterisk (*) indicates that the field is required, while a green caret ( ^) indicates that it is highly recommended.

Field values that include special characters must be wrapped in beginning and ending CDATA tags.

Field Name Description Type Length
Address1 Address of the contact being added to SmashFly. String 200
Address2 Address (additional line) of the contact being added to SmashFly. String 200
CanReceiveEmail^ True/False. Specifies if the contact can/should receive Email from the SmashFly Console. If not specified, this field is set to False by default. Boolean  
CanReceiveSMS ^ True/False. Specifies if the contact can/should receive SMS messages from the SmashFly Console. If not specified, this field is set to False by default. Boolean  
_CanReceiveEmailImpl ^ Set to True if specifying the CanReceiveEmail field. Boolean  
_CanReceiveSMSImpl ^ Set to True if specifying the CanReceiveSMS field. Boolean  
City City of the contact being added. String 50
Company Current / most recent company at which the contact has worked. String 150
ContactDBId* Contact Database ID. Required field. Numeric  
ContactListId

Contact List ID (for adding the contact to a specific list). To find a contact list’s ID:

  1. From the Contacts grid, expand the Lists accordion, and select the list to which you want to add the contact.
  2. Click the down arrow to the right of the list name to display a drop down menu, and then select List Info from the menu. A List Information window displays.
  3. Move the cursor over the Notes or Attachments tab in that window to display a URL at the bottom of the window.

The contact ID to include is the number that displays after folderid= in the URL reference at the bottom of the window (as highlighted by the red circle in the following graphic).

 Int  
Country Country of the contact's mailing address. For valid values, refer to the Countries documentation. (This information is available in the Job Import API > Lookup Values documentation.) String 50
Education/ContactEducation/Degree

Degree the contact has received or is in progress of earning at the listed school.

Note: The Education node allows multiple records, submitted with separate parent ContactEducation nodes.

String 150
Education/ContactEducation/GradYear The year the contact graduated (for example, 2012) from the listed school. Int  
Education/ContactEducation/HasGraduated True/False. Specifies if the contact graduated from the listed school with the corresponding listed degree. Boolean  
Education/ContactEducation/Major The major of the contact at the listed school. String 250
Education/ContactEducation/School The school the contact attended. String 250
EducationCurrent The current/last degree the contact achieved. Lookup 20
Email* The primary email address to use for the contact. Required Field. String 120
EventListId Event ID to add the contact to an Event. String  
Experience/ContactExperience/Company Company of the contact, for the experience record. Note: Experience records allow multiple entries, submitted with separate ContactExperience parent nodes. String 250
Experience/ContactExperience/EndMonth The month (integer value) when the contact left the listed company. Int  
Experience/ContactExperience/EndYear The 4-digit year when the contact left the listed company. Int  
Experience/ContactExperience/JobTitle The last job title the contact held at the listed company. String 150
Experience/ContactExperience/StartMonth The month (integer value) when the contact started working at the listed company. Int  
Experience/ContactExperience/StartYear The 4-digit year when the contact started working at the listed company. Int  
Experience/ContactExperience/State The state code of state where the listed company was located/ where the contact worked at the listed company. String 50
Experience/ContactExperience/Supervisor The name of the contact’s supervisor for the listed position at the listed company. String 200
Experience/ContactExperience/SupervisorTitle The job title of the contact’s listed supervisor for the listed position at the listed company. String 150
ExperienceCurrent The current experience level of the contact. Lookup 20
ExternalResumeId External Resume ID of the contact. Not visible in the SmashFly User Interface. Not recommended for inclusion in the API call. String?  
FacebookProfile URL to the contact’s Facebook page. String 150
FileToFolderPath

Specific Contact Folder/List to which the contact should be filed. Full folder hierarchy must be used, with levels separated by a forward slashes (/).

For example: Area of Interest/Information Technology

Note: The folder must already exist in SmashFly for the contact to be filed to it.

 String  
FirstName * Contact's first name. String 50
HomeEmail Home/alternate email address for the contact. String 128
IsApplicant True/False. Specifies whether the contact is already an applicant in the ATS system. Boolean  
_IsApplicantImpl^ Set to true if specifying IsApplicant field. Boolean  
IsEmployee True/False. Specifies whether the contact is an employee (internal contact). Boolean  
JobCode The integer value designating the SmashFly job category the contact best fits in. Int, Lookup  
JobId

The Job folder/list to which the contact should be filed. The Job ID from the ATS should be sent in this field.

Note: The Job must already exist in SmashFly for the contact to be filed to the specified job folder/list.

String  
JobListStatus The status in the ATS for the contact on the JobID that is being supplied. This status must be mapped to a valid status through integration, or default status will be applied. String  
JobListStatusNote The note applied in the ATS to the JobListStatus that is being sent for the given JobID. String  
JobTitle The current job title of the contact. String 150
LastName * The contact’s last name (surname). String 50
MobileNumber The current mobile phone number of the contact. String 30
Notes/ContactNote/Note

A note to associate with the contact record.

Note: The Notes node allows multiple entries, separated by parent ContactNode nodes.

 String

4000
Notes/ContactNote/Reminder A string that designates a date/time when the corresponding note should trigger a reminder. String 20
Phone The contact’s current home phone number. String 50
PostalCode The current postal code of the contact. String 50
ProfileURL The contact’s LinkedIn Profile URL. String 250
Resume The full text/HTML of the contact’s resume. Pass within a CDATA tag. String 32,000
ResumeBin/Name

The name of the binary resume file including the extension (example.pdf).

Note: This should be populated if ResumeBin\Content is populated or the file will lose it's extension.

 String 255
ResumeBin/Content The content of the binary resume file. Base64Binary  
SecondarySource

The “source” code from where the contact is being loaded.

Note: This source MUST exist in the client’s zone prior to usage. Contact your SmashFly Client System Administrator for the appropriate Source Codes if this will be in scope.

 String 75
State The code of the contact's state of residence or location (for example, CA for California).For valid values in North American, refer to the States, Provinces, and Regions in North America documentation. For valid values outside of North America, refer to the States, Provinces, and Regions Outside of North America documentation. (This information is available in the Job Import API > Lookup Values documentation.) String 50
Tags/ContactTag/Access

If utilizing Tags, always send “Public” for each corresponding tag to ensure visibility of the tag.

Note: The Tags node allows multiple entries, separated by parent ContactTag nodes.

String 10
Tags/ContactTag/Tag The specific tag to associate with a contact. Tags do not need to exist prior to using them. The API will create new tags on the fly if an existing Tag is not found. String 50
TwitterProfile The URL to the contact’s Twitter profile. String 100
UDF/ContactUDFData/FieldName

The internal Custom Field FieldID for which a value will be supplied. The SmashFly Customer System Administrator can provide the field labels and corresponding internal IDs for their custom contact fields. Also, refer to Custom Fields.

Note: UDF records allow multiple entries, submitted with separate ContactUDFData parent nodes.

String 20
UDF/ContactUDFData/Values/string The value to use for the corresponding custom field. This could either be a free-form text field, numeric value, formatted date value, or a code corresponding to an option in a select list. The SmashFly Customer System Administrator can provide field options and confirm what data can be submitted for that field. Refer to Custom Fields. String 50
UserScore Numeric rating of the contact, using numbers 1 through 5. In the SmashFly Console contact record, the value displays as a star-based rating. Numeric  
WebURL The URL to a website that you want to associate with the contact (for example, a deep link to an ATS profile or the contact’s personal web page) String 150
WorkPhone The contact’s work phone number. String 50
Password* The valid API Account Password. String 50
Username* The valid API Account Username. String 50