Events
Retrieve a Single Event by Id #
|
Sample Object
{
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345",
"name": "Sample Event",
"start_date": "2026-12-16",
"end_date": "2026-12-18",
"participation_type_id": 1,
"participation_type": "Committed",
"format_id": 1,
"format": "In-Person",
"star_rating": 0,
"tags": [],
"website_url": "",
"venue_name": "",
"venue_address": "",
"venue_location_display_name": "",
"venue_address_latitude": "",
"venue_address_longitude": "",
"booth_size": "",
"booth_number": "",
"booth_reservation_status_id": 1,
"booth_reservation_status": "Need to Reserve",
"booth_reserve_by_date": "",
"booth_date_reserved": "",
"budget_booth_reservation": 0.0,
"budget_booth_services": 0.0,
"budget_attendee_registrations": 0.0,
"budget_travel": 0.0,
"budget_giveaways": 0.0,
"budget_shipments": 0.0,
"budget_event_activities": 0.0,
"budget_misc_expenses": 0.0,
"budget_sponsorships": 0.0,
"total_sum_event_budgets": 0.0,
"cost_booth_reservation": 0.0,
"cost_booth_services": 0.0,
"cost_attendee_registrations": 0.0,
"cost_travel_reservations": 0.0,
"cost_giveaways": 0.0,
"cost_shipments": 0.0,
"cost_event_activities": 0.0,
"cost_misc_expenses": 0.0,
"cost_sponsorships": 0.0,
"total_sum_event_costs": 0.0,
"event_notes": "",
"booth_notes": "",
"budget_notes": "",
"roi_notes": "",
"roi_num_leads": 0,
"roi_num_impressions_booth": 0,
"roi_num_impressions_sponsorships": 0,
"roi_num_impressions_media": 0,
"roi_num_meetings_existing_customers": 0,
"roi_num_meetings_new_customers": 0,
"roi_amount_actual_sales": 0.0,
"roi_amount_potential_sales": 0.0,
"event_created_timestamp": "2026-11-16T17:00:00Z",
"event_last_update_timestamp": "2026-11-16T17:00:00Z",
"event_created_by": {
"id": "11111111-2222-4333-8444-555555555555",
"first_name": "Jane",
"last_name": "Smith",
"email": "jane@example.invalid"
},
"custom_fields": [
{
"label": "Integration status",
"value": "Ready",
"notes": "",
"field_name": "custom_67890",
"field_type": "Text (Single-line)",
"field_event_tab": "Info"
}
],
"task_sections": [],
"tasks": [],
"misc_expenses_credits": [],
"integration_metadata_field_1": "",
"integration_metadata_field_2": "",
"integration_metadata_field_3": "",
"integration_metadata_field_4": "",
"integration_metadata_field_5": ""
} |
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.
|
|
| $result_format | String | No |
Pass in "array" to get the event inside a JSON array (a list with one item).
|
|
| $on_error_return_empty_result | Boolean | No |
default: false
|
For a missing or invalid event id, or an event not found, return HTTP 200 with {} (or [] when $result_format=array). Authentication, rate-limit and unexpected server errors keep their normal HTTP status.
|
| $include_record_revision | Boolean | No |
default: false
|
Pass in true to add record_revision to the response: an opaque value that describes the current values of the fields this record's update can change (the help page lists what each revision covers). Send it back as expected_revision when you update this record, and the update is refused with HTTP 409 (error_code record_changed) if any of those fields changed in the meantime. In the rare case that the record keeps changing while it is being read, no record_revision can be given and the response is HTTP 409 (error_code record_changed); read it again. If you leave it out, the response has no record_revision.
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/events/info?id=12345" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/info?" + new URLSearchParams({ "id": "12345" }), {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/events/info",
headers={"api_key": "YOUR_API_KEY"},
params={"id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/events/info?id=12345");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/events/info?id=12345"))
.header("api_key", "YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/events/info?id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/events/info?id=12345')
request = Net::HTTP::Get.new(uri)
request['api_key'] = 'YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/events/info?id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example HTTP response body (JSON)
GET /v1/events/info - HTTP 200
{
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345",
"name": "Sample Event",
"start_date": "2026-12-16",
"end_date": "2026-12-18",
"participation_type_id": 1,
"participation_type": "Committed",
"format_id": 1,
"format": "In-Person",
"star_rating": 0,
"tags": [],
"website_url": "",
"venue_name": "",
"venue_address": "",
"venue_location_display_name": "",
"venue_address_latitude": "",
"venue_address_longitude": "",
"booth_size": "",
"booth_number": "",
"booth_reservation_status_id": 1,
"booth_reservation_status": "Need to Reserve",
"booth_reserve_by_date": "",
"booth_date_reserved": "",
"budget_booth_reservation": 0.00,
"budget_booth_services": 0.00,
"budget_attendee_registrations": 0.00,
"budget_travel": 0.00,
"budget_giveaways": 0.00,
"budget_shipments": 0.00,
"budget_event_activities": 0.00,
"budget_misc_expenses": 0.00,
"budget_sponsorships": 0.00,
"total_sum_event_budgets": 0.00,
"cost_booth_reservation": 0.00,
"cost_booth_services": 0.00,
"cost_attendee_registrations": 0.00,
"cost_travel_reservations": 0.00,
"cost_giveaways": 0.00,
"cost_shipments": 0.00,
"cost_event_activities": 0.00,
"cost_misc_expenses": 0.00,
"cost_sponsorships": 0.00,
"total_sum_event_costs": 0.00,
"event_notes": "",
"booth_notes": "",
"budget_notes": "",
"roi_notes": "",
"roi_num_leads": 0,
"roi_num_impressions_booth": 0,
"roi_num_impressions_sponsorships": 0,
"roi_num_impressions_media": 0,
"roi_num_meetings_existing_customers": 0,
"roi_num_meetings_new_customers": 0,
"roi_amount_actual_sales": 0.00,
"roi_amount_potential_sales": 0.00,
"event_created_timestamp": "2026-11-16T17:00:00Z",
"event_last_update_timestamp": "2026-11-16T17:00:00Z",
"event_created_by": {
"id": "11111111-2222-4333-8444-555555555555",
"first_name": "Jane",
"last_name": "Smith",
"email": "jane@example.invalid"
},
"custom_fields": [
{
"label": "Integration status",
"value": "Ready",
"notes": "",
"field_name": "custom_67890",
"field_type": "Text (Single-line)",
"field_event_tab": "Info"
}
],
"task_sections": [],
"tasks": [],
"misc_expenses_credits": [],
"integration_metadata_field_1": "",
"integration_metadata_field_2": "",
"integration_metadata_field_3": "",
"integration_metadata_field_4": "",
"integration_metadata_field_5": ""
}
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. Request inputs: {"id":12345}.
Retrieve Events #
|
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 “2026-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, 2026 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 the 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). A request with more than one custom-field filter is rejected with an error. If your workspace has no custom text field or custom dropdown field with the id in the parameter name, the request is rejected with an error.
|
| 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_event_misc_expenses_and_credits | Boolean | No |
default: false
|
Include the list of miscellaneous expenses & credits for each event in the result set. Note: hydrating the event miscellaneous expenses & credits 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 miscellaneous expenses and credits 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.
|
| event_id | Number | No |
Only include the event that has this id. The result is still a list: it holds that one event, or no events if your workspace has no event with that id. To retrieve a single event object, use /v1/events/info instead. A value that isn't an event id number is rejected with an error.
|
|
| filter_by_event_start_date_category | String | No |
Only include the events in one category: "all" (all events), "upcoming" (events that end today or later, including events that are in progress), "past" (events that ended before today), or a year such as "2026" (events that start in that year). "Today" is based on your workspace's time zone. When you pass in one of these values, the start date and end date filters are ignored. To get the list of categories for your workspace (with a category for every year that has events), use /v1/references/event_start_date_categories. Any other value is rejected with an error.
|
|
| filter_by_custom_field_value_setting_id | Number | No |
Another way to filter events by the value of a Custom Text field or a Custom Dropdown field: pass in the field's id as filter_by_custom_field_value_setting_id and the value to look for as filter_by_custom_field_value_setting_value. You can get the ids of the custom fields you can filter by from /v1/references/filterable_event_custom_fields. Only the events whose value for that field equals the value you pass in are included (the comparison is not case-sensitive and ignores leading and trailing spaces). An id that isn't a custom text field or custom dropdown field in your workspace is rejected with an error.
|
|
| filter_by_custom_field_value_setting_value | String | No |
max length: 3000
|
The value to look for in the custom field given in filter_by_custom_field_value_setting_id (see that parameter).
|
| $result_sort | String | No |
Sorts the events by when they were added or last updated. Accepted values: create_timestamp_asc, create_timestamp_desc, last_update_timestamp_asc, last_update_timestamp_desc. Without this parameter, events are sorted by start date (earliest first).
|
|
| $return_event_lites | Boolean | No |
default: false
|
Return a shorter version of each event (id, exhibitday_url, name, start and end dates, participation type, format, star rating, created and last update timestamps, and the integration metadata fields). Use it for faster responses when you only need to identify events. Note: the hydrate parameters don't apply to these shorter events.
|
| filter_by_last_update_timestamp_greater_than_or_equal_to | String | No |
Only include events that were added or changed on or after this date and time, for example 2026-10-14T18:30:00 (a date alone, such as 2026-10-14, means midnight). Responses give event_last_update_timestamp in UTC (it ends in Z), and that value can be passed back unchanged; a value without an offset is read as US Eastern time, and any other offset (e.g., 2026-10-14T18:30:00-04:00) is converted. To sync changes, process and save every page before advancing the cursor. Save the latest event_last_update_timestamp you receive and pass it in next time (events changed at exactly that time come back again, upsert every returned record by id, including boundary records). Deleted events are not returned. Any other value is rejected with an error.
|
|
| $limit | Number | No |
The most events to return (a whole number of 1 or more). Use it with $offset to read a long list in pages: total_records in the response counts every matching event and has_more is true while more pages follow (the X-Total-Count header carries the total too). Without $limit, every matching event is returned.
|
|
| $offset | Number | No |
How many events to skip before the first one returned (a whole number; 0 by default). For the next page, add the number of events you received to $offset.
|
|
| $result_format | String | No |
Pass in "array" to get the results as a plain JSON array (without records_found, total_records, has_more and list_type; the X-Total-Count header still gives the total), or "wrapped_in_array" to get the usual response inside a JSON array.
|
|
| $on_error_return_empty_result | Boolean | No |
default: false
|
For this endpoint's ID, filter or paging validation errors, return HTTP 200 with no matching records in the selected result format. Authentication, rate-limit and unexpected server errors keep their normal HTTP status.
|
Code Samples
curl -X GET "https://api.exhibitday.com/v1/events" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events", {
method: "GET",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/events",
headers={"api_key": "YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/events");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/events"))
.header("api_key", "YOUR_API_KEY")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/events');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/events')
request = Net::HTTP::Get.new(uri)
request['api_key'] = 'YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/events", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example HTTP response body (JSON)
GET /v1/events - HTTP 200
{
"records_found": 1,
"total_records": 1,
"has_more": false,
"list_type": "event",
"list_data": [
{
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345",
"name": "Sample Event",
"start_date": "2026-12-16",
"end_date": "2026-12-18",
"participation_type_id": 1,
"participation_type": "Committed",
"format_id": 1,
"format": "In-Person",
"star_rating": 0,
"tags": [],
"website_url": "",
"venue_name": "",
"venue_address": "",
"venue_location_display_name": "",
"venue_address_latitude": "",
"venue_address_longitude": "",
"booth_size": "",
"booth_number": "",
"booth_reservation_status_id": 1,
"booth_reservation_status": "Need to Reserve",
"booth_reserve_by_date": "",
"booth_date_reserved": "",
"budget_booth_reservation": 0.00,
"budget_booth_services": 0.00,
"budget_attendee_registrations": 0.00,
"budget_travel": 0.00,
"budget_giveaways": 0.00,
"budget_shipments": 0.00,
"budget_event_activities": 0.00,
"budget_misc_expenses": 0.00,
"budget_sponsorships": 0.00,
"total_sum_event_budgets": 0.00,
"cost_booth_reservation": 0.00,
"cost_booth_services": 0.00,
"cost_attendee_registrations": 0.00,
"cost_travel_reservations": 0.00,
"cost_giveaways": 0.00,
"cost_shipments": 0.00,
"cost_event_activities": 0.00,
"cost_misc_expenses": 0.00,
"cost_sponsorships": 0.00,
"total_sum_event_costs": 0.00,
"event_notes": "",
"booth_notes": "",
"budget_notes": "",
"roi_notes": "",
"roi_num_leads": 0,
"roi_num_impressions_booth": 0,
"roi_num_impressions_sponsorships": 0,
"roi_num_impressions_media": 0,
"roi_num_meetings_existing_customers": 0,
"roi_num_meetings_new_customers": 0,
"roi_amount_actual_sales": 0.00,
"roi_amount_potential_sales": 0.00,
"event_created_timestamp": "2026-11-16T17:00:00Z",
"event_last_update_timestamp": "2026-11-16T17:00:00Z",
"event_created_by": {
"id": "11111111-2222-4333-8444-555555555555",
"first_name": "Jane",
"last_name": "Smith",
"email": "jane@example.invalid"
},
"custom_fields": null,
"task_sections": null,
"tasks": null,
"misc_expenses_credits": null,
"integration_metadata_field_1": "",
"integration_metadata_field_2": "",
"integration_metadata_field_3": "",
"integration_metadata_field_4": "",
"integration_metadata_field_5": ""
}
]
}
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. No query/body parameters are sent (the API key remains a header).
Add an Event #
|
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; supported dates: 1753-01-01 through 9999-12-31). If the start date is after the end date, the API swaps the dates before creating the event.
|
|
| end_date | Date | Yes |
Event End Date (format: YYYY-MM-DD; supported dates: 1753-01-01 through 9999-12-31). If the start date is after the end date, the API swaps the dates before creating the event.
|
|
| 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 participation type of 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
|
| star_rating | Number | No |
default: 0
|
Star Rating for the event (0, 1, 2, or 3). If you leave it out (or pass in an empty value or null), the event is added with a star rating of 0. Any other value is rejected with an error, and the event is not added.
|
| 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.
|
Code Samples
curl -X POST https://api.exhibitday.com/v1/events -H "api_key: YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"name\":\"Sample Event\",\"start_date\":\"2026-12-16\",\"end_date\":\"2026-12-18\"}"
const response = await fetch("https://api.exhibitday.com/v1/events", {
method: "POST",
headers: { "api_key": "YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "name": "Sample Event", "start_date": "2026-12-16", "end_date": "2026-12-18" })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.post(
"https://api.exhibitday.com/v1/events",
headers={"api_key": "YOUR_API_KEY"},
json={"name": "Sample Event", "start_date": "2026-12-16", "end_date": "2026-12-18"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.PostAsync("https://api.exhibitday.com/v1/events",
JsonContent.Create(new { name = "Sample Event", start_date = "2026-12-16", end_date = "2026-12-18" }));
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/events"))
.header("api_key", "YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"name\":\"Sample Event\",\"start_date\":\"2026-12-16\",\"end_date\":\"2026-12-18\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/events');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"name":"Sample Event","start_date":"2026-12-16","end_date":"2026-12-18"}',
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/events')
request = Net::HTTP::Post.new(uri)
request['api_key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"name":"Sample Event","start_date":"2026-12-16","end_date":"2026-12-18"}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("POST", "https://api.exhibitday.com/v1/events", strings.NewReader("{\"name\":\"Sample Event\",\"start_date\":\"2026-12-16\",\"end_date\":\"2026-12-18\"}"))
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "YOUR_API_KEY")
request.Header.Set("Content-Type", "application/json")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example HTTP response body (JSON)
POST /v1/events - HTTP 200
{
"id": 23456,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456",
"name": "Sample Event",
"start_date": "2026-12-16",
"end_date": "2026-12-18",
"participation_type_id": 1,
"participation_type": "Committed",
"format_id": 1,
"format": "In-Person",
"star_rating": 0,
"tags": [],
"website_url": "",
"venue_name": "",
"venue_address": "",
"venue_location_display_name": "",
"venue_address_latitude": "",
"venue_address_longitude": "",
"booth_size": "",
"booth_number": "",
"booth_reservation_status_id": 1,
"booth_reservation_status": "Need to Reserve",
"booth_reserve_by_date": "",
"booth_date_reserved": "",
"budget_booth_reservation": 0.00,
"budget_booth_services": 0.00,
"budget_attendee_registrations": 0.00,
"budget_travel": 0.00,
"budget_giveaways": 0.00,
"budget_shipments": 0.00,
"budget_event_activities": 0.00,
"budget_misc_expenses": 0.00,
"budget_sponsorships": 0.00,
"total_sum_event_budgets": 0.00,
"cost_booth_reservation": 0.00,
"cost_booth_services": 0.00,
"cost_attendee_registrations": 0.00,
"cost_travel_reservations": 0.00,
"cost_giveaways": 0.00,
"cost_shipments": 0.00,
"cost_event_activities": 0.00,
"cost_misc_expenses": 0.00,
"cost_sponsorships": 0.00,
"total_sum_event_costs": 0.00,
"event_notes": "",
"booth_notes": "",
"budget_notes": "",
"roi_notes": "",
"roi_num_leads": 0,
"roi_num_impressions_booth": 0,
"roi_num_impressions_sponsorships": 0,
"roi_num_impressions_media": 0,
"roi_num_meetings_existing_customers": 0,
"roi_num_meetings_new_customers": 0,
"roi_amount_actual_sales": 0.00,
"roi_amount_potential_sales": 0.00,
"event_created_timestamp": "2026-11-16T17:00:00Z",
"event_last_update_timestamp": "2026-11-16T17:00:00Z",
"event_created_by": {
"id": "ExhibitDay API",
"first_name": "ExhibitDay",
"last_name": "API",
"email": ""
},
"custom_fields": [
{
"label": "Integration status",
"value": "Ready",
"notes": "",
"field_name": "custom_67890",
"field_type": "Text (Single-line)",
"field_event_tab": "Info"
}
],
"task_sections": [],
"tasks": [],
"misc_expenses_credits": [],
"integration_metadata_field_1": "",
"integration_metadata_field_2": "",
"integration_metadata_field_3": "",
"integration_metadata_field_4": "",
"integration_metadata_field_5": ""
}
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. Request inputs: {"name":"Sample Event","start_date":"2026-12-16","end_date":"2026-12-18"}.
Delete an Event #
|
Permanently deletes an event. It cannot be undone. Inventory outcomes are chosen automatically using the workspace's current date and the event-deletion defaults. Future reservations, whose start date is tomorrow or later, are undone without replacement inventory movements. Started capital reservations are kept for their original dates and disassociated from the event. Started collateral reservations with a return date keep the original checkout and full return as ordinary inventory adjustments; this includes return dates before, on or after today. Started collateral reservations with a TBD return date keep the original checkout deduction without a return. Replacement inventory adjustments have no event association or automatic return schedule. A future-dated return does not increase today's inventory. Attachments on retained capital reservations and replacement collateral inventory adjustments are kept independently of the deleted event, with their owning workspace unchanged. When a collateral checkout and return become two inventory adjustments, both receive complete independent attachment sets: the checkout keeps the original file identities, and the return receives new file identities and physical copies. If a required attachment copy cannot be created, deletion is refused with HTTP 409 and error_code attachment_preservation_failed before event or inventory changes. Check the reservation attachments in ExhibitDay before retrying. Attachments on reservations that are undone are removed from application records and queued for physical deletion, along with ordinary event attachments. Physical cleanup may finish after this API response. To choose another permitted inventory outcome, use the event-deletion review in ExhibitDay instead. This API method does not accept inventory-choice parameters.
Parameters
| Name | Type | Required? | Details | Description |
| api_key | String | Yes |
|
|
| id | Number | Yes |
The id of the event you would like to delete.
|
Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/events?id=12345" -H "api_key: YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events?" + new URLSearchParams({ "id": "12345" }), {
method: "DELETE",
headers: { "api_key": "YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.delete(
"https://api.exhibitday.com/v1/events",
headers={"api_key": "YOUR_API_KEY"},
params={"id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.DeleteAsync("https://api.exhibitday.com/v1/events?id=12345");
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/events?id=12345"))
.header("api_key", "YOUR_API_KEY")
.method("DELETE", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/events?id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/events?id=12345')
request = Net::HTTP::Delete.new(uri)
request['api_key'] = 'YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
)
func main() {
request, err := http.NewRequest("DELETE", "https://api.exhibitday.com/v1/events?id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example HTTP response body (JSON)
DELETE /v1/events - HTTP 200
{
"status_code": 200,
"status": "OK",
"message": "Event Deleted",
"errors": []
}
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. Request inputs: {"id":12345}.
Update an Event #
|
To update an event, only pass in the properties that you want to update. To clear a property that supports clearing, pass in null; an empty value leaves the property unchanged (the warnings property in the response names any such parameters). 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; supported dates: 1753-01-01 through 9999-12-31). If the start date is after the end date, the API swaps the dates before saving. Dates omitted from the request use the event's existing values for this comparison.
|
|
| end_date | Date | No |
Event End Date (format: YYYY-MM-DD; supported dates: 1753-01-01 through 9999-12-31). If the start date is after the end date, the API swaps the dates before saving. Dates omitted from the request use the event's existing values for this comparison.
|
|
| 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).
|
|
| event_tags | String | No |
A comma-separated list of tags for the event (e.g., "International, West Coast, 2026"). This REPLACES the entire set of tags on the event with the list you pass in, and the order you pass them in is the order they are displayed. Each individual tag has a maximum length of 30 characters and is truncated if longer. Duplicates (case-insensitive), blank entries between tags and any HTML markup are ignored; a value that contains no tags at all (e.g., ",") is rejected. Because commas separate the list, an individual tag cannot itself contain a comma. To remove all tags from the event, pass in null.
|
|
| website_url | String | No |
max length: 2000
|
URL of the event website. Must be a well-formed http or https URL; if you leave out the scheme, http:// is added (e.g., example.com is stored as http://example.com). The stored URL can be up to 2000 characters: a longer URL that starts with http:// or https:// is truncated to 2000 characters, and a URL without the scheme that would be longer than 2000 characters once http:// is added is rejected with an error.
|
| venue_name | String | No |
max length: 300
|
The name of the venue for the event.
|
| venue_address | String | No |
max length: 1000
|
The venue address for the event.
|
| booth_size | String | No |
max length: 150
|
The size of your booth for the event (e.g., 10x20). A value longer than 150 characters is rejected.
|
| booth_number | String | No |
max length: 150
|
Your booth number for the event. A value longer than 150 characters is rejected.
|
| event_notes | String | No |
max length: 30000
|
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, and the text is stored HTML-encoded, so it is returned as HTML (a < b comes back as a < b). Accepts up to 30,000 characters, including formatting, the same limit as the notes editor in ExhibitDay. Some characters take more space when stored: each line break counts as the 5 characters of <br/>, the characters & < > " ' count as their HTML codes (for example, & is stored as &), and accented letters, symbols and non-breaking spaces such as é, ü, © and ° count as 6 characters each (é is stored as é). The notes must also fit the notes editor in ExhibitDay, which counts up to 30,000 characters of its own HTML: it adds 5 characters of formatting and counts letters and symbols such as é ’ “ — € as their HTML codes (for example, ’ counts as the 7 characters of ’). Longer notes are rejected with an error, and nothing is changed. Notes that are already stored longer than this can be kept as they are or shortened, but not made longer.
|
| booth_notes | String | No |
max length: 30000
|
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, and the text is stored HTML-encoded, so it is returned as HTML (a < b comes back as a < b). Accepts up to 30,000 characters, including formatting, the same limit as the notes editor in ExhibitDay. Some characters take more space when stored: each line break counts as the 5 characters of <br/>, the characters & < > " ' count as their HTML codes (for example, & is stored as &), and accented letters, symbols and non-breaking spaces such as é, ü, © and ° count as 6 characters each (é is stored as é). The notes must also fit the notes editor in ExhibitDay, which counts up to 30,000 characters of its own HTML: it adds 5 characters of formatting and counts letters and symbols such as é ’ “ — € as their HTML codes (for example, ’ counts as the 7 characters of ’). Longer notes are rejected with an error, and nothing is changed. Notes that are already stored longer than this can be kept as they are or shortened, but not made longer.
|
| budget_notes | String | No |
max length: 30000
|
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, and the text is stored HTML-encoded, so it is returned as HTML (a < b comes back as a < b). Accepts up to 30,000 characters, including formatting, the same limit as the notes editor in ExhibitDay. Some characters take more space when stored: each line break counts as the 5 characters of <br/>, the characters & < > " ' count as their HTML codes (for example, & is stored as &), and accented letters, symbols and non-breaking spaces such as é, ü, © and ° count as 6 characters each (é is stored as é). The notes must also fit the notes editor in ExhibitDay, which counts up to 30,000 characters of its own HTML: it adds 5 characters of formatting and counts letters and symbols such as é ’ “ — € as their HTML codes (for example, ’ counts as the 7 characters of ’). Longer notes are rejected with an error, and nothing is changed. Notes that are already stored longer than this can be kept as they are or shortened, but not made longer.
|
| roi_notes | String | No |
max length: 30000
|
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, and the text is stored HTML-encoded, so it is returned as HTML (a < b comes back as a < b). Accepts up to 30,000 characters, including formatting, the same limit as the notes editor in ExhibitDay. Some characters take more space when stored: each line break counts as the 5 characters of <br/>, the characters & < > " ' count as their HTML codes (for example, & is stored as &), and accented letters, symbols and non-breaking spaces such as é, ü, © and ° count as 6 characters each (é is stored as é). The notes must also fit the notes editor in ExhibitDay, which counts up to 30,000 characters of its own HTML: it adds 5 characters of formatting and counts letters and symbols such as é ’ “ — € as their HTML codes (for example, ’ counts as the 7 characters of ’). Longer notes are rejected with an error, and nothing is changed. Notes that are already stored longer than this can be kept as they are or shortened, but not made longer.
|
| budget_booth_reservation | Number | No |
A number (greater than or equal to 0.00) that represents the budget for reserving the booth for the event.
|
|
| budget_booth_services | Number | No |
A number (greater than 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 than or equal to 0.00) that represents the budget for event registration / attendee tickets.
|
|
| budget_travel | Number | No |
A number (greater than or equal to 0.00) that represents the budget for travel and lodging for the event.
|
|
| budget_giveaways | Number | No |
A number (greater than 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 than or equal to 0.00) that represents the budget for all shipments for the event.
|
|
| budget_event_activities | Number | No |
A number (greater than or equal to 0.00) that represents the budget for costs recorded under Playbook activities for the event.
|
|
| budget_misc_expenses | Number | No |
A number (greater than or equal to 0.00) that represents the budget for all miscellaneous expenses for the event.
|
|
| budget_sponsorships | Number | No |
A number (greater than or equal to 0.00) that represents the budget for all sponsorships for the event.
|
|
| roi_num_leads | Number | No |
An integer (greater than or equal to 0) that represents the number of leads generated from this event.
|
|
| roi_num_impressions_booth | Number | No |
An integer (greater than 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 than 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 than 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 than 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 than 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 from 0.00 to 999999999999999.99 that represents the actual sales amount (attributable to this event and already closed).
|
|
| roi_amount_potential_sales | Number | No |
A number from 0.00 to 999999999999999.99 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.
|
| expected_revision | String | No |
The record_revision value from a GET of this record with $include_record_revision=true. When you send it, the update is saved only if none of the fields the revision covers has changed since that read (every field this update can change; the help page lists what each revision covers). A change that was undone in the meantime does not count. Otherwise nothing is changed and the response is HTTP 409 with error_code record_changed. Then read the record again, review its current values and decide whether to send your change again (the API never retries it for you). Treat the value as opaque: do not build or parse it. If you leave it out, the update is saved without this check. A blank, null or malformed value is refused with HTTP 400 (error_code invalid_request), and so are different values sent for it more than once. A successful update returns the record's new record_revision. It grants no permission (every request is still checked as usual) and is separate from Idempotency-Key and ETag/If-None-Match.
|
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. The same rules apply as for every other field: an empty value leaves the custom field unchanged (and adds a warning), and null (or the text "null") clears it. The response's list of changed properties names custom fields by their label.
Note: Only event custom text fields, custom dropdown fields and custom URL fields are allowed to be updated via the API.
A multi-line custom text field takes plain text, like the notes parameters: any html tags in the value are stripped, new line characters get replaced with a <br/> tag, and the text is stored HTML-encoded, so it is returned as HTML (a < b comes back as a < b). It accepts up to 30,000 characters, including formatting, counted the same way as the notes parameters (both as stored and as the notes editor in ExhibitDay counts them).
A single-line custom text field accepts up to 2,999 characters, the same limit as in ExhibitDay (any html tags are stripped and not counted, and new line characters become spaces). A longer custom text value is rejected with an error, and nothing is changed; a value that is already stored longer than its limit can be kept as it is or shortened, but not made longer.
Use the /v1/references/event_custom_fields endpoint to get the field_name for the custom fields that are configured in your workspace.
Code Samples
curl -X PATCH https://api.exhibitday.com/v1/events -H "api_key: YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"name\":\"Updated event name\"}"
const response = await fetch("https://api.exhibitday.com/v1/events", {
method: "PATCH",
headers: { "api_key": "YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "id": 12345, "name": "Updated event name" })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.patch(
"https://api.exhibitday.com/v1/events",
headers={"api_key": "YOUR_API_KEY"},
json={"id": 12345, "name": "Updated event name"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("api_key", "YOUR_API_KEY");
var response = await client.PatchAsync("https://api.exhibitday.com/v1/events",
JsonContent.Create(new { id = 12345, name = "Updated event name" }));
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/events"))
.header("api_key", "YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\"id\":12345,\"name\":\"Updated event name\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/events');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['api_key: YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"id":12345,"name":"Updated event name"}',
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/events')
request = Net::HTTP::Patch.new(uri)
request['api_key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"id":12345,"name":"Updated event name"}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("PATCH", "https://api.exhibitday.com/v1/events", strings.NewReader("{\"id\":12345,\"name\":\"Updated event name\"}"))
if err != nil { log.Fatal(err) }
request.Header.Set("api_key", "YOUR_API_KEY")
request.Header.Set("Content-Type", "application/json")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example HTTP response body (JSON)
PATCH /v1/events - HTTP 200
{
"status_code": 200,
"status": "OK",
"message": "Event Update Successful. Event properties that were changed: name",
"errors": []
}
Note: Illustrative response. Assume the identified records exist in an illustrative workspace and the request succeeds. Generated IDs, related records and timestamps are illustrative. Item links use illustrative workspace 98765 and the DTO's configured application host (an illustrative production-host fallback is used only if absent). Timestamps are illustrative values formatted by the current API serializer; they do not establish the timezone semantics of stored timestamps. The default response representation is shown; documented options can select another shape. Reference labels are illustrative; assume the workspace uses the standard participation types with no custom choices. Request inputs: {"id":12345,"name":"Updated event name"}.