Booth Services
Retrieve a Single Booth Service by ID #
|
Sample Object
|
Retrieves a single Booth Service by its ID.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the Booth Service.
|
Use the id from Retrieve Booth Services (GET /v1/events/booth_services) or from the add response. You don't send the Event ID; the record's Event is found automatically.
|
| $result_format | String | No |
By default, the response is a single object. Send
array to get it inside a one-item array.
|
Allowed values:
array | object |
| $include_record_revision | Boolean | No |
Whether to include record_revision in the response.
|
Default: false. Send true to get record_revision, then send that value as expected_revision when you update this service. See What $include_record_revision covers below.
|
| $on_error_return_empty_result | Boolean | No |
Whether an invalid or unavailable Booth Service should return an empty result.
|
Default: false. True returns HTTP 200 with {} (or [] for array format) for invalid IDs or an unavailable service. API key errors, ambiguous headers, conflicts with a change in progress and unexpected errors keep their normal status.
|
| If-None-Match | String | No |
An ETag from an earlier response to this GET.
|
Optional HTTP header. If the successful response is unchanged, the API returns HTTP 304 with no body.
|
Good to know
Retrieves a Booth Service by its ID, including its reservation status, applicable service details, vendor, costs and payment information. Booth Services are arranged on the Event's Booth tab.
What $include_record_revision covers
Setting $include_record_revision=true returns record_revision for use as expected_revision on a later update.
record_revision covers this service's type, reservation and payment fields, vendor, notes, all saved service details, cost allocations, related-item links and Event binding. It does not cover File Attachment or Invoice Attachment metadata or contents.
Files and access
Invoice Attachment metadata is included as invoice_attachment, or null if none is attached. Ordinary File Attachments have their own collection.
The Event's Booth tab must be visible. A locked tab can still be read.
Formatted text in the response
Notes and other rich-text values in the response contain the stored HTML, including encoded characters and line breaks such as <br />.
Open in ExhibitDay
Each record includes exhibitday_url, the record's page in ExhibitDay. It opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.
curl -X GET "https://api.exhibitday.com/v1/events/booth_services/info?id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services/info?" + new URLSearchParams({ "id": "12345" }), {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/events/booth_services/info",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/events/booth_services/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/booth_services/info?id=12345"))
.header("Authorization", "Bearer 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/booth_services/info?id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer 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/booth_services/info?id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer 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/booth_services/info?id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer 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 response
{
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=3&riSub=0&riId=12345",
"event_id": 23456,
"event_name": "Sample Event",
"booth_service_type_id": 1,
"booth_service_type": "Other",
"acquisition_status_id": 1,
"acquisition_status": "Need to Reserve",
"description": "Illustrative service",
"notes": "",
"reserve_by_date": null,
"order_date": null,
"order_confirmation_number": "",
"vendor_name": null,
"vendor_point_of_contact": null,
"vendor_phone": null,
"vendor_email": null,
"vendor_website_url": null,
"payment_status_id": 0,
"payment_status": {
"id": 0,
"name": "N/A"
},
"payment_due_date": null,
"next_payment_due_date": null,
"payment_notes": null,
"invoice_attachment": {
"id": 282345,
"filename": "booth-service-invoice.pdf",
"attachment_created_timestamp": "2027-01-30T12:00:00Z"
},
"cost": {
"amount": 125.50,
"cost_center_breakdown": [
{
"cost_center_id": 34567,
"cost_center": "Marketing",
"charge": 75.50
},
{
"cost_center_id": 34568,
"cost_center": "Operations",
"charge": 50.00
}
]
},
"related_items": [
{
"id": 5551,
"related_item_id": 67890,
"related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/TaskView/98765?tid=67890",
"related_item_type_id": 1,
"related_item_type": "Task",
"related_item_asset_type_id": null,
"related_item_name": "Confirm booth graphics with the printer",
"related_item_created_timestamp": "2030-01-10T14:03:00Z"
},
{
"id": 5552,
"related_item_id": 45678,
"related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/RelatedItemView/98765?typeId=4&subTypeId=0&rid=45678",
"related_item_type_id": 4,
"related_item_type": "Shipment",
"related_item_asset_type_id": null,
"related_item_name": "Booth crates to convention center",
"related_item_created_timestamp": "2030-01-10T14:03:00Z"
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "X-HTTP-Method-Override: hTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Booth Service not found. Invalid Booth Service ID: 12345.",
"error_code": "not_found",
"errors": [
"Booth Service not found. Invalid Booth Service ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The invoice attachment or its owning record changed or has conflicting saved information. Retrieve the current record before retrying.",
"error_code": "record_changed",
"errors": [
"The invoice attachment or its owning record changed or has conflicting saved information. Retrieve the current record before retrying."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The Booth Service or its related scope changed. Read its current state and decide whether to retry; this request was rolled back.",
"error_code": "record_changed",
"errors": [
"The Booth Service or its related scope changed. Read its current state and decide whether to retry; this request was rolled back."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Retrieve Booth Services #
|
Retrieves Booth Services across the Events you can read.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| filter_by_event_id | Number | No |
Return records for this Event only. Omit for all readable Events in your workspace.
|
|
| $limit | Number | No |
The most services to return, as a whole number of 1 or more. Omit it to return all remaining matching services.
|
|
| $offset | Number | No |
How many services to skip, as a whole number of 0 or more; 0 by default.
|
|
| $result_format | String | No |
By default, the response is an object containing
list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
|
Allowed values:
array | wrapped_in_array |
| hydrate_related_items | Boolean | No |
Set to true to include each record's related_items: the Tasks and items linked to it, with the key to use when adding or removing a link. Omit it or send false to leave related_items out of list results. Single-record GETs always include related_items.
|
Default: false.
|
Good to know
Retrieves records across your workspace's readable Event tabs. Use filter_by_event_id to narrow the results to one Event, or omit it for the workspace list. Each record includes its event_id and Event name.
Choosing Events
Omit filter_by_event_id to retrieve records across readable Event tabs, or supply one Event ID to narrow the list. Each result retains its own event_id and Event name.
Hidden or unavailable Event tabs are not included. A locked tab can still be read. If no records match, the response is an empty list.
Reading pages
The Event filter and any people filter are applied before the total count and paging. Results are ordered by Event start date ascending, Event ID ascending, then record ID ascending.
Use $limit and $offset for successive pages. Omit $limit to return all remaining matches. total_records and X-Total-Count describe all matches; records_found counts this response.
Omit $result_format for the normal list wrapper. array returns only the records; wrapped_in_array places the normal wrapper in a one-item array.
Handling input and changes
Unrecognized parameters are ignored and listed in the X-API-Warnings response header. Conflicting or malformed filter values return HTTP 400; send arrays in JSON, query parameters or form fields rather than comma-bearing headers.
Current API access is checked even when the list is empty. A concurrent change can return HTTP 409; retrieve the list again. These filters retrieve records and do not change tags, assignments or notification settings.
Related items
Set hydrate_related_items=true to include each record's related_items: the Tasks and items linked to it. Add or remove links with POST and DELETE /v1/related_items. It is left out by default to keep lists fast. Retrieving one record always includes related_items.
Formatted text in the response
Notes and other rich-text values in the response contain the stored HTML, including encoded characters and line breaks such as <br />.
Events with a hidden Booth tab
Records on Events whose Booth tab is hidden are not listed. If filter_by_event_id names such an Event, the response is HTTP 200 with no records for it and a warning that names the tab and the Event.
Open in ExhibitDay
Each record includes exhibitday_url, the record's page in ExhibitDay. It opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.
curl -X GET "https://api.exhibitday.com/v1/events/booth_services" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services", {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/events/booth_services",
headers={"Authorization": "Bearer YOUR_API_KEY"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/events/booth_services");
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/booth_services"))
.header("Authorization", "Bearer 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/booth_services');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer 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/booth_services')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer 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/booth_services", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer 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 response
{
"records_found": 1,
"total_records": 1,
"has_more": false,
"list_type": "booth_service",
"list_data": [
{
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=3&riSub=0&riId=12345",
"event_id": 23456,
"event_name": "Sample Event",
"booth_service_type_id": 1,
"booth_service_type": "Other",
"acquisition_status_id": 1,
"acquisition_status": "Need to Reserve",
"description": "Illustrative service",
"notes": "",
"reserve_by_date": null,
"order_date": null,
"order_confirmation_number": "",
"vendor_name": null,
"vendor_point_of_contact": null,
"vendor_phone": null,
"vendor_email": null,
"vendor_website_url": null,
"payment_status_id": 0,
"payment_status": {
"id": 0,
"name": "N/A"
},
"payment_due_date": null,
"next_payment_due_date": null,
"payment_notes": null,
"invoice_attachment": {
"id": 282345,
"filename": "booth-service-invoice.pdf",
"attachment_created_timestamp": "2027-01-30T12:00:00Z"
},
"cost": {
"amount": 0.00,
"cost_center_breakdown": []
}
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "invalid_api_key",
"errors": [
"The API key is not valid for this request. Send your current key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "The invoice attachment is not available under this owning record.",
"error_code": "not_found",
"errors": [
"The invoice attachment is not available under this owning record."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The invoice attachment or its owning record changed or has conflicting saved information. Retrieve the current record before retrying.",
"error_code": "record_changed",
"errors": [
"The invoice attachment or its owning record changed or has conflicting saved information. Retrieve the current record before retrying."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The Event is changing. Read its current state and decide whether to retry.",
"error_code": "record_changed",
"errors": [
"The Event is changing. Read its current state and decide whether to retry."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Add a Booth Service #
|
Adds a Booth Service to an Event.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| event_id | Number | Yes |
The ID of the Event.
|
|
| booth_service_type_id | Number | Yes |
The type of Booth Service. Choose an ID from this supported set that is also present in the current GET /v1/references/booth_service_types lookup; use that lookup for the current names. The selected type determines which service-detail object and members apply. Required when adding a service.
|
Allowed values:
1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 |
| acquisition_status_id | Number | Yes |
Whether the service still needs to be reserved. Required when adding a service; blank or null is refused as missing. Order date and confirmation number apply only to Already Reserved.
|
Allowed values:
1 (Need to Reserve) | 2 (Already Reserved) |
| description | String | No |
A description of this service.
|
Up to 200 characters, excluding surrounding spaces. Omit for no value.
|
| notes | String | No |
Notes about this Booth Service.
|
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| reserve_by_date | String | No |
The date by which this service should be reserved or ordered.
|
Use a calendar date in YYYY-MM-DD format. This date can remain after the service is reserved. Omit for no value.
|
| order_date | String | No |
The date the service was ordered.
|
Use a calendar date in YYYY-MM-DD format. Applies only to Already Reserved (2). Supplying this or another order field while the status is Need to Reserve clears the order date and confirmation number. Omit for no value.
|
| order_confirmation_number | String | No |
The order confirmation or reference number.
|
Up to 200 characters, excluding surrounding spaces. Applies only to Already Reserved (2). Supplying it or another order field while the status is Need to Reserve clears both order fields. Omit for no value.
|
| vendor_name | String | No |
The service vendor's name.
|
Up to 200 characters, excluding surrounding spaces. Omit for no value.
|
| vendor_point_of_contact | String | No |
The vendor contact's name.
|
Up to 200 characters, excluding surrounding spaces. Omit for no value.
|
| vendor_phone | String | No |
The vendor contact's phone number.
|
Up to 200 characters, excluding surrounding spaces. Omit for no value.
|
| vendor_email | String | No |
The vendor contact's email address.
|
Up to 200 characters, excluding surrounding spaces. Omit for no value.
|
| vendor_website_url | String | No |
The vendor's website or portal link.
|
Up to 2,000 characters, excluding surrounding spaces. Omit for no value.
|
| payment_status_id | Number | No |
The service's payment status. Omit for N/A. A status other than Partially Paid clears the next partial payment due date.
|
Allowed values:
0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet) |
| payment_due_date | String | No |
The service payment due date.
|
Use a calendar date in YYYY-MM-DD format. Applies to either reservation status. Omit for no value.
|
| next_payment_due_date | Date | No |
The next partial payment due date.
|
Use a calendar date in YYYY-MM-DD format. Applies only to Partially Paid (2). Supplying this date with another payment status clears it; choosing another status also clears it. Omit for no value.
|
| payment_notes | String | No |
Notes about the service payment.
|
Up to 200 characters, excluding surrounding spaces. Omit for no value.
|
| audio_video | JSON object/list | No |
The service's audio video details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 2. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| signage | JSON object/list | No |
The service's signage details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 3. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| signage.artwork_status_id | integer or null | No | Artwork Approval Status. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Not Submitted) | 2 (Submitted) | 3 (Under Review) | 4 (Changes Requested) | 5 (Approved) |
| flooring | JSON object/list | No |
The service's flooring details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 4. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| floral | JSON object/list | No |
The service's floral details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 5. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| furniture | JSON object/list | No |
The service's furniture details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 6. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| lead_retrieval | JSON object/list | No |
The service's lead retrieval details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 7. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| utility | JSON object/list | No |
The service's utility details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 8, 9, 17, 18, 26. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| material_handling | JSON object/list | No |
The service's material handling details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 10. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| material_handling.freight_routing_id | integer or null | No | Inbound Freight Route. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Advance Warehouse) | 2 (Direct to Show) | 3 (Both) | 4 (Other) |
| labor | JSON object/list | No |
The service's labor details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 11, 12, 13, 14, 15, 16, 19, 21, 23. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| labor.work_phase_id | integer or null | No | Work Phase. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Installation) | 2 (Dismantle) | 3 (Both) |
| labor.approval_status_id | integer or null | No | Rigging Drawing Approval Status. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Not Submitted) | 2 (Submitted) | 3 (Under Review) | 4 (Changes Requested) | 5 (Approved) |
| labor.cleaning_services_required[] | array of integers or null | No | Cleaning Services Required. Send an array of JSON integers. Omit this member on PATCH to keep the saved selection; JSON null or an empty array removes the selection when the field applies. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Vacuuming) | 2 (Trash Removal) | 3 (Surface Cleaning) | 4 (Porter Service) | 5 (Other) |
| meeting_space | JSON object/list | No |
The service's meeting space details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 20. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| catering | JSON object/list | No |
The service's catering details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 22. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| booth_structure | JSON object/list | No |
The service's booth structure details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 24. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| booth_structure.exhibit_structure_type_id | integer or null | No | Exhibit / Structure Type. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Turnkey Booth Package) | 2 (Modular Rental Exhibit) | 3 (Custom Rental Exhibit) | 4 (Custom Fabricated Exhibit) | 5 (Other) |
| booth_structure.drawing_rendering_approval_status_id | integer or null | No | Drawing / Rendering Approval Status. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Not Submitted) | 2 (Submitted) | 3 (Under Review) | 4 (Changes Requested) | 5 (Approved) |
| booth_structure.installation_dismantle_coverage_id | integer or null | No | Installation / Dismantle Coverage. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Not Included) | 2 (Installation Only) | 3 (Dismantle Only) | 4 (Both) |
| media | JSON object/list | No |
The service's media details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 25. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| media.coverage_type_id | integer or null | No | Coverage Type. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Photography) | 2 (Videography) | 3 (Photography and Videography) | 4 (Other) |
| refrigeration | JSON object/list | No |
The service's refrigeration details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 27. Each member's format, choices and limits appear in the value format below. Supply the object that applies to booth_service_type_id. Inactive families and members are not applied. Omit for no details.
|
| cost | Number or cost object | No |
The full cost, as a number or an object with amount and/or cost_center_breakdown. Record Costs and Split Them Across Cost Centers.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
Optional; defaults to zero.
|
| $result_format | String | No |
By default, the response is a single object. Send
array to get it inside a one-item array.
|
Allowed values:
array | object |
| Idempotency-Key | String | No |
A unique key for safely retrying this add request.
|
Optional HTTP header: 1 to 255 visible ASCII characters without spaces. Retry the identical request with the same key to replay its first saved response. Use a new key for a different request.
|
Good to know
Adds a Booth Service to an Event's Booth tab. Choose its service type and reservation status, then supply any vendor, order or service details you want to record.
Choosing the service and its details
Choose booth_service_type_id from GET /v1/references/booth_service_types, then supply its applicable detail object. For example, a furniture order uses furniture details; a catering order uses catering details.
Use Booth Services for the orders and services you arrange. Use the Playbook for scheduled activities and their progress.
After the add
The response includes the new service and its id. The change is added to Event history. This operation sends no vendor or assignment email.
Files and the Invoice Attachment are uploaded through separate file operations. Recording costs does not attach an invoice, mark a payment complete or change the planned Booth Services budget.
Access
The Event's Booth tab must be visible and unlocked, and you need permission to update it.
If the save cannot be confirmed
Retrieve the Booth Services before deciding whether to retry. The API does not automatically repeat an unconfirmed save.
Sending values
Use JSON, a form field or a query parameter for text containing commas, detail objects, cost lists and related-item lists.
Sending text
Send plain text for Notes and other rich-text fields. Characters such as &, < and quotes, along with line breaks, are encoded for storage.
Notes and other rich-text values in the response contain the stored HTML, including encoded characters and line breaks such as <br />.
Hidden or locked tab
If the Event's Booth tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.
Detail groups for each service type
Each detail group applies only to some service types. A group sent for a different booth_service_type_id is not saved, and the response includes a warning that names the group and the type.
- audio_video: booth_service_type_id 2
- signage: booth_service_type_id 3
- flooring: booth_service_type_id 4
- floral: booth_service_type_id 5
- furniture: booth_service_type_id 6
- lead_retrieval: booth_service_type_id 7
- material_handling: booth_service_type_id 10
- utility: booth_service_type_id 8, 9, 17, 18, 26
- labor: booth_service_type_id 11, 12, 13, 14, 15, 16, 19, 21, 23
- meeting_space: booth_service_type_id 20
- catering: booth_service_type_id 22
- booth_structure: booth_service_type_id 24
- media: booth_service_type_id 25
- refrigeration: booth_service_type_id 27
Open in ExhibitDay
The created record includes exhibitday_url, the record's page in ExhibitDay. It is the same link that GET /v1/events/booth_services/info returns for this record and opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.
curl -X POST "https://api.exhibitday.com/v1/events/booth_services" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"event_id\":12345,\"booth_service_type_id\":1,\"acquisition_status_id\":1}"
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services", {
method: "POST",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "event_id": 12345, "booth_service_type_id": 1, "acquisition_status_id": 1 })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.post(
"https://api.exhibitday.com/v1/events/booth_services",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"event_id": 12345, "booth_service_type_id": 1, "acquisition_status_id": 1},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Net.Http.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.PostAsync("https://api.exhibitday.com/v1/events/booth_services",
JsonContent.Create(new { event_id = 12345, booth_service_type_id = 1, acquisition_status_id = 1 }));
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/booth_services"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"event_id\":12345,\"booth_service_type_id\":1,\"acquisition_status_id\":1}"))
.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/booth_services');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"event_id":12345,"booth_service_type_id":1,"acquisition_status_id":1}',
]);
$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/booth_services')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"event_id":12345,"booth_service_type_id":1,"acquisition_status_id":1}'
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/booth_services", strings.NewReader("{\"event_id\":12345,\"booth_service_type_id\":1,\"acquisition_status_id\":1}"))
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer 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 response
{
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345&riType=3&riSub=0&riId=12345",
"event_id": 12345,
"event_name": "Sample Event",
"booth_service_type_id": 1,
"booth_service_type": "Other",
"acquisition_status_id": 1,
"acquisition_status": "Need to Reserve",
"description": "Illustrative service",
"notes": "",
"reserve_by_date": null,
"order_date": null,
"order_confirmation_number": "",
"vendor_name": null,
"vendor_point_of_contact": null,
"vendor_phone": null,
"vendor_email": null,
"vendor_website_url": null,
"payment_status_id": 0,
"payment_status": {
"id": 0,
"name": "N/A"
},
"payment_due_date": null,
"next_payment_due_date": null,
"payment_notes": null,
"invoice_attachment": null,
"cost": {
"amount": 0.00,
"cost_center_breakdown": []
}
}
{
"status_code": 400,
"status": "Bad Request",
"message": "X-HTTP-Method-Override: hTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "This Idempotency-Key was already used with a different request. Use a new key for a new request.",
"error_code": "idempotency_key_reused",
"errors": [
"This Idempotency-Key was already used with a different request. Use a new key for a new request."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Event not found. Invalid Event ID: 12345.",
"error_code": "not_found",
"errors": [
"Event not found. Invalid Event ID: 12345."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A request with this Idempotency-Key is still being processed. Retry after a moment.",
"error_code": "idempotency_key_in_use",
"errors": [
"A request with this Idempotency-Key is still being processed. Retry after a moment."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The saved response cannot be replayed safely.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"The earlier request with this Idempotency-Key completed, but its saved response cannot be returned safely. This retry was not run and its key was not released. Look for the existing record with a GET; use a new Idempotency-Key only after checking whether another create is needed."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The Booth Service or its related scope changed. Read its current state and decide whether to retry; this request was rolled back.",
"error_code": "record_changed",
"errors": [
"The Booth Service or its related scope changed. Read its current state and decide whether to retry; this request was rolled back."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Update a Booth Service #
|
Updates an existing Booth Service.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the Booth Service.
|
Use the service's id from its list, add or single-record response.
|
| booth_service_type_id | Number | No |
The type of Booth Service. Choose an ID from this supported set that is also present in the current GET /v1/references/booth_service_types lookup; use that lookup for the current names. The selected type determines which service-detail object and members apply. Omit or leave blank to keep it;
null cannot clear it.
|
Allowed values:
1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 |
| acquisition_status_id | Number | No |
Whether the service still needs to be reserved. Omit or leave blank to keep it; null cannot clear it. Choosing Need to Reserve clears the order date and confirmation number.
|
Allowed values:
1 (Need to Reserve) | 2 (Already Reserved) |
| description | String | No |
A description of this service.
|
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
|
| notes | String | No |
Notes about this Booth Service.
|
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit notes may stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| reserve_by_date | String | No |
The date by which this service should be reserved or ordered.
|
Use a calendar date in YYYY-MM-DD format. This date can remain after the service is reserved. Omit or leave blank to keep it; null clears it.
|
| order_date | String | No |
The date the service was ordered.
|
Use a calendar date in YYYY-MM-DD format. Applies only to Already Reserved (2). Supplying this or another order field while the status is Need to Reserve clears the order date and confirmation number. Omit or leave blank to keep it; null clears it.
|
| order_confirmation_number | String | No |
The order confirmation or reference number.
|
Up to 200 characters, excluding surrounding spaces. Applies only to Already Reserved (2). Supplying it or another order field while the status is Need to Reserve clears both order fields. Omit or leave blank to keep it; null clears it.
|
| vendor_name | String | No |
The service vendor's name.
|
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
|
| vendor_point_of_contact | String | No |
The vendor contact's name.
|
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
|
| vendor_phone | String | No |
The vendor contact's phone number.
|
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
|
| vendor_email | String | No |
The vendor contact's email address.
|
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
|
| vendor_website_url | String | No |
The vendor's website or portal link.
|
Up to 2,000 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
|
| payment_status_id | Number | No |
The service's payment status. Omit or leave blank to keep it; null resets it to N/A. A status other than Partially Paid clears the next partial payment due date.
|
Allowed values:
0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet) |
| payment_due_date | String | No |
The service payment due date.
|
Use a calendar date in YYYY-MM-DD format. Applies to either reservation status. Omit or leave blank to keep it; null clears it.
|
| next_payment_due_date | Date | No |
The next partial payment due date.
|
Use a calendar date in YYYY-MM-DD format. Applies only to Partially Paid (2). Supplying this date with another payment status clears it; choosing another status also clears it. Omit or leave blank to keep it; null clears it.
|
| payment_notes | String | No |
Notes about the service payment.
|
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
|
| audio_video | JSON object/list | No |
The service's audio video details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 2. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| signage | JSON object/list | No |
The service's signage details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 3. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| signage.artwork_status_id | integer or null | No | Artwork Approval Status. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Not Submitted) | 2 (Submitted) | 3 (Under Review) | 4 (Changes Requested) | 5 (Approved) |
| flooring | JSON object/list | No |
The service's flooring details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 4. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| floral | JSON object/list | No |
The service's floral details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 5. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| furniture | JSON object/list | No |
The service's furniture details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 6. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| lead_retrieval | JSON object/list | No |
The service's lead retrieval details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 7. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| utility | JSON object/list | No |
The service's utility details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 8, 9, 17, 18, 26. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| material_handling | JSON object/list | No |
The service's material handling details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 10. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| material_handling.freight_routing_id | integer or null | No | Inbound Freight Route. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Advance Warehouse) | 2 (Direct to Show) | 3 (Both) | 4 (Other) |
| labor | JSON object/list | No |
The service's labor details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 11, 12, 13, 14, 15, 16, 19, 21, 23. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| labor.work_phase_id | integer or null | No | Work Phase. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Installation) | 2 (Dismantle) | 3 (Both) |
| labor.approval_status_id | integer or null | No | Rigging Drawing Approval Status. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Not Submitted) | 2 (Submitted) | 3 (Under Review) | 4 (Changes Requested) | 5 (Approved) |
| labor.cleaning_services_required[] | array of integers or null | No | Cleaning Services Required. Send an array of JSON integers. Omit this member on PATCH to keep the saved selection; JSON null or an empty array removes the selection when the field applies. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Vacuuming) | 2 (Trash Removal) | 3 (Surface Cleaning) | 4 (Porter Service) | 5 (Other) |
| meeting_space | JSON object/list | No |
The service's meeting space details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 20. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| catering | JSON object/list | No |
The service's catering details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 22. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| booth_structure | JSON object/list | No |
The service's booth structure details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 24. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| booth_structure.exhibit_structure_type_id | integer or null | No | Exhibit / Structure Type. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Turnkey Booth Package) | 2 (Modular Rental Exhibit) | 3 (Custom Rental Exhibit) | 4 (Custom Fabricated Exhibit) | 5 (Other) |
| booth_structure.drawing_rendering_approval_status_id | integer or null | No | Drawing / Rendering Approval Status. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Not Submitted) | 2 (Submitted) | 3 (Under Review) | 4 (Changes Requested) | 5 (Approved) |
| booth_structure.installation_dismantle_coverage_id | integer or null | No | Installation / Dismantle Coverage. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Not Included) | 2 (Installation Only) | 3 (Dismantle Only) | 4 (Both) |
| media | JSON object/list | No |
The service's media details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 25. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| media.coverage_type_id | integer or null | No | Coverage Type. Send a JSON integer, or JSON null to clear the choice when the field applies. Omit this member on PATCH to keep its value, subject to changes to its controlling fields. The service type and its controlling choices determine whether the field is used. With $ignore_params_with_empty_values=true, a JSON null member is ignored. Quoted values and empty strings are refused. | Allowed values: 1 (Photography) | 2 (Videography) | 3 (Photography and Videography) | 4 (Other) |
| refrigeration | JSON object/list | No |
The service's refrigeration details.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
A JSON object for service type IDs 27. Each member's format, choices and limits appear in the value format below. Omitted members keep their values. An empty object changes no members; null clears the details offered by the selected type. Details for other families or Labor subtypes are retained. See Changing service details below.
|
| cost | Number or cost object | No |
The full cost, as a number or an object with amount and/or cost_center_breakdown. Record Costs and Split Them Across Cost Centers.
View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
Omit to keep the saved cost. A supplied value replaces its full allocation.
|
| expected_revision | String | No |
The record_revision from an earlier read of this Booth Service.
|
Optional. Obtain it from GET /v1/events/booth_services/info with $include_record_revision=true. A changed service returns HTTP 409 without saving this update. Omission skips the check; blank, null and malformed values are refused.
|
| $ignore_params_with_empty_values | Boolean | No |
Whether empty supplied values should leave their current values unchanged.
|
Default: false. With true, whole JSON nulls are ignored; empty strings and JSON null members inside detail objects are also ignored. The text null at the top level still requests clearing where supported. Inside a detail object, the text null is ordinary text.
|
Good to know
Updates a Booth Service on an Event's Booth tab. Send only the fields or detail members you want to change, such as its reservation status, vendor or payment information.
Choosing what to change
Omitted or blank top-level fields stay unchanged. Send null to clear supported fields; booth_service_type_id and acquisition_status_id cannot be cleared. Payment status resets to N/A when cleared.
An unchanged request saves no business data, invoice caption or history and keeps its revision. A real service-type change updates its existing Invoice Attachment caption to the current type without replacing the file. Other File Attachments are managed separately.
Changing service details
Send only the members you want to change in the applicable detail object. JSON null clears an applicable member; an empty string clears an applicable text value. An unanswered yes/no is different from false. The text null inside the object is ordinary text.
Changing a controlling choice can clear dependent fields that no longer apply. Changing the service type retains earlier families and other Labor subtype details for a later switch back. Clearing a whole detail object affects only the members offered by the selected type.
Using expected_revision
- Retrieve this service with GET /v1/events/booth_services/info and $include_record_revision=true.
- Send the returned record_revision unchanged as expected_revision with this update.
- If the API reports that the service changed, read its current values and decide what to update.
Access
The Event's Booth tab must be visible and unlocked, and you need permission to update it.
After the update
A real change is added to Event history. This operation sends no vendor or assignment email. If the save outcome cannot be confirmed, retrieve the service before deciding whether to retry.
Sending values
Use JSON, a form field or a query parameter for text containing commas, detail objects, cost lists and related-item lists.
Sending text
Send plain text for Notes and other rich-text fields. Characters such as &, < and quotes, along with line breaks, are encoded for storage.
Hidden or locked tab
If the Event's Booth tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.
Detail groups for each service type
Each detail group applies only to some service types. A group sent for a different booth_service_type_id is not saved, and the response includes a warning that names the group and the type.
- audio_video: booth_service_type_id 2
- signage: booth_service_type_id 3
- flooring: booth_service_type_id 4
- floral: booth_service_type_id 5
- furniture: booth_service_type_id 6
- lead_retrieval: booth_service_type_id 7
- material_handling: booth_service_type_id 10
- utility: booth_service_type_id 8, 9, 17, 18, 26
- labor: booth_service_type_id 11, 12, 13, 14, 15, 16, 19, 21, 23
- meeting_space: booth_service_type_id 20
- catering: booth_service_type_id 22
- booth_structure: booth_service_type_id 24
- media: booth_service_type_id 25
- refrigeration: booth_service_type_id 27
curl -X PATCH "https://api.exhibitday.com/v1/events/booth_services" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"description\":\"Updated description\"}"
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services", {
method: "PATCH",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "id": 12345, "description": "Updated description" })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.patch(
"https://api.exhibitday.com/v1/events/booth_services",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"id": 12345, "description": "Updated description"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Net.Http.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.PatchAsync("https://api.exhibitday.com/v1/events/booth_services",
JsonContent.Create(new { id = 12345, description = "Updated description" }));
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/booth_services"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\"id\":12345,\"description\":\"Updated description\"}"))
.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/booth_services');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"id":12345,"description":"Updated description"}',
]);
$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/booth_services')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"id":12345,"description":"Updated description"}'
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/booth_services", strings.NewReader("{\"id\":12345,\"description\":\"Updated description\"}"))
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer 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 response
{
"status_code": 200,
"status": "OK",
"message": "Booth Service updated.",
"errors": []
}
{
"status_code": 400,
"status": "Bad Request",
"message": "X-HTTP-Method-Override: hTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Booth Service not found. Invalid Booth Service ID: 12345.",
"error_code": "not_found",
"errors": [
"Booth Service not found. Invalid Booth Service ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Booth Service not found. Invalid Booth Service ID: 12345.",
"error_code": "not_found",
"errors": [
"Booth Service not found. Invalid Booth Service ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This Booth Service changed since you read it; nothing was changed.",
"error_code": "record_changed",
"errors": [
"This Booth Service changed since you read it; nothing was changed."
],
"error_params": [
"expected_revision"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The Booth Service or its related scope changed. Read its current state and decide whether to retry; this request was rolled back.",
"error_code": "record_changed",
"errors": [
"The Booth Service or its related scope changed. Read its current state and decide whether to retry; this request was rolled back."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Delete a Booth Service #
|
Deletes an existing Booth Service.
Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the Booth Service.
|
Use the service's id from its list, add or single-record response.
|
Good to know
Deletes a Booth Service and its saved service details, costs, related-item links, File Attachments and Invoice Attachment. Linked Tasks, Playbook activities and other related records remain in place.
After the deletion
The service, all its saved detail families, costs, related-item links and attachment records are removed together. Only its files are scheduled for physical cleanup after the save. Linked records remain.
The deletion is recorded in Event history and sends no vendor or assignment email. An unavailable service returns HTTP 404. If the save outcome cannot be confirmed, retrieve the current services before deciding whether to retry.
Access
The Event's Booth tab must be visible and unlocked, and you need permission to update it.
Hidden or locked tab
If the Event's Booth tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.
curl -X DELETE "https://api.exhibitday.com/v1/events/booth_services?id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services?" + new URLSearchParams({ "id": "12345" }), {
method: "DELETE",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.delete(
"https://api.exhibitday.com/v1/events/booth_services",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.DeleteAsync("https://api.exhibitday.com/v1/events/booth_services?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/booth_services?id=12345"))
.header("Authorization", "Bearer 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/booth_services?id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer 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/booth_services?id=12345')
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = 'Bearer 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/booth_services?id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer 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 response
{
"status_code": 200,
"status": "OK",
"message": "Booth Service removed.",
"errors": []
}
{
"status_code": 400,
"status": "Bad Request",
"message": "X-HTTP-Method-Override: hTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Booth Service not found. Invalid Booth Service ID: 12345.",
"error_code": "not_found",
"errors": [
"Booth Service not found. Invalid Booth Service ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Booth Service not found. Invalid Booth Service ID: 12345.",
"error_code": "not_found",
"errors": [
"Booth Service not found. Invalid Booth Service ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The Booth Service or its related scope changed. Read its current state and decide whether to retry; this request was rolled back.",
"error_code": "record_changed",
"errors": [
"The Booth Service or its related scope changed. Read its current state and decide whether to retry; this request was rolled back."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Download Booth Service Invoice Attachment #
|
Downloads the Invoice Attachment for a Booth Service.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| booth_service_id | Number | Yes |
The ID of the Booth Service, from Retrieve Booth Services (GET /v1/events/booth_services) or its add response.
|
Good to know
Downloads the original Invoice Attachment for this Booth Service. Use this method to retrieve the file itself.
Finding the file
In the web app, this is the invoice control beside the Booth Service's cost and payment details on the Event's Booth tab. Each cost has one Invoice Attachment even when its amount is split among cost centers.
For file metadata, retrieve the parent record with GET /v1/events/booth_services/info and read invoice_attachment. Use this download method for the contents. No attachment ID or invoice flag is needed.
Download response
A successful response contains the original uploaded file, with a safe download filename. API errors use the usual JSON response. If no invoice is attached, this method returns HTTP 404.
Current record, financial and invoice permissions apply. A locked tab can still be read. Permitted downloads remain available on the Free plan.
Files still being copied
If this file is still being copied, the download returns HTTP 409 with file_copy_pending. Try the download again in a few minutes.
Hidden tab
If the Event's Booth tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X GET "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment/download?booth_service_id=12345" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
mv response-body.tmp 'invoice.pdf'
// Node.js 18+; use a local file only for a declared multipart operation.
import { readFile, writeFile } from 'node:fs/promises';
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services/invoice_attachment/download?booth_service_id=12345", { method: "GET", headers: { Authorization: 'Bearer YOUR_API_KEY' } });
if (response.status !== 200) throw new Error(`${response.status}: ${await response.text()}`);
await writeFile("invoice.pdf", new Uint8Array(await response.arrayBuffer()));
import requests
import json
response = requests.request("GET", "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment/download?booth_service_id=12345", headers={'Authorization': 'Bearer YOUR_API_KEY'}, timeout=30)
if response.status_code != 200:
raise RuntimeError(f'{response.status_code}: {response.text}')
with open("invoice.pdf", 'wb') as destination:
destination.write(response.content)
using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment/download?booth_service_id=12345");
using var response = await client.SendAsync(request);
if ((int)response.StatusCode != 200) throw new Exception(await response.Content.ReadAsStringAsync());
await File.WriteAllBytesAsync("invoice.pdf", await response.Content.ReadAsByteArrayAsync());
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.nio.charset.StandardCharsets;
import java.io.ByteArrayOutputStream;
import java.util.UUID;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpRequest.Builder request = HttpRequest.newBuilder(URI.create("https://api.exhibitday.com/v1/events/booth_services/invoice_attachment/download?booth_service_id=12345")).header("Authorization", "Bearer YOUR_API_KEY");
HttpResponse<byte[]> response = HttpClient.newHttpClient().send(request.method("GET", HttpRequest.BodyPublishers.noBody()).build(), HttpResponse.BodyHandlers.ofByteArray());
if (response.statusCode() != 200) throw new RuntimeException(new String(response.body(), StandardCharsets.UTF_8));
Files.write(Path.of("invoice.pdf"), response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/events/booth_services/invoice_attachment/download?booth_service_id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status !== 200) throw new RuntimeException($response);
file_put_contents('invoice.pdf', $response);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/events/booth_services/invoice_attachment/download?booth_service_id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
raise response.body unless response.code == '200'
File.binwrite('invoice.pdf', response.body)
package main
import (
"fmt"
"io"
"log"
"net/http"
"os"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment/download?booth_service_id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
if response.StatusCode != 200 { log.Fatalf("%d %s", response.StatusCode, data) }
if err := os.WriteFile("invoice.pdf", data, 0600); err != nil { log.Fatal(err) }
fmt.Println("File saved")
}
Example response
Content type: application/octet-stream
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "File not found.",
"error_code": "not_found",
"errors": [
"File not found."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This file is still being copied. Try again in a few minutes.",
"error_code": "file_copy_pending",
"errors": [
"This file is still being copied. Try again in a few minutes."
],
"error_params": [
"file"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Add Booth Service Invoice Attachment #
|
Adds an Invoice Attachment to a Booth Service.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| booth_service_id | Number | Yes |
The ID of the Booth Service, from Retrieve Booth Services (GET /v1/events/booth_services) or its add response.
|
|
| file | File (multipart) | Yes |
The Invoice Attachment to upload.
Maximum size per file: 25 MiB (26,214,400 bytes). Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip. Maximum files per request: 1. View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
Send exactly one complete, nonempty multipart/form-data file part named file. The supported extensions and current per-file limit are shown below; the complete request limit also includes multipart overhead. A missing or null file is invalid and does not remove an existing invoice.
|
| Idempotency-Key | String | No |
A unique key for safely retrying this upload.
|
Optional HTTP header: 1 to 255 visible ASCII characters without spaces or commas. Retry the identical request with the same key to replay its first saved response. Use a new key for a different upload.
|
Good to know
Adds one Invoice Attachment to this Booth Service. You can attach an invoice, receipt or other payment document when no invoice file is currently attached.
Before you upload
POST requires an empty invoice slot. If an invoice is already attached, the API returns HTTP 409; use PATCH to replace it.
An Invoice Attachment is separate from the record's supporting File Attachments. Use the invoice control beside the Booth Service's cost and payment details on the Event's Booth tab in the web app.
After the upload
The response's invoice_attachment contains the attached file's id, filename and attachment_created_timestamp. The amount, payment fields, cost-center breakdown and other files are unchanged.
The upload is recorded in Event history. Attaching an invoice does not mark the record as paid.
Access and retries
A current upload-enabled plan, record and financial permissions, and an editable applicable tab are required. Each uploaded file must fit its supported type and size limits.
expected_revision is not supported by this file method. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/booth_services/info and inspect invoice_attachment before deciding whether to retry.
Hidden or locked tab
If the Event's Booth tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X POST "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "booth_service_id=12345" --form "file=@invoice.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp
// Node.js 18+; use a local file only for a declared multipart operation.
import { readFile, writeFile } from 'node:fs/promises';
const form = new FormData();
form.append("booth_service_id", "12345");
form.append("file", new Blob([await readFile("invoice.pdf")], { type: "application/octet-stream" }), "invoice.pdf");
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services/invoice_attachment", { method: "POST", headers: { Authorization: 'Bearer YOUR_API_KEY' }, body: form });
if (response.status !== 200) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());
import requests
import json
from contextlib import ExitStack
with ExitStack() as stack:
files = [
("file", ("invoice.pdf", stack.enter_context(open("invoice.pdf", 'rb')), "application/octet-stream")),
]
response = requests.request("POST", "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment", headers={'Authorization': 'Bearer YOUR_API_KEY'}, files=files, data={"booth_service_id": "12345"}, timeout=30)
if response.status_code != 200:
raise RuntimeError(f'{response.status_code}: {response.text}')
print(response.json())
using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
using var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment");
var form = new MultipartFormDataContent();
form.Add(new StringContent("12345"), "booth_service_id");
var file0 = new StreamContent(File.OpenRead("invoice.pdf"));
file0.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
form.Add(file0, "file", "invoice.pdf");
request.Content = form;
using var response = await client.SendAsync(request);
if ((int)response.StatusCode != 200) throw new Exception(await response.Content.ReadAsStringAsync());
Console.WriteLine(await response.Content.ReadAsStringAsync());
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.nio.charset.StandardCharsets;
import java.io.ByteArrayOutputStream;
import java.util.UUID;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpRequest.Builder request = HttpRequest.newBuilder(URI.create("https://api.exhibitday.com/v1/events/booth_services/invoice_attachment")).header("Authorization", "Bearer YOUR_API_KEY");
String boundary = "ExhibitDay-" + UUID.randomUUID();
ByteArrayOutputStream form = new ByteArrayOutputStream();
form.write(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"booth_service_id\"\r\n\r\n" + "12345" + "\r\n").getBytes(StandardCharsets.UTF_8));
form.write(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"file\"; filename=\"invoice.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n").getBytes(StandardCharsets.UTF_8));
form.write(Files.readAllBytes(Path.of("invoice.pdf")));
form.write("\r\n".getBytes(StandardCharsets.UTF_8));
form.write(("--" + boundary + "--\r\n").getBytes(StandardCharsets.UTF_8));
request.header("Content-Type", "multipart/form-data; boundary=" + boundary);
HttpResponse<byte[]> response = HttpClient.newHttpClient().send(request.method("POST", HttpRequest.BodyPublishers.ofByteArray(form.toByteArray())).build(), HttpResponse.BodyHandlers.ofByteArray());
if (response.statusCode() != 200) throw new RuntimeException(new String(response.body(), StandardCharsets.UTF_8));
System.out.println(new String(response.body(), StandardCharsets.UTF_8));
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/events/booth_services/invoice_attachment');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
CURLOPT_POSTFIELDS => [
'booth_service_id' => '12345',
'file' => new CURLFile('invoice.pdf', 'application/octet-stream', 'invoice.pdf'),
],
]);
$response = curl_exec($curl);
if ($response === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status !== 200) throw new RuntimeException($response);
echo $response;
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/events/booth_services/invoice_attachment')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
files = []
begin
parts = [
['booth_service_id', '12345'],
['file', (files << File.open('invoice.pdf', 'rb')).last, {filename: 'invoice.pdf', content_type: 'application/octet-stream'}],
]
request.set_form(parts, 'multipart/form-data')
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
raise response.body unless response.code == '200'
puts response.body
ensure
files.each(&:close)
end
package main
import (
"fmt"
"io"
"log"
"net/http"
"os"
"bytes"
"mime/multipart"
"net/textproto"
)
func main() {
var form bytes.Buffer
writer := multipart.NewWriter(&form)
if err := writer.WriteField("booth_service_id", "12345"); err != nil { log.Fatal(err) }
header0 := textproto.MIMEHeader{}
header0.Set("Content-Disposition", "form-data; name=\"file\"; filename=\"invoice.pdf\"")
header0.Set("Content-Type", "application/octet-stream")
part0, err := writer.CreatePart(header0)
if err != nil { log.Fatal(err) }
file0, err := os.Open("invoice.pdf")
if err != nil { log.Fatal(err) }
if _, err = io.Copy(part0, file0); err != nil { log.Fatal(err) }
file0.Close()
if err := writer.Close(); err != nil { log.Fatal(err) }
request, err := http.NewRequest("POST", "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment", &form)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
request.Header.Set("Content-Type", writer.FormDataContentType())
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
if response.StatusCode != 200 { log.Fatalf("%d %s", response.StatusCode, data) }
fmt.Printf("%s\n", data)
}
Example response
{
"invoice_attachment": {
"id": 12345,
"filename": "invoice.pdf",
"attachment_created_timestamp": "2027-01-30T12:00:00Z"
}
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "This Idempotency-Key was already used with a different request. Use a new key for a new request.",
"error_code": "idempotency_key_reused",
"errors": [
"This Idempotency-Key was already used with a different request. Use a new key for a new request."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is locked on this Event. Unlock it in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Booth Service not found. Invalid Booth Service ID: 12345.",
"error_code": "not_found",
"errors": [
"Booth Service not found. Invalid Booth Service ID: 12345."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A request with this Idempotency-Key is still being processed. Retry after a moment.",
"error_code": "idempotency_key_in_use",
"errors": [
"A request with this Idempotency-Key is still being processed. Retry after a moment."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The saved response cannot be replayed safely.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"The earlier request with this Idempotency-Key completed, but its saved response cannot be returned safely. This retry was not run and its key was not released. Look for the existing record with a GET; use a new Idempotency-Key only after checking whether another create is needed."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The attachment state changed or the invoice slot is occupied. Retrieve its current state before retrying.",
"error_code": "record_changed",
"errors": [
"The attachment state changed or the invoice slot is occupied. Retrieve its current state before retrying."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Replace Booth Service Invoice Attachment #
|
Replaces a Booth Service's Invoice Attachment.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| booth_service_id | Number | Yes |
The ID of the Booth Service, from Retrieve Booth Services (GET /v1/events/booth_services) or its add response.
|
|
| file | File (multipart) | Yes |
The Invoice Attachment to upload.
Maximum size per file: 25 MiB (26,214,400 bytes). Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip. Maximum files per request: 1. View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
Send exactly one complete, nonempty multipart/form-data file part named file. The supported extensions and current per-file limit are shown below; the complete request limit also includes multipart overhead. A missing or null file is invalid and does not remove an existing invoice.
|
Good to know
Replaces this Booth Service's current Invoice Attachment with one uploaded file. Use this method when an invoice file is already attached.
Replacing the current file
PATCH requires a current invoice file. If none is attached, the API returns HTTP 404. Upload exactly one file; the previous attachment ID is not needed.
If another request changes the current invoice during your upload, the API refuses this request instead of replacing a different file. Even identical replacement contents receive a new attachment ID.
After the replacement
The response's invoice_attachment contains the attached file's id, filename and attachment_created_timestamp. The amount, payment fields, cost-center breakdown and other files are unchanged.
The previous file is scheduled for physical cleanup after a confirmed save; cleanup may finish later. The replacement is recorded in Event history.
Access and retries
A current upload-enabled plan, record and financial permissions, and an editable applicable tab are required. Each uploaded file must fit its supported type and size limits.
expected_revision is not supported by this file method. PATCH does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/booth_services/info and inspect invoice_attachment before deciding whether to retry.
Hidden or locked tab
If the Event's Booth tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X PATCH "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "booth_service_id=12345" --form "file=@invoice.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp
// Node.js 18+; use a local file only for a declared multipart operation.
import { readFile, writeFile } from 'node:fs/promises';
const form = new FormData();
form.append("booth_service_id", "12345");
form.append("file", new Blob([await readFile("invoice.pdf")], { type: "application/octet-stream" }), "invoice.pdf");
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services/invoice_attachment", { method: "PATCH", headers: { Authorization: 'Bearer YOUR_API_KEY' }, body: form });
if (response.status !== 200) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());
import requests
import json
from contextlib import ExitStack
with ExitStack() as stack:
files = [
("file", ("invoice.pdf", stack.enter_context(open("invoice.pdf", 'rb')), "application/octet-stream")),
]
response = requests.request("PATCH", "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment", headers={'Authorization': 'Bearer YOUR_API_KEY'}, files=files, data={"booth_service_id": "12345"}, timeout=30)
if response.status_code != 200:
raise RuntimeError(f'{response.status_code}: {response.text}')
print(response.json())
using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
using var request = new HttpRequestMessage(new HttpMethod("PATCH"), "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment");
var form = new MultipartFormDataContent();
form.Add(new StringContent("12345"), "booth_service_id");
var file0 = new StreamContent(File.OpenRead("invoice.pdf"));
file0.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
form.Add(file0, "file", "invoice.pdf");
request.Content = form;
using var response = await client.SendAsync(request);
if ((int)response.StatusCode != 200) throw new Exception(await response.Content.ReadAsStringAsync());
Console.WriteLine(await response.Content.ReadAsStringAsync());
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.nio.charset.StandardCharsets;
import java.io.ByteArrayOutputStream;
import java.util.UUID;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpRequest.Builder request = HttpRequest.newBuilder(URI.create("https://api.exhibitday.com/v1/events/booth_services/invoice_attachment")).header("Authorization", "Bearer YOUR_API_KEY");
String boundary = "ExhibitDay-" + UUID.randomUUID();
ByteArrayOutputStream form = new ByteArrayOutputStream();
form.write(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"booth_service_id\"\r\n\r\n" + "12345" + "\r\n").getBytes(StandardCharsets.UTF_8));
form.write(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"file\"; filename=\"invoice.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n").getBytes(StandardCharsets.UTF_8));
form.write(Files.readAllBytes(Path.of("invoice.pdf")));
form.write("\r\n".getBytes(StandardCharsets.UTF_8));
form.write(("--" + boundary + "--\r\n").getBytes(StandardCharsets.UTF_8));
request.header("Content-Type", "multipart/form-data; boundary=" + boundary);
HttpResponse<byte[]> response = HttpClient.newHttpClient().send(request.method("PATCH", HttpRequest.BodyPublishers.ofByteArray(form.toByteArray())).build(), HttpResponse.BodyHandlers.ofByteArray());
if (response.statusCode() != 200) throw new RuntimeException(new String(response.body(), StandardCharsets.UTF_8));
System.out.println(new String(response.body(), StandardCharsets.UTF_8));
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/events/booth_services/invoice_attachment');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
CURLOPT_POSTFIELDS => [
'booth_service_id' => '12345',
'file' => new CURLFile('invoice.pdf', 'application/octet-stream', 'invoice.pdf'),
],
]);
$response = curl_exec($curl);
if ($response === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status !== 200) throw new RuntimeException($response);
echo $response;
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/events/booth_services/invoice_attachment')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
files = []
begin
parts = [
['booth_service_id', '12345'],
['file', (files << File.open('invoice.pdf', 'rb')).last, {filename: 'invoice.pdf', content_type: 'application/octet-stream'}],
]
request.set_form(parts, 'multipart/form-data')
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
raise response.body unless response.code == '200'
puts response.body
ensure
files.each(&:close)
end
package main
import (
"fmt"
"io"
"log"
"net/http"
"os"
"bytes"
"mime/multipart"
"net/textproto"
)
func main() {
var form bytes.Buffer
writer := multipart.NewWriter(&form)
if err := writer.WriteField("booth_service_id", "12345"); err != nil { log.Fatal(err) }
header0 := textproto.MIMEHeader{}
header0.Set("Content-Disposition", "form-data; name=\"file\"; filename=\"invoice.pdf\"")
header0.Set("Content-Type", "application/octet-stream")
part0, err := writer.CreatePart(header0)
if err != nil { log.Fatal(err) }
file0, err := os.Open("invoice.pdf")
if err != nil { log.Fatal(err) }
if _, err = io.Copy(part0, file0); err != nil { log.Fatal(err) }
file0.Close()
if err := writer.Close(); err != nil { log.Fatal(err) }
request, err := http.NewRequest("PATCH", "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment", &form)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
request.Header.Set("Content-Type", writer.FormDataContentType())
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
if response.StatusCode != 200 { log.Fatalf("%d %s", response.StatusCode, data) }
fmt.Printf("%s\n", data)
}
Example response
{
"invoice_attachment": {
"id": 12345,
"filename": "invoice.pdf",
"attachment_created_timestamp": "2027-01-30T12:00:00Z"
}
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is locked on this Event. Unlock it in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Booth Service not found. Invalid Booth Service ID: 12345.",
"error_code": "not_found",
"errors": [
"Booth Service not found. Invalid Booth Service ID: 12345."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The attachment state changed or the invoice slot is occupied. Retrieve its current state before retrying.",
"error_code": "record_changed",
"errors": [
"The attachment state changed or the invoice slot is occupied. Retrieve its current state before retrying."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Remove Booth Service Invoice Attachment #
|
Deletes a Booth Service's Invoice Attachment.
Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| booth_service_id | Number | Yes |
The ID of the Booth Service, from Retrieve Booth Services (GET /v1/events/booth_services) or its add response.
|
Good to know
Removes this Booth Service's Invoice Attachment. The cost, payment details and other File Attachments stay in place.
After the removal
The Invoice Attachment is cleared and the removal is recorded in Event history. Its physical file is scheduled for cleanup after a confirmed save; cleanup may finish later. Costs, payment fields, cost-center allocations and supporting files stay unchanged.
If no invoice is attached, DELETE returns HTTP 404 Not Found with the message "This Booth Service has no invoice to remove." No saved data or history is changed. Current access and the record's binding are still checked. Do not send file parts with this request.
Access and retries
Current record, financial and invoice permissions and applicable tab-edit access are required. Permitted removals remain available on the Free plan.
expected_revision is not supported, and DELETE does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/booth_services/info and inspect invoice_attachment before deciding whether to retry.
Hidden or locked tab
If the Event's Booth tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.
curl -X DELETE "https://api.exhibitday.com/v1/events/booth_services/invoice_attachment?booth_service_id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services/invoice_attachment?" + new URLSearchParams({ "booth_service_id": "12345" }), {
method: "DELETE",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.delete(
"https://api.exhibitday.com/v1/events/booth_services/invoice_attachment",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"booth_service_id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.DeleteAsync("https://api.exhibitday.com/v1/events/booth_services/invoice_attachment?booth_service_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/booth_services/invoice_attachment?booth_service_id=12345"))
.header("Authorization", "Bearer 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/booth_services/invoice_attachment?booth_service_id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer 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/booth_services/invoice_attachment?booth_service_id=12345')
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = 'Bearer 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/booth_services/invoice_attachment?booth_service_id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer 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 response
{
"status_code": 200,
"status": "OK",
"message": "Attachment removed.",
"errors": []
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is locked on this Event. Unlock it in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Booth Service not found. Invalid Booth Service ID: 12345.",
"error_code": "not_found",
"errors": [
"Booth Service not found. Invalid Booth Service ID: 12345."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "This Booth Service has no invoice to remove.",
"error_code": "not_found",
"errors": [
"This Booth Service has no invoice to remove."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The attachment state changed or the invoice slot is occupied. Retrieve its current state before retrying.",
"error_code": "record_changed",
"errors": [
"The attachment state changed or the invoice slot is occupied. Retrieve its current state before retrying."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Retrieve Booth Service General File Attachments #
|
Retrieves the General File Attachments on a Booth Service.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| booth_service_id | Number | Yes |
The ID of the Booth Service, from Retrieve Booth Services (GET /v1/events/booth_services) or its add response.
|
|
| $limit | Number | No |
The most File Attachments to return.
|
A positive whole number. Omit for all remaining matching files.
|
| $offset | Number | No |
The number of matching File Attachments to skip.
|
A whole number of 0 or more. Default: 0.
|
| $result_format | String | No |
By default, the response is an object containing
list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records.
|
Allowed values:
array |
| If-None-Match | String | No |
An ETag from an earlier response to this GET.
|
Optional HTTP header. If the successful response is unchanged, the API returns HTTP 304 with no body.
|
Good to know
Retrieves the General File Attachments on this Booth Service. Each result includes the file's ID, name and added time; use the download method for its contents.
Reading the file list
Files are ordered by added time, then attachment ID, lowest first. Only files available under your current access are included.
Paging totals and X-Total-Count count all matching files before $limit and $offset are applied. A record with no files you can view returns an empty list. This list does not return edit revisions or support changed-since filtering.
Supporting files and invoices
These are the record's General File Attachments. Its cost Invoice Attachment is separate and has its own download and upload methods. Use this list's id values for these supporting-file downloads and removals.
Access
The record's Event and tab must be available, and the tab must not be hidden. A locked tab can still be read.
Hidden tab
If the Event's Booth tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.
curl -X GET "https://api.exhibitday.com/v1/events/booth_services/attachments?booth_service_id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services/attachments?" + new URLSearchParams({ "booth_service_id": "12345" }), {
method: "GET",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.get(
"https://api.exhibitday.com/v1/events/booth_services/attachments",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"booth_service_id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.GetAsync("https://api.exhibitday.com/v1/events/booth_services/attachments?booth_service_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/booth_services/attachments?booth_service_id=12345"))
.header("Authorization", "Bearer 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/booth_services/attachments?booth_service_id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer 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/booth_services/attachments?booth_service_id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer 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/booth_services/attachments?booth_service_id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer 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 response
{
"records_found": 1,
"total_records": 1,
"has_more": false,
"list_type": "attachment",
"list_data": [
{
"id": 12345,
"filename": "attachment.pdf",
"attachment_created_timestamp": "2027-01-30T12:00:00Z"
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Booth Service not found. Invalid Booth Service ID: 12345.",
"error_code": "not_found",
"errors": [
"Booth Service not found. Invalid Booth Service ID: 12345."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Add Booth Service General File Attachments #
|
Adds General File Attachments to a Booth Service.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| booth_service_id | Number | Yes |
The ID of the Booth Service, from Retrieve Booth Services (GET /v1/events/booth_services) or its add response.
|
|
| file | File (multipart) | Yes |
The File Attachments to upload.
Maximum size per file: 25 MiB (26,214,400 bytes). Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip. View value format and limitsFile uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.
|
Send one or more complete, nonempty multipart/form-data parts, each named file. Supported types and the current per-file limit are shown below. The complete request limit includes all files and multipart overhead; split larger batches. A missing or null upload is not a removal request.
|
| Idempotency-Key | String | No |
A unique key for safely retrying this upload.
|
Optional HTTP header: 1 to 255 visible ASCII characters without spaces or commas. Retry the identical request with the same key to replay its first saved response. Use a new key for a different upload.
|
Good to know
Adds one or more General File Attachments to this Booth Service. Send each file as a multipart upload part named file.
After the upload
The response's list_data contains the newly attached files, including each id, filename and attachment_created_timestamp. Existing files are kept. Use each returned id to download or remove that file.
Identical repeated files in one request are attached once when their cleaned filename, length and contents match. Files with different contents remain separate even when their names match. This does not remove or replace files already attached to the record.
Choosing the right file method
These uploads add General File Attachments. Use this record's Invoice Attachment methods for its cost invoice or receipt. Adding supporting files does not change amounts, payments or cost-center allocations.
Access
Current record and file-change permissions and applicable Event/tab locks must allow this upload. An upload-enabled paid plan is required.
History and retries
A confirmed file change is recorded in history. expected_revision is not supported by these file methods. If the save outcome cannot be confirmed, retrieve the current file list before deciding whether to retry; the API does not automatically repeat an uncertain change.
Supporting File Attachments have no PATCH replacement. To replace one, add the new file and remove the old one using their separate requests; each request has its own outcome.
Hidden or locked tab
If the Event's Booth tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X POST "https://api.exhibitday.com/v1/events/booth_services/attachments" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "booth_service_id=12345" --form "file=@attachment.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp
// Node.js 18+; use a local file only for a declared multipart operation.
import { readFile, writeFile } from 'node:fs/promises';
const form = new FormData();
form.append("booth_service_id", "12345");
form.append("file", new Blob([await readFile("attachment.pdf")], { type: "application/octet-stream" }), "attachment.pdf");
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services/attachments", { method: "POST", headers: { Authorization: 'Bearer YOUR_API_KEY' }, body: form });
if (response.status !== 200) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());
import requests
import json
from contextlib import ExitStack
with ExitStack() as stack:
files = [
("file", ("attachment.pdf", stack.enter_context(open("attachment.pdf", 'rb')), "application/octet-stream")),
]
response = requests.request("POST", "https://api.exhibitday.com/v1/events/booth_services/attachments", headers={'Authorization': 'Bearer YOUR_API_KEY'}, files=files, data={"booth_service_id": "12345"}, timeout=30)
if response.status_code != 200:
raise RuntimeError(f'{response.status_code}: {response.text}')
print(response.json())
using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
using var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.exhibitday.com/v1/events/booth_services/attachments");
var form = new MultipartFormDataContent();
form.Add(new StringContent("12345"), "booth_service_id");
var file0 = new StreamContent(File.OpenRead("attachment.pdf"));
file0.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
form.Add(file0, "file", "attachment.pdf");
request.Content = form;
using var response = await client.SendAsync(request);
if ((int)response.StatusCode != 200) throw new Exception(await response.Content.ReadAsStringAsync());
Console.WriteLine(await response.Content.ReadAsStringAsync());
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.nio.charset.StandardCharsets;
import java.io.ByteArrayOutputStream;
import java.util.UUID;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpRequest.Builder request = HttpRequest.newBuilder(URI.create("https://api.exhibitday.com/v1/events/booth_services/attachments")).header("Authorization", "Bearer YOUR_API_KEY");
String boundary = "ExhibitDay-" + UUID.randomUUID();
ByteArrayOutputStream form = new ByteArrayOutputStream();
form.write(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"booth_service_id\"\r\n\r\n" + "12345" + "\r\n").getBytes(StandardCharsets.UTF_8));
form.write(("--" + boundary + "\r\nContent-Disposition: form-data; name=\"file\"; filename=\"attachment.pdf\"\r\nContent-Type: application/octet-stream\r\n\r\n").getBytes(StandardCharsets.UTF_8));
form.write(Files.readAllBytes(Path.of("attachment.pdf")));
form.write("\r\n".getBytes(StandardCharsets.UTF_8));
form.write(("--" + boundary + "--\r\n").getBytes(StandardCharsets.UTF_8));
request.header("Content-Type", "multipart/form-data; boundary=" + boundary);
HttpResponse<byte[]> response = HttpClient.newHttpClient().send(request.method("POST", HttpRequest.BodyPublishers.ofByteArray(form.toByteArray())).build(), HttpResponse.BodyHandlers.ofByteArray());
if (response.statusCode() != 200) throw new RuntimeException(new String(response.body(), StandardCharsets.UTF_8));
System.out.println(new String(response.body(), StandardCharsets.UTF_8));
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/events/booth_services/attachments');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
CURLOPT_POSTFIELDS => [
'booth_service_id' => '12345',
'file' => new CURLFile('attachment.pdf', 'application/octet-stream', 'attachment.pdf'),
],
]);
$response = curl_exec($curl);
if ($response === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status !== 200) throw new RuntimeException($response);
echo $response;
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/events/booth_services/attachments')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
files = []
begin
parts = [
['booth_service_id', '12345'],
['file', (files << File.open('attachment.pdf', 'rb')).last, {filename: 'attachment.pdf', content_type: 'application/octet-stream'}],
]
request.set_form(parts, 'multipart/form-data')
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
raise response.body unless response.code == '200'
puts response.body
ensure
files.each(&:close)
end
package main
import (
"fmt"
"io"
"log"
"net/http"
"os"
"bytes"
"mime/multipart"
"net/textproto"
)
func main() {
var form bytes.Buffer
writer := multipart.NewWriter(&form)
if err := writer.WriteField("booth_service_id", "12345"); err != nil { log.Fatal(err) }
header0 := textproto.MIMEHeader{}
header0.Set("Content-Disposition", "form-data; name=\"file\"; filename=\"attachment.pdf\"")
header0.Set("Content-Type", "application/octet-stream")
part0, err := writer.CreatePart(header0)
if err != nil { log.Fatal(err) }
file0, err := os.Open("attachment.pdf")
if err != nil { log.Fatal(err) }
if _, err = io.Copy(part0, file0); err != nil { log.Fatal(err) }
file0.Close()
if err := writer.Close(); err != nil { log.Fatal(err) }
request, err := http.NewRequest("POST", "https://api.exhibitday.com/v1/events/booth_services/attachments", &form)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
request.Header.Set("Content-Type", writer.FormDataContentType())
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
if response.StatusCode != 200 { log.Fatalf("%d %s", response.StatusCode, data) }
fmt.Printf("%s\n", data)
}
Example response
{
"records_found": 1,
"total_records": 1,
"has_more": false,
"list_type": "attachment",
"list_data": [
{
"id": 12345,
"filename": "attachment.pdf",
"attachment_created_timestamp": "2027-01-30T12:00:00Z"
}
]
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "This Idempotency-Key was already used with a different request. Use a new key for a new request.",
"error_code": "idempotency_key_reused",
"errors": [
"This Idempotency-Key was already used with a different request. Use a new key for a new request."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is locked on this Event. Unlock it in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Booth Service not found. Invalid Booth Service ID: 12345.",
"error_code": "not_found",
"errors": [
"Booth Service not found. Invalid Booth Service ID: 12345."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A request with this Idempotency-Key is still being processed. Retry after a moment.",
"error_code": "idempotency_key_in_use",
"errors": [
"A request with this Idempotency-Key is still being processed. Retry after a moment."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"A previous request with this Idempotency-Key did not finish and its outcome is unknown, so this retry was not run to avoid creating a duplicate. Check whether the earlier request succeeded; to try again, use a new Idempotency-Key."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The saved response cannot be replayed safely.",
"error_code": "idempotency_key_indeterminate",
"errors": [
"The earlier request with this Idempotency-Key completed, but its saved response cannot be returned safely. This retry was not run and its key was not released. Look for the existing record with a GET; use a new Idempotency-Key only after checking whether another create is needed."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The attachment state changed or the invoice slot is occupied. Retrieve its current state before retrying.",
"error_code": "record_changed",
"errors": [
"The attachment state changed or the invoice slot is occupied. Retrieve its current state before retrying."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Remove a Booth Service General File Attachment #
|
Deletes a General File Attachment from a Booth Service.
Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the File Attachment.
|
Use the id from the attachment list. The API finds the record the file belongs to, so no record ID is sent. An Invoice Attachment is not selected by this method.
|
Good to know
Removes one General File Attachment from this Booth Service. Other attached files and the record's details stay in place.
After the removal
Only the selected file association is removed. Its physical file is scheduled for cleanup after a confirmed save; cleanup may finish later. Other attached files stay in place.
Send only the file's id; the API finds the record it belongs to. A missing, already removed or unavailable attachment returns HTTP 404 Not Found. Do not send file parts with DELETE.
Access
Current record and file-removal permissions and applicable Event/tab locks must allow this change. Permitted removals remain available on the Free plan.
History and retries
A confirmed file change is recorded in history. expected_revision is not supported by these file methods. DELETE does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current file list before deciding whether to retry; the API does not automatically repeat an uncertain change.
Supporting File Attachments have no PATCH replacement. To replace one, add the new file and remove the old one using their separate requests; each request has its own outcome.
Hidden or locked tab
If the Event's Booth tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.
curl -X DELETE "https://api.exhibitday.com/v1/events/booth_services/attachments?id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services/attachments?" + new URLSearchParams({ "id": "12345" }), {
method: "DELETE",
headers: { "Authorization": "Bearer YOUR_API_KEY" }
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.delete(
"https://api.exhibitday.com/v1/events/booth_services/attachments",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"id": 12345},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.DeleteAsync("https://api.exhibitday.com/v1/events/booth_services/attachments?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/booth_services/attachments?id=12345"))
.header("Authorization", "Bearer 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/booth_services/attachments?id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer 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/booth_services/attachments?id=12345')
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = 'Bearer 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/booth_services/attachments?id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer 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 response
{
"status_code": 200,
"status": "OK",
"message": "Attachment removed.",
"errors": []
}
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is hidden on this Event, so its records can't be added, changed or deleted. Show the tab in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Booth tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Booth tab is locked on this Event. Unlock it in ExhibitDay before trying again."
],
"error_params": [
"event_id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Attachment not found. Use an Attachment ID from GET /v1/events/booth_services/attachments.",
"error_code": "not_found",
"errors": [
"Attachment not found. Use an Attachment ID from GET /v1/events/booth_services/attachments."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The attachment state changed or the invoice slot is occupied. Retrieve its current state before retrying.",
"error_code": "record_changed",
"errors": [
"The attachment state changed or the invoice slot is occupied. Retrieve its current state before retrying."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
Download a Booth Service General File Attachment #
|
Downloads a General File Attachment from a Booth Service.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the File Attachment.
|
Use the id from the attachment list. The API finds the record the file belongs to, so no record ID is sent. An Invoice Attachment is not selected by this method.
|
Good to know
Downloads one original General File Attachment from this Booth Service. Select the file using its ID from the attachment list.
Download response
A successful response contains the original uploaded file with a safe download filename. API errors use the usual JSON response. A missing or unavailable file returns HTTP 404.
Send only the file's id from the attachment list to download that one file; the API finds the record it belongs to. The download leaves the record unchanged.
Access
The record's Event and tab must be available, and the tab must not be hidden. A locked tab can still be read.
Files still being copied
If this file is still being copied, the download returns HTTP 409 with file_copy_pending. Try the download again in a few minutes.
Hidden tab
If the Event's Booth tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X GET "https://api.exhibitday.com/v1/events/booth_services/attachments/download?id=12345" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
mv response-body.tmp 'attachment.pdf'
// Node.js 18+; use a local file only for a declared multipart operation.
import { readFile, writeFile } from 'node:fs/promises';
const response = await fetch("https://api.exhibitday.com/v1/events/booth_services/attachments/download?id=12345", { method: "GET", headers: { Authorization: 'Bearer YOUR_API_KEY' } });
if (response.status !== 200) throw new Error(`${response.status}: ${await response.text()}`);
await writeFile("attachment.pdf", new Uint8Array(await response.arrayBuffer()));
import requests
import json
response = requests.request("GET", "https://api.exhibitday.com/v1/events/booth_services/attachments/download?id=12345", headers={'Authorization': 'Bearer YOUR_API_KEY'}, timeout=30)
if response.status_code != 200:
raise RuntimeError(f'{response.status_code}: {response.text}')
with open("attachment.pdf", 'wb') as destination:
destination.write(response.content)
using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.exhibitday.com/v1/events/booth_services/attachments/download?id=12345");
using var response = await client.SendAsync(request);
if ((int)response.StatusCode != 200) throw new Exception(await response.Content.ReadAsStringAsync());
await File.WriteAllBytesAsync("attachment.pdf", await response.Content.ReadAsByteArrayAsync());
import java.net.URI;
import java.net.http.*;
import java.nio.file.*;
import java.nio.charset.StandardCharsets;
import java.io.ByteArrayOutputStream;
import java.util.UUID;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpRequest.Builder request = HttpRequest.newBuilder(URI.create("https://api.exhibitday.com/v1/events/booth_services/attachments/download?id=12345")).header("Authorization", "Bearer YOUR_API_KEY");
HttpResponse<byte[]> response = HttpClient.newHttpClient().send(request.method("GET", HttpRequest.BodyPublishers.noBody()).build(), HttpResponse.BodyHandlers.ofByteArray());
if (response.statusCode() != 200) throw new RuntimeException(new String(response.body(), StandardCharsets.UTF_8));
Files.write(Path.of("attachment.pdf"), response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/events/booth_services/attachments/download?id=12345');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
]);
$response = curl_exec($curl);
if ($response === false) throw new RuntimeException(curl_error($curl));
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);
if ($status !== 200) throw new RuntimeException($response);
file_put_contents('attachment.pdf', $response);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/events/booth_services/attachments/download?id=12345')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') { |http| http.request(request) }
raise response.body unless response.code == '200'
File.binwrite('attachment.pdf', response.body)
package main
import (
"fmt"
"io"
"log"
"net/http"
"os"
)
func main() {
request, err := http.NewRequest("GET", "https://api.exhibitday.com/v1/events/booth_services/attachments/download?id=12345", nil)
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
data, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
if response.StatusCode != 200 { log.Fatalf("%d %s", response.StatusCode, data) }
if err := os.WriteFile("attachment.pdf", data, 0600); err != nil { log.Fatal(err) }
fmt.Println("File saved")
}
Example response
Content type: application/octet-stream
{
"status_code": 400,
"status": "Bad Request",
"message": "HTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "No API key was provided. Send your key in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "missing_api_key",
"errors": [
"Copy the key from Workspace Settings > API & Integrations > API Access in ExhibitDay."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "The API key is not valid. Check that you copied the whole key from Workspace Settings > API & Integrations > API Access, then send it in the Authorization header as 'Bearer YOUR_API_KEY'. Alternatively, you can use the api_key parameter.",
"error_code": "invalid_api_key",
"errors": [
"Check that you sent the whole key. If it was regenerated, use the current key from Workspace Settings > API & Integrations > API Access."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 401,
"status": "Unauthorized",
"message": "Access to the ExhibitDay API is not enabled for your workspace. Please contact support@exhibitday.com to enable API Access. Once access is enabled, send your key in the Authorization header as 'Bearer YOUR_API_KEY'.",
"error_code": "api_access_disabled",
"errors": [
"Nothing was read or changed."
],
"error_params": [
"api_key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "File not found.",
"error_code": "not_found",
"errors": [
"File not found."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This file is still being copied. Try again in a few minutes.",
"error_code": "file_copy_pending",
"errors": [
"This file is still being copied. Try again in a few minutes."
],
"error_params": [
"file"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 429,
"status": "Too Many Requests",
"message": "Error 429 - Too Many Requests",
"error_code": "rate_limited",
"errors": [
"Error 429 - Too Many Requests"
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"An unexpected error occurred. Please try again later."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 500,
"status": "Unexpected Internal Error",
"message": "An unexpected error occurred. Please try again later.",
"error_code": "internal_error",
"errors": [
"Check whether your change was saved before trying again."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}