Events

Retrieve a Single Event by id

Method
GET
Endpoint
Retrieves information about a specific event (using the "id" parameter).
Parameters
Name Type Required? Details Description
api_key String Yes
id Number Yes
Id of the specific event that you would like to retrieve.

Retrieve Events

Method
GET
Endpoint
This method retrieves events in your workspace based on various filter criteria. The filter parameters for this method work in conjunction on an “AND-basis”. For example, If you pass in the value “2024-01-30” for filter_by_start_date_greater_than_or_equal_to and the value “1” for filter_by_event_format_id, you’ll get back all the events in your workspace that have their start date greater than or equal to Jan 30, 2024 AND have their format set to In-Person. Also, you can only pass in one value for each filter parameter; this means that you can’t pass in “1, 2” as the value for filter_by_event_star_rating filter parameter expecting to get back all the events that have a 1-star or a 2-star rating.
Parameters
Name Type Required? Details Description
api_key String Yes
filter_by_event_name_contains_text String No
Only include events that have the given text in the event Name. For example: If you want to retrieve all the events that have the word “International” in the event Name field, pass in the value “International” for the filter_by_event_name_contains_text parameter. Note: this text search is not case-sensitive.
filter_by_start_date_greater_than_or_equal_to Date No
Only include events that have their start date greater than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD
filter_by_start_date_smaller_than_or_equal_to Date No
Only include events that have their start date smaller than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD
filter_by_end_date_greater_than_or_equal_to Date No
Only include events that have their end date greater than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD
filter_by_end_date_smaller_than_or_equal_to Date No
Only include events that have their end date smaller than or equal to the value passed in for this filter parameter. Use this date format: YYYY-MM-DD
filter_by_event_participation_type_id Number No
Only include events that have their participation_type_id equal to the value passed in for this filter parameter. To get a list of available event Participation Type Ids in your workspace, refer to this endpoint: /v1/references/event_participation_types
filter_by_event_format_id Number No
Only include events that have their format_id equal to the value passed in for this filter parameter. The following integer values are accepted (1 for In-Person, 2 for Virtual, 3 for Hybrid)
filter_by_event_star_rating Number No
Only include events that have their star rating equal to the value passed in for this filter parameter. The following integer values are accepted: 0, 1, 2, 3
filter_by_event_tag String No
max length: 150
Only include events that have this tag. For example, you can use this filter to get all the events that have the tag “International”. Note: You can only pass in one tag to filter based on.
filter_by_custom_event_field__custom_NNNNNN String No
max length: 3000
This is a special filter that lets you filter down your events based on a value of a Custom Text field or a Custom Dropdown field under the Event Information tab, Event Booth tab, or the Special Event tab. To use this filter, you’ll need the field name for the custom text field or custom dropdown field. You can obtain a list of field names for custom event fields in your workspace from the following endpoint: /v1/references/event_custom_fields. For example, if you have configured a custom dropdown field called “Region” under the Event information tab, and its field name is “custom_123456” and you would like to filter your events to include only ones that have “Northeast” selected for that custom dropdown field, pass in “filter_by_custom_event_field__custom_123456” as the parameter name and “Northeast” as its parameter value. Note: You can only filter down based on one custom event field (and it has to be either a custom text field or a custom dropdown field).
filter_by_integration_metadata_field_1 String No
max length: 3000
Only include events that have their integration_metadata_field_1 property equal to the value you pass in for this parameter. Note: An event's integration_metadata_field_1 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular event (e.g., the "external id" of the event from another system you're integrating with).
filter_by_integration_metadata_field_2 String No
max length: 3000
Only include events that have their integration_metadata_field_2 property equal to the value you pass in for this parameter. Note: An event's integration_metadata_field_2 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular event (e.g., the "external id" of the event from another system you're integrating with).
filter_by_integration_metadata_field_3 String No
max length: 3000
Only include events that have their integration_metadata_field_3 property equal to the value you pass in for this parameter. Note: An event's integration_metadata_field_3 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular event (e.g., the "external id" of the event from another system you're integrating with).
filter_by_integration_metadata_field_4 String No
max length: 3000
Only include events that have their integration_metadata_field_4 property equal to the value you pass in for this parameter. Note: An event's integration_metadata_field_4 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular event (e.g., the "external id" of the event from another system you're integrating with).
filter_by_integration_metadata_field_5 String No
max length: 3000
Only include events that have their integration_metadata_field_5 property equal to the value you pass in for this parameter. Note: An event's integration_metadata_field_5 property is an integration-specific text field only accessible via the ExhibitDay API. This field is typically used to store metadata or information about a particular event (e.g., the "external id" of the event from another system you're integrating with).
hydrate_tasks Boolean No
default: false
Include the tasks collection for each event in the result set. Note: hydrating the task collection for each event in the results will naturally yield a larger response size and response time. Set the value for this parameter to true only if you need to include the list of tasks for each event in the result set.
hydrate_task_sections_list Boolean No
default: false
Include the list of available task sections for each event in the result set. Note: hydrating the event task section collection for each event in the results will naturally yield a larger response size and response time. Set the value for this parameter to true only if you need to include the list of task sections for each event in the result set.
hydrate_custom_fields Boolean No
default: false
Include the event custom fields (i.e. custom fields that have been added to your workspace) for each event in the result set. Note: hydrating the event custom field collection for each event in the results will naturally yield a larger response size and response time. Set the value for this parameter to true only if you need to include the custom field values for each event in the result set.

Add an Event

Method
POST
Endpoint
If successful, the response will contain an object representing the newly added event.
Parameters
Name Type Required? Details Description
api_key String Yes
name String Yes
max length: 500
The name of the event.
start_date Date Yes
Event Start Date (format: YYYY-MM-DD). Must be smaller or equal to Event End Date.
end_date Date Yes
Event End Date (format: YYYY-MM-DD). Must be greater or equal to Event Start Date.
format_id Number No
default: 1
Integer representing the format_id for the event (1 for In-Person, 2 for Virtual, 3 for Hybrid)
participation_type_id Number No
default: 1
Integer representing the event_participation_type_id for the event (1: Committed, 2: Considering, 3: Not Going). Note: you can use the following endpoint to retrieve a list of available participation_type_id's: /v1/references/event_participation_types
integration_metadata_field_1 String No
max length: 3000
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.
integration_metadata_field_2 String No
max length: 3000
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.
integration_metadata_field_3 String No
max length: 3000
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.
integration_metadata_field_4 String No
max length: 3000
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.
integration_metadata_field_5 String No
max length: 3000
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.

Delete an Event

Method
DELETE
Endpoint
Permanently deletes an event. It cannot be undone.
Parameters
Name Type Required? Details Description
api_key String Yes
id Number Yes
The id of the event you would like to delete.

Update an Event

Method
PATCH
Endpoint
If the update is successful, the message property in the response will contain a list of event properties that were actually changed as a result of this API update call.
Parameters
Name Type Required? Details Description
api_key String Yes
id Number Yes
The id of the event you would like to update.
name String No
max length: 500
The name of the event.
start_date Date No
Event Start Date (format: YYYY-MM-DD). Must be smaller or equal to Event End Date.
end_date Date No
Event End Date (format: YYYY-MM-DD). Must be greater or equal to Event Start Date.
participation_type_id Number No
Integer representing the participation_type_id for the event (1: Committed, 2: Considering, 3: Not Going). Note: you can use the following endpoint to retrieve a list of available participation_type_id's: /v1/references/event_participation_types
format_id Number No
Integer representing the FormatId for the event (1 for In-Person, 2 for Virtual, 3 for Hybrid)
star_rating Number No
Star Rating for the event (0, 1, 2, or 3).
website_url String No
max length: 2000
URL of the event website. Must be a well-formed URL.
venue_name String No
max length: 300
The name of the venue for the event.
booth_size Number No
max length: 150
The size of your booth for the event.
booth_number Number No
max length: 150
Your booth number for the event.
event_notes Number No
Event Notes (under the Event Information tab). Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.
booth_notes Number No
Booth Notes (under the event Booth tab). Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.
budget_notes Number No
Budget Notes (under the event Budget tab). Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.
roi_notes Number No
ROI Notes (under the event ROI tab). Only accepts plain text. Any html tags in the value you pass in will be stripped. New line characters will get replaced with a <br/> tag.
budget_booth_reservation Number No
A number (greater or equal to 0.00) that represents the budget for reserving the booth for the event.
budget_booth_services Number No
A number (greater or equal to 0.00) that represents the budget for all the booth services for the event.
budget_attendee_registrations Number No
A number (greater or equal to 0.00) that represents the budget for event registration / attendee tickets.
budget_travel Number No
A number (greater or equal to 0.00) that represents the budget for travel and lodging for the event.
budget_giveaways Number No
A number (greater or equal to 0.00) that represents the budget for your giveaways (swag and raffle items) for the event.
budget_shipments Number No
A number (greater or equal to 0.00) that represents the budget for all shipments for the event.
budget_misc_expenses Number No
A number (greater or equal to 0.00) that represents the budget for all miscellaneous expenses for the event.
budget_sponsorships Number No
A number (greater or equal to 0.00) that represents the budget for all sponsorships for the event.
roi_num_leads Number No
An integer (greater or equal to 0) that represents the number of leads generated from this event.
roi_num_impressions_booth Number No
An integer (greater or equal to 0) that represents the number of booth walk-bys / impressions (i.e., estimated total number of people who saw your booth at this event).
roi_num_impressions_sponsorships Number No
An integer (greater or equal to 0) that represents the number of sponsorship impressions (i.e., estimated total number of people reached through all your sponsorships for this event).
roi_num_impressions_media Number No
An integer (greater or equal to 0) that represents the number of social/traditional media impressions (i.e., estimated total number of people reached via social media or traditional media coverage).
roi_num_meetings_existing_customers Number No
An integer (greater or equal to 0) that represents the number of meetings with existing customers (i.e., total number of meetings your team had with your existing customers at this event).
roi_num_meetings_new_customers Number No
An integer (greater or equal to 0) that represents the number of meetings with new/potential customers (i.e., total number of meetings your team had with new/potential customers at this event).
roi_amount_actual_sales Number No
A number (greater or equal to 0.00) that represents the actual sales amount (attributable to this event and already closed).
roi_amount_potential_sales Number No
A number (greater or equal to 0.00) that represents the additional opportunity / potential sales amount (attributable to this event, but, yet to be closed).
integration_metadata_field_1 String No
max length: 3000
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.
integration_metadata_field_2 String No
max length: 3000
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.
integration_metadata_field_3 String No
max length: 3000
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.
integration_metadata_field_4 String No
max length: 3000
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.
integration_metadata_field_5 String No
max length: 3000
This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.
Updating Event Custom Fields
In order to update the value of an event's custom field (i.e., a specific custom field that you've added to events in your workspace), you can pass in that custom field's field_name as a parameter to this method. For example, if there is a Custom Text Field configured for the Booth tab in your workspace, and that Custom Text Field's field_name is "custom_12345", you can update the value for that Custom Field by passing "custom_12345" as a parameter to this function.
Note: Only event custom text fields, custom dropdown fields and custom URL fields are allowed to be updated via the API.
Use the /v1/references/event_custom_fields endpoint to get the field_name for the custom fields that are configured in your workspace.