Sponsorships
Retrieve a Single Sponsorship by ID #
|
Sample Object
|
Retrieves a single Sponsorship by its ID.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the Sponsorship. Use the id from Retrieve Sponsorships (GET /v1/events/sponsorships) or from the add response; you don't send the Event ID.
|
|
| $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 |
Set to true to include record_revision in the response. Send that value as expected_revision when updating to check for conflicting changes.
|
Default: false.
|
| $on_error_return_empty_result | Boolean | No |
For missing or invalid ids, or a Sponsorship not available in this Event, return HTTP 200 with {} (or [] in array format). API key errors, conflicts with a change in progress and unexpected errors keep their normal error status.
|
Good to know
The response includes details, notes, costs and payment information.
Current Event and access
The Sponsorship's current Event is determined automatically. The request must have access to that Event and its Sponsorships tab.
Record revision
Set $include_record_revision=true to get record_revision, which covers this Sponsorship's editable fields, costs, related-item links and Event binding. Send it as expected_revision with a later update. File Attachment and Invoice Attachment metadata and contents are not covered.
File Attachments
The response includes the Invoice Attachment metadata as invoice_attachment, or null when no invoice is attached. Use the separate File Attachment collection to retrieve ordinary attachment metadata.
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/sponsorships/info?id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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=12345&riType=7&riSub=0&riId=12345",
"event_id": 12345,
"event_name": "Sample Event",
"name": "Welcome reception",
"acquisition_status_id": 1,
"acquisition_status": "Need to Acquire",
"acquire_by_date": null,
"acquired_date": null,
"agreement_confirmation_number": null,
"organizer_provider": null,
"contact_name": null,
"contact_email": null,
"contact_phone": null,
"portal_url": null,
"benefits_inclusions": "",
"coverage_placement_details": "",
"conditions_restrictions": "",
"materials_contributions_required": "",
"submission_delivery_instructions": "",
"key_dates_deadlines": "",
"benefits_received_outstanding": "",
"notes": "",
"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": 382345,
"filename": "sponsorship-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": "Sponsorship not found. Invalid Sponsorship ID: 12345.",
"error_code": "not_found",
"errors": [
"Sponsorship not found. Invalid Sponsorship 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 sponsorship 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 sponsorship 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 Sponsorships #
|
Retrieves Sponsorships 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 Sponsorships to return (a whole number of 1 or more). Leave it out to return all remaining matching records.
|
|
| $offset | Number | No |
How many matching Sponsorships to skip (a whole number of 0 or more; 0 by default). Use this with $limit to read the next page.
|
|
| $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.
Events with a hidden Sponsorships tab
Records on Events whose Sponsorships 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/sponsorships" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/sponsorships", {
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/sponsorships",
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/sponsorships");
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/sponsorships"))
.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/sponsorships');
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/sponsorships')
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/sponsorships", 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": "sponsorship",
"list_data": [
{
"id": 12345,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345&riType=7&riSub=0&riId=12345",
"event_id": 12345,
"event_name": "Sample Event",
"name": "Welcome reception",
"acquisition_status_id": 1,
"acquisition_status": "Need to Acquire",
"acquire_by_date": null,
"acquired_date": null,
"agreement_confirmation_number": null,
"organizer_provider": null,
"contact_name": null,
"contact_email": null,
"contact_phone": null,
"portal_url": null,
"benefits_inclusions": "",
"coverage_placement_details": "",
"conditions_restrictions": "",
"materials_contributions_required": "",
"submission_delivery_instructions": "",
"key_dates_deadlines": "",
"benefits_received_outstanding": "",
"notes": "",
"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": 382345,
"filename": "sponsorship-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 Sponsorship #
|
Adds a Sponsorship to an Event.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| event_id | Number | Yes |
The id of the Event in your workspace to add the Sponsorship to.
|
|
| name | String | Yes |
The Sponsorship name, up to 300 characters. It can't be blank.
|
max length: 300
|
| acquisition_status_id | Number | No |
Whether the Sponsorship still needs to be acquired. Optional when adding a Sponsorship: omitted, blank or null means Need to Acquire. Choosing Need to Acquire clears the acquisition date and agreement or confirmation number, while keeping financial details.
|
Allowed values:
1 (Need to Acquire) | 2 (Already Acquired) |
| notes | String | No |
Send plain text for notes; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| acquire_by_date | String | No |
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and
null clears it. This date applies regardless of acquisition or payment status.
|
|
| payment_status_id | Number | No |
The Sponsorship's payment status. Omit for N/A; null resets it to N/A. A status other than Partially Paid clears the next partial payment due date. Payment status can be recorded for either acquisition status.
|
Allowed values:
0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet) |
| payment_due_date | String | No |
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and
null clears it. This date applies regardless of acquisition or payment status.
|
|
| next_payment_due_date | Date | No |
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and
null clears it. Applies only when the payment status is Partially Paid (payment_status_id=2). With any other status, supplying either this date or the payment status clears the date.
|
|
| payment_notes | String | No |
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 200
|
| acquired_date | String | No |
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and
null clears it. Applies only when the acquisition status is Already Acquired (acquisition_status_id=2). With any other status, supplying this date, the acquisition status or the agreement or confirmation number clears the date.
|
|
| agreement_confirmation_number | String | No |
The agreement or confirmation number, up to 200 characters. This applies only to Already Acquired (acquisition_status_id=2); otherwise it is cleared when the acquisition status, date or agreement information is supplied. On PATCH, an omitted or blank value keeps it; null clears it.
|
max length: 200
|
| organizer_provider | String | No |
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 200
|
| contact_name | String | No |
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 200
|
| contact_email | String | No |
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 200
|
| contact_phone | String | No |
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 200
|
| portal_url | String | No |
Up to 2000 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 2000
|
| benefits_inclusions | String | No |
Send plain text for benefits inclusions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| coverage_placement_details | String | No |
Send plain text for coverage placement details; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| conditions_restrictions | String | No |
Send plain text for conditions restrictions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| materials_contributions_required | String | No |
Send plain text for materials contributions required; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| submission_delivery_instructions | String | No |
Send plain text for submission delivery instructions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| key_dates_deadlines | String | No |
Send plain text for key dates deadlines; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| benefits_received_outstanding | String | No |
Send plain text for benefits received outstanding; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| 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 |
Good to know
These methods manage Sponsorships for an existing Event in your workspace. Supply the Event id and, for an existing Sponsorship, its id; a Sponsorship cannot be moved to another Event. Your current permissions and the Event's hidden or locked tab settings apply. A Sponsorship records what you plan to acquire and whether it has been acquired. Its costs, payment details and Cost Invoice / Receipt are separate: recording a cost does not attach an invoice or mark a payment complete. Deleting a Sponsorship removes its own costs, related-item links and attachment records together, then schedules only its files for physical cleanup. No contact or assignee email is sent. A POST Idempotency-Key must be one value without commas. Send text containing commas and cost lists through JSON, the query string or form fields. A URL may retain its own %2C encoding; other text is not percent-decoded. Optional Idempotency-Key replay applies to POST; PATCH and DELETE retain their existing behavior of ignoring that header. A confirmed change is then added to history; failure to write history does not undo the saved change. An unchanged PATCH writes no data, timestamp or history. Creating this record does not attach an invoice; its invoice attachment metadata is null. Add an invoice using the separate invoice attachment method.
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 Sponsorships 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.
Acquisition status
When adding, acquisition_status_id is optional and defaults to Need to Acquire. The same statuses use different IDs in each family: Sponsorships use 1 for Need to Acquire and 2 for Already Acquired; Giveaways use 10 and 20.
Open in ExhibitDay
The created record includes exhibitday_url, the record's page in ExhibitDay. It is the same link that GET /v1/events/sponsorships/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/sponsorships" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"event_id\":12345,\"name\":\"Welcome reception\",\"acquisition_status_id\":1}"
const response = await fetch("https://api.exhibitday.com/v1/events/sponsorships", {
method: "POST",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "event_id": 12345, "name": "Welcome reception", "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/sponsorships",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"event_id": 12345, "name": "Welcome reception", "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/sponsorships",
JsonContent.Create(new { event_id = 12345, name = "Welcome reception", 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/sponsorships"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"event_id\":12345,\"name\":\"Welcome reception\",\"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/sponsorships');
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,"name":"Welcome reception","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/sponsorships')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"event_id":12345,"name":"Welcome reception","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/sponsorships", strings.NewReader("{\"event_id\":12345,\"name\":\"Welcome reception\",\"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": 23456,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345&riType=7&riSub=0&riId=23456",
"event_id": 12345,
"event_name": "Sample Event",
"name": "Welcome reception",
"acquisition_status_id": 1,
"acquisition_status": "Need to Acquire",
"acquire_by_date": null,
"acquired_date": null,
"agreement_confirmation_number": null,
"organizer_provider": null,
"contact_name": null,
"contact_email": null,
"contact_phone": null,
"portal_url": null,
"benefits_inclusions": "",
"coverage_placement_details": "",
"conditions_restrictions": "",
"materials_contributions_required": "",
"submission_delivery_instructions": "",
"key_dates_deadlines": "",
"benefits_received_outstanding": "",
"notes": "",
"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 Sponsorships 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 Sponsorships 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 sponsorship 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 sponsorship 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 Sponsorship #
|
Updates an existing Sponsorship.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the Sponsorship to update. Use the id from Retrieve Sponsorships (GET /v1/events/sponsorships) or from the add response.
|
|
| name | String | No |
The Sponsorship name, up to 300 characters. Omit or leave blank to keep the current name. The name can't be cleared.
|
max length: 300
|
| acquisition_status_id | Number | No |
Whether the Sponsorship still needs to be acquired. Omit or leave blank to keep it; null is refused. Choosing Need to Acquire clears the acquisition date and agreement or confirmation number, while keeping financial details.
|
Allowed values:
1 (Need to Acquire) | 2 (Already Acquired) |
| notes | String | No |
Send plain text for notes; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| acquire_by_date | String | No |
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and
null clears it. This date applies regardless of acquisition or payment status.
|
|
| payment_status_id | Number | No |
The Sponsorship'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. Payment status can be recorded for either acquisition status.
|
Allowed values:
0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet) |
| payment_due_date | String | No |
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and
null clears it. This date applies regardless of acquisition or payment status.
|
|
| next_payment_due_date | Date | No |
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and
null clears it. Applies only when the payment status is Partially Paid (payment_status_id=2). With any other status, supplying either this date or the payment status clears the date.
|
|
| payment_notes | String | No |
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 200
|
| acquired_date | String | No |
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and
null clears it. Applies only when the acquisition status is Already Acquired (acquisition_status_id=2). With any other status, supplying this date, the acquisition status or the agreement or confirmation number clears the date.
|
|
| agreement_confirmation_number | String | No |
The agreement or confirmation number, up to 200 characters. This applies only to Already Acquired (acquisition_status_id=2); otherwise it is cleared when the acquisition status, date or agreement information is supplied. On PATCH, an omitted or blank value keeps it; null clears it.
|
max length: 200
|
| organizer_provider | String | No |
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 200
|
| contact_name | String | No |
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 200
|
| contact_email | String | No |
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 200
|
| contact_phone | String | No |
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 200
|
| portal_url | String | No |
Up to 2000 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
max length: 2000
|
| benefits_inclusions | String | No |
Send plain text for benefits inclusions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| coverage_placement_details | String | No |
Send plain text for coverage placement details; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| conditions_restrictions | String | No |
Send plain text for conditions restrictions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| materials_contributions_required | String | No |
Send plain text for materials contributions required; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| submission_delivery_instructions | String | No |
Send plain text for submission delivery instructions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| key_dates_deadlines | String | No |
Send plain text for key dates deadlines; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| benefits_received_outstanding | String | No |
Send plain text for benefits received outstanding; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| 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 returned when you retrieved this record. Include it to avoid overwriting someone else's changes. Omit it to skip this check.
|
Good to know
These methods manage Sponsorships for an existing Event in your workspace. Supply the Event id and, for an existing Sponsorship, its id; a Sponsorship cannot be moved to another Event. Your current permissions and the Event's hidden or locked tab settings apply. A Sponsorship records what you plan to acquire and whether it has been acquired. Its costs, payment details and Cost Invoice / Receipt are separate: recording a cost does not attach an invoice or mark a payment complete. Deleting a Sponsorship removes its own costs, related-item links and attachment records together, then schedules only its files for physical cleanup. No contact or assignee email is sent. On PATCH, send only fields you want to change; omitted or blank values keep their current values. null clears a field only when that field supports clearing. If you use $ignore_params_with_empty_values=true, JSON null is ignored, while the text "null" still requests clearing. A POST Idempotency-Key must be one value without commas. Send text containing commas and cost lists through JSON, the query string or form fields. A URL may retain its own %2C encoding; other text is not percent-decoded. Optional Idempotency-Key replay applies to POST; PATCH and DELETE retain their existing behavior of ignoring that header. A confirmed change is then added to history; failure to write history does not undo the saved change. An unchanged PATCH writes no data, timestamp or history.
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 Sponsorships 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 PATCH "https://api.exhibitday.com/v1/events/sponsorships" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"name\":\"Welcome reception\"}"
const response = await fetch("https://api.exhibitday.com/v1/events/sponsorships", {
method: "PATCH",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "id": 12345, "name": "Welcome reception" })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.patch(
"https://api.exhibitday.com/v1/events/sponsorships",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"id": 12345, "name": "Welcome reception"},
)
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/sponsorships",
JsonContent.Create(new { id = 12345, name = "Welcome reception" }));
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/sponsorships"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\"id\":12345,\"name\":\"Welcome reception\"}"))
.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/sponsorships');
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,"name":"Welcome reception"}',
]);
$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/sponsorships')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"id":12345,"name":"Welcome reception"}'
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/sponsorships", strings.NewReader("{\"id\":12345,\"name\":\"Welcome reception\"}"))
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": "Sponsorship 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 Sponsorships 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 Sponsorships 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": "Sponsorship not found. Invalid Sponsorship ID: 12345.",
"error_code": "not_found",
"errors": [
"Sponsorship not found. Invalid Sponsorship ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Sponsorship not found. Invalid Sponsorship ID: 12345.",
"error_code": "not_found",
"errors": [
"Sponsorship not found. Invalid Sponsorship ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This sponsorship changed since you read it; nothing was changed.",
"error_code": "record_changed",
"errors": [
"This sponsorship changed since you read it; nothing was changed."
],
"error_params": [
"expected_revision"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The sponsorship 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 sponsorship 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 Sponsorship #
|
Deletes an existing Sponsorship.
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 Sponsorship to delete. Use the id from Retrieve Sponsorships (GET /v1/events/sponsorships) or from the add response.
|
Good to know
These methods manage Sponsorships for an existing Event in your workspace. Supply the Event id and, for an existing Sponsorship, its id; a Sponsorship cannot be moved to another Event. Your current permissions and the Event's hidden or locked tab settings apply. A Sponsorship records what you plan to acquire and whether it has been acquired. Its costs, payment details and Cost Invoice / Receipt are separate: recording a cost does not attach an invoice or mark a payment complete. Deleting a Sponsorship removes its own costs, related-item links and attachment records together, then schedules only its files for physical cleanup. No contact or assignee email is sent. A POST Idempotency-Key must be one value without commas. Send text containing commas and cost lists through JSON, the query string or form fields. A URL may retain its own %2C encoding; other text is not percent-decoded. Optional Idempotency-Key replay applies to POST; PATCH and DELETE retain their existing behavior of ignoring that header. A confirmed change is then added to history; failure to write history does not undo the saved change. An unchanged PATCH writes no data, timestamp or history.
Hidden or locked tab
If the Event's Sponsorships 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/sponsorships?id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/sponsorships?" + 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/sponsorships",
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/sponsorships?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/sponsorships?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/sponsorships?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/sponsorships?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/sponsorships?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": "Sponsorship 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 Sponsorships 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 Sponsorships 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": "Sponsorship not found. Invalid Sponsorship ID: 12345.",
"error_code": "not_found",
"errors": [
"Sponsorship not found. Invalid Sponsorship ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Sponsorship not found. Invalid Sponsorship ID: 12345.",
"error_code": "not_found",
"errors": [
"Sponsorship not found. Invalid Sponsorship ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The sponsorship 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 sponsorship 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 Sponsorship Invoice Attachment #
|
Downloads the Invoice Attachment for a Sponsorship.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| sponsorship_id | Number | Yes |
The ID of the Sponsorship, from Retrieve Sponsorships (GET /v1/events/sponsorships) or its add response.
|
Good to know
Downloads the original Invoice Attachment for this Sponsorship. Use this method to retrieve the file itself.
Finding the file
In the web app, this is the invoice control beside the Sponsorship's cost and payment details. 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/sponsorships/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 Sponsorships 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/sponsorships/invoice_attachment/download?sponsorship_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/sponsorships/invoice_attachment/download?sponsorship_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/sponsorships/invoice_attachment/download?sponsorship_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/sponsorships/invoice_attachment/download?sponsorship_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/sponsorships/invoice_attachment/download?sponsorship_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/sponsorships/invoice_attachment/download?sponsorship_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/sponsorships/invoice_attachment/download?sponsorship_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/sponsorships/invoice_attachment/download?sponsorship_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 Sponsorship Invoice Attachment #
|
Adds an Invoice Attachment to a Sponsorship.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| sponsorship_id | Number | Yes |
The ID of the Sponsorship, from Retrieve Sponsorships (GET /v1/events/sponsorships) 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 Sponsorship. 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 Sponsorship's cost and payment details 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/sponsorships/info and inspect invoice_attachment before deciding whether to retry.
Hidden or locked tab
If the Event's Sponsorships 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/sponsorships/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "sponsorship_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("sponsorship_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/sponsorships/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/sponsorships/invoice_attachment", headers={'Authorization': 'Bearer YOUR_API_KEY'}, files=files, data={"sponsorship_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/sponsorships/invoice_attachment");
var form = new MultipartFormDataContent();
form.Add(new StringContent("12345"), "sponsorship_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/sponsorships/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=\"sponsorship_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/sponsorships/invoice_attachment');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
CURLOPT_POSTFIELDS => [
'sponsorship_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/sponsorships/invoice_attachment')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
files = []
begin
parts = [
['sponsorship_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("sponsorship_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/sponsorships/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 Sponsorships 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 Sponsorships 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 Sponsorships tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Sponsorships 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": "Sponsorship not found. Invalid Sponsorship ID: 12345.",
"error_code": "not_found",
"errors": [
"Sponsorship not found. Invalid Sponsorship 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 Sponsorship Invoice Attachment #
|
Replaces a Sponsorship's Invoice Attachment.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| sponsorship_id | Number | Yes |
The ID of the Sponsorship, from Retrieve Sponsorships (GET /v1/events/sponsorships) 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 Sponsorship'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/sponsorships/info and inspect invoice_attachment before deciding whether to retry.
Hidden or locked tab
If the Event's Sponsorships 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/sponsorships/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "sponsorship_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("sponsorship_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/sponsorships/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/sponsorships/invoice_attachment", headers={'Authorization': 'Bearer YOUR_API_KEY'}, files=files, data={"sponsorship_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/sponsorships/invoice_attachment");
var form = new MultipartFormDataContent();
form.Add(new StringContent("12345"), "sponsorship_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/sponsorships/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=\"sponsorship_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/sponsorships/invoice_attachment');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
CURLOPT_POSTFIELDS => [
'sponsorship_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/sponsorships/invoice_attachment')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
files = []
begin
parts = [
['sponsorship_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("sponsorship_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/sponsorships/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 Sponsorships 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 Sponsorships 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 Sponsorships tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Sponsorships 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": "Sponsorship not found. Invalid Sponsorship ID: 12345.",
"error_code": "not_found",
"errors": [
"Sponsorship not found. Invalid Sponsorship 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 Sponsorship Invoice Attachment #
|
Deletes a Sponsorship'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 |
|---|---|---|---|---|
| sponsorship_id | Number | Yes |
The ID of the Sponsorship, from Retrieve Sponsorships (GET /v1/events/sponsorships) or its add response.
|
Good to know
Removes this Sponsorship'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 Sponsorship 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/sponsorships/info and inspect invoice_attachment before deciding whether to retry.
Hidden or locked tab
If the Event's Sponsorships 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/sponsorships/invoice_attachment?sponsorship_id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/sponsorships/invoice_attachment?" + new URLSearchParams({ "sponsorship_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/sponsorships/invoice_attachment",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"sponsorship_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/sponsorships/invoice_attachment?sponsorship_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/sponsorships/invoice_attachment?sponsorship_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/sponsorships/invoice_attachment?sponsorship_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/sponsorships/invoice_attachment?sponsorship_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/sponsorships/invoice_attachment?sponsorship_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 Sponsorships 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 Sponsorships 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 Sponsorships tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Sponsorships 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": "Sponsorship not found. Invalid Sponsorship ID: 12345.",
"error_code": "not_found",
"errors": [
"Sponsorship not found. Invalid Sponsorship ID: 12345."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "This Sponsorship has no invoice to remove.",
"error_code": "not_found",
"errors": [
"This Sponsorship 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 Sponsorship General File Attachments #
|
Retrieves the General File Attachments on a Sponsorship.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| sponsorship_id | Number | Yes |
The ID of the Sponsorship, from Retrieve Sponsorships (GET /v1/events/sponsorships) 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 Sponsorship. 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 Sponsorships 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/sponsorships/attachments?sponsorship_id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/sponsorships/attachments?" + new URLSearchParams({ "sponsorship_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/sponsorships/attachments",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"sponsorship_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/sponsorships/attachments?sponsorship_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/sponsorships/attachments?sponsorship_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/sponsorships/attachments?sponsorship_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/sponsorships/attachments?sponsorship_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/sponsorships/attachments?sponsorship_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": "Sponsorship not found. Invalid Sponsorship ID: 12345.",
"error_code": "not_found",
"errors": [
"Sponsorship not found. Invalid Sponsorship 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 Sponsorship General File Attachments #
|
Adds General File Attachments to a Sponsorship.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| sponsorship_id | Number | Yes |
The ID of the Sponsorship, from Retrieve Sponsorships (GET /v1/events/sponsorships) 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 Sponsorship. 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 Sponsorships 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/sponsorships/attachments" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "sponsorship_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("sponsorship_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/sponsorships/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/sponsorships/attachments", headers={'Authorization': 'Bearer YOUR_API_KEY'}, files=files, data={"sponsorship_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/sponsorships/attachments");
var form = new MultipartFormDataContent();
form.Add(new StringContent("12345"), "sponsorship_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/sponsorships/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=\"sponsorship_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/sponsorships/attachments');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
CURLOPT_POSTFIELDS => [
'sponsorship_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/sponsorships/attachments')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
files = []
begin
parts = [
['sponsorship_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("sponsorship_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/sponsorships/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 Sponsorships 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 Sponsorships 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 Sponsorships tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Sponsorships 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": "Sponsorship not found. Invalid Sponsorship ID: 12345.",
"error_code": "not_found",
"errors": [
"Sponsorship not found. Invalid Sponsorship 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 Sponsorship General File Attachment #
|
Deletes a General File Attachment from a Sponsorship.
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 Sponsorship. 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 Sponsorships 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/sponsorships/attachments?id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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 Sponsorships 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 Sponsorships 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 Sponsorships tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Sponsorships 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/sponsorships/attachments.",
"error_code": "not_found",
"errors": [
"Attachment not found. Use an Attachment ID from GET /v1/events/sponsorships/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 Sponsorship General File Attachment #
|
Downloads a General File Attachment from a Sponsorship.
| 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 Sponsorship. 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 Sponsorships 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/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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/sponsorships/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"
}