Event Data Model
The table below describes the different standard field types available and their representation when retrieving their values as well as the expected representations when modifying them.
Notes:
-
Child fields are listed below their Parent field, indicated by an em dash (e.g., "— addresscity").
-
Click the red plus sign to the right of each row to view a field's options, if applicable.
-
For any field types, a null or empty string can be provided as the value to delete its value from the Profile.
-
For information on fields required for successful imports, please see the "Missing Required Columns" section of the What Might Cause My Import to Fail? under Imports on the File-Based Transfers page.
-
Click here to download an Excel file containing the information below.
Manipulating the Event Profile Using the API
Event Profiles can be created and updated using the Profiles API. The endpoint for the Event Profile is as follows:
https://api.icims.com/customers/{customerId}/connectevents/{eventId}
WebService Field ID | Label | FlatFile Header | Type | Max | + |
---|---|---|---|---|---|
additionaldetails | Additional Details | rcf3430 | HTMLEDITOR | N/A | + |
Options: N/A |
|||||
category | Category | rcf3429 | LISTEDITOR_SINGLE | N/A | + |
Options: ID,Value D37002042001,"Career Fair" D37002042002,"Social Media Campaign" D37002042003,"Conference" |
|||||
cost | Cost | rcf3434 | CURRENCY | N/A | + |
Options: N/A |
|||||
enddate | End Date | rcf3425 | DATETIME | N/A | + |
Options: N/A |
|||||
externalid | External ID | ExternalID | TEXTFIELD | 64 | + |
Options: N/A |
|||||
externalmessages | External Message | rcf3431 | HTMLEDITOR | N/A | + |
Options: N/A |
|||||
folder | Folder | rcf3428 | LISTEDITOR_SINGLE | N/A | + |
Options: ID,Value D37002045001,"Open" D37002045002,"Closed" D37002045003,"Archived" |
|||||
host | Event Host | rcf3426 | LISTEDITOR_SINGLE | N/A | + |
Options: ID,Value |
|||||
startdate | Start Date | rcf3424 | DATETIME | N/A | + |
Options: N/A |
|||||
title | Name | rcf3423 | PROFILETITLE | 192 | + |
Options: N/A |