Playbook
Retrieve a Single Playbook Activity by ID #
|
Sample Object
|
Retrieves a single Playbook activity by its ID.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the Playbook activity.
|
|
| $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 record unavailable in this event, return HTTP 200 with {} (or [] in array format). Current-key failures, a record that changes while it is read and unexpected errors keep their normal error status.
|
Good to know
Retrieves one Playbook activity, including its schedule, details and tagged people. Costs and invoices use their separate methods.
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/playbook_activities/info?id=34567" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activities/info?" + new URLSearchParams({ "id": "34567" }), {
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/playbook_activities/info",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"id": 34567},
)
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/playbook_activities/info?id=34567");
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/playbook_activities/info?id=34567"))
.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/playbook_activities/info?id=34567');
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/playbook_activities/info?id=34567')
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/playbook_activities/info?id=34567", 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": 34567,
"event_id": 23456,
"event_name": "Sample Event",
"title": "Team briefing",
"description": null,
"activity_type_id": 1,
"activity_status_id": 1,
"our_role_id": null,
"day_type_id": 1,
"day_number": 1,
"is_all_day": true,
"start_time": null,
"end_time": null,
"timezone": "",
"location": null,
"tagged_users": [
{
"id": "11111111-2222-4333-8444-555555555555",
"first_name": "Jane",
"last_name": "Smith",
"display_name": "Jane Smith",
"email": "jane@example.invalid",
"type": "user",
"workspace_role": "team_member",
"is_active": true
},
{
"id": "66666666-7777-4888-8999-aaaaaaaaaaaa",
"first_name": "Alex",
"last_name": "Morgan",
"display_name": "Alex Morgan",
"email": "alex@example.invalid",
"type": "user",
"workspace_role": "team_member",
"is_active": true
}
],
"created_by": {
"id": "11111111-2222-4333-8444-555555555555",
"first_name": "Jane",
"last_name": "Smith",
"display_name": "Jane Smith",
"email": "jane@example.invalid",
"type": "user",
"workspace_role": "team_member",
"is_active": true
},
"booth_operations": null,
"meeting": null,
"presentation": null,
"networking": null,
"meal_break": null,
"registration": null,
"special_event": null,
"planning": null,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=2&riSub=0&riId=34567",
"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": "Playbook Activity not found. Invalid Playbook Activity ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Activity not found. Invalid Playbook Activity ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The record or its event scope changed. Read its current values and decide whether to retry; this request made no change.",
"error_code": "record_changed",
"errors": [
"The record or its event scope changed. Read its current values and decide whether to retry; this request made no change."
],
"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 Playbook Activities #
|
Retrieves Playbook activities 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.
|
|
| filter_by_tagged_user_ids | String or JSON array | No |
Return records tagged with these users or resources. Send one user ID or an array of user IDs, for example "user-id" or ["user-id","other-user-id"]. Omit, leave blank or send [] for no tagged-user filter. Duplicate IDs collapse. Inactive and deactivated people, and people no longer in this workspace, still match the records they are tagged on; IDs never tagged in this workspace match nothing. Use filter_by_tagged_user_ids_match_type to require at least one or every selected person. This filter combines with the other filters before counting and paging.
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.
|
|
| filter_by_tagged_user_ids_match_type | String | No |
How to match the selected tagged people. Omit or leave blank to return records tagged with at least one selected person (the default), or require every selected person; records can have other tags too. This combines with the other filters before counting and paging. If filter_by_tagged_user_ids has no IDs, this option is ignored and the response includes a warning. Values are case-insensitive.
|
Allowed values:
any | all |
| $limit | Number | No |
The most records to return, as a positive whole number. Omit for all remaining records.
|
|
| $offset | Number | No |
How many records to skip: a whole number of 0 or more; 0 by default.
|
|
| $result_format | String | No |
By default, the response is an object containing
list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
|
Allowed values:
array | wrapped_in_array |
Good to know
Lists Playbook activities in the Events you can read. Use Event and tagged-user filters to narrow the results.
Filtering and paging
Omit filter_by_event_id for all readable Events in your workspace. A supplied Event that is missing or unavailable returns an empty list with a warning. A readable Event with no matching activities returns an empty list without that warning.
Event and tagged-user filters combine with AND before counts and paging. any matches at least one selected person; all requires every selected person and permits extra tags. Inactive and deactivated people, and people no longer in this workspace, still match the activities they are tagged on; IDs never tagged match nothing. Sending filter_by_tagged_user_ids_match_type without IDs is ignored with a warning.
The list is ordered by activity ID. Omit $limit for all remaining matching activities; $offset defaults to 0. Each returned activity carries its own event_id and Event name. Costs are managed through the separate activity-cost methods.
Formatted text in the response
Notes and other rich-text values in the response contain the stored HTML, including encoded characters and line breaks such as <br />.
Events with a hidden Playbook tab
Records on Events whose Playbook 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/playbook_activities" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activities", {
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/playbook_activities",
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/playbook_activities");
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/playbook_activities"))
.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/playbook_activities');
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/playbook_activities')
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/playbook_activities", 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
{
"list_type": "playbook_activity",
"list_data": [
{
"id": 12345,
"event_id": 23456,
"event_name": "Sample Event",
"title": "Team briefing",
"description": null,
"activity_type_id": 1,
"activity_status_id": 1,
"our_role_id": null,
"day_type_id": 1,
"day_number": 1,
"is_all_day": true,
"start_time": null,
"end_time": null,
"timezone": "",
"location": null,
"tagged_users": [
{
"id": "11111111-2222-4333-8444-555555555555",
"first_name": "Jane",
"last_name": "Smith",
"display_name": "Jane Smith",
"email": "jane@example.invalid",
"type": "user",
"workspace_role": "team_member",
"is_active": true
},
{
"id": "66666666-7777-4888-8999-aaaaaaaaaaaa",
"first_name": "Alex",
"last_name": "Morgan",
"display_name": "Alex Morgan",
"email": "alex@example.invalid",
"type": "user",
"workspace_role": "team_member",
"is_active": true
}
],
"created_by": {
"id": "11111111-2222-4333-8444-555555555555",
"first_name": "Jane",
"last_name": "Smith",
"display_name": "Jane Smith",
"email": "jane@example.invalid",
"type": "user",
"workspace_role": "team_member",
"is_active": true
},
"booth_operations": null,
"meeting": null,
"presentation": null,
"networking": null,
"meal_break": null,
"registration": null,
"special_event": null,
"planning": null,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=2&riSub=0&riId=12345"
}
],
"records_found": 1,
"total_records": 1,
"has_more": false
}
{
"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": "filter_by_tagged_user_ids must be one user ID or an array of user IDs. Each ID is text of 1 to 128 characters; numbers, true/false, null, blank values and objects are not IDs. For example, send \"user-id\" or [\"user-id\",\"other-user-id\"].",
"error_code": "invalid_request",
"errors": [
"filter_by_tagged_user_ids must be one user ID or an array of user IDs. Each ID is text of 1 to 128 characters; numbers, true/false, null, blank values and objects are not IDs. For example, send \"user-id\" or [\"user-id\",\"other-user-id\"]."
],
"error_params": [
"filter_by_tagged_user_ids"
],
"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": 409,
"status": "Conflict",
"message": "The record or its event scope changed. Read its current values and decide whether to retry; this request made no change.",
"error_code": "record_changed",
"errors": [
"The record or its event scope changed. Read its current values and decide whether to retry; this request made no change."
],
"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 a Playbook Activity #
|
Adds a Playbook activity to an Event.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| event_id | Number | Yes |
The ID of the Event in your workspace.
|
|
| title | String | Yes |
A short title for the scheduled activity, up to 500 characters. This is required on create and cannot be cleared.
|
max length: 500
|
| day_type_id | Number | Yes |
Where the scheduled day falls relative to the Event. Required when adding an activity; combine it with day_number and choose a day currently available in the Event's Playbook. All Pages is a display choice and cannot be saved.
|
Allowed values:
1 (Event Day) | 2 (Days Before the Event) | 3 (Days After the Event) |
| day_number | Number | Yes |
The positive day number within the selected day type. New activities and day changes must use a day available in this event's Playbook. An existing activity may keep its own older unresolved day while you edit other fields.
|
|
| description | String | No |
Accepts plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| location | String | No |
The activity location, up to 200 characters.
|
max length: 200
|
| timezone | String | No |
The time-zone label displayed beside the activity's times, up to 20 characters. This does not convert the clock readings. All-day activities clear this label.
|
max length: 20
|
| activity_type_id | Number | No |
Use an id from GET /v1/references/playbook_activity_types. The default on create is General — Other (1).
|
|
| activity_status_id | Number | No |
Whether the activity is Confirmed (1), Tentative (2) or Canceled (3). The default on create is Confirmed. This is independent of proposal, registration and payment statuses.
|
|
| our_role_id | Number | No |
Your team's role in the activity. The available choices depend on the activity type. Omit to use that type's default. A supplied role that does not apply, including null, becomes the type's default; types with no role store no role.
|
Allowed values:
1 (Attending; Attending / Participating for Special Event activities) | 2 (Hosting / Organizing) | 3 (Presenting / Participating) |
| is_all_day | Boolean | No |
Use true for an all-day activity, or false for a specific start and end time. The default on create is true. All-day activities have no start time, end time or time zone.
|
Default: true.
|
| start_time | String | No |
A time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. A specific-time activity needs both times. An end before the start is swapped with the start; it does not create an overnight activity.
|
|
| end_time | String | No |
A time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. A specific-time activity needs both times. An end before the start is swapped with the start; it does not create an overnight activity.
|
|
| booth_operations | JSON object/list | No |
The Booth Operations fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| booth_operations.inspection_result_id | integer or null | No | Inspection Result. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Pending) | 2 (Passed) | 3 (Corrections Required) | 4 (Failed) |
| booth_operations.execution_status_id | integer or null | No | Execution Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Completed) | 4 (Blocked) |
| booth_operations.staffing_status_id | integer or null | No | Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Fully Staffed) | 4 (Issue / Blocked) |
| meeting | JSON object/list | No |
The Meeting fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| meeting.meeting_format_id | integer or null | No | Meeting Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (In-Person) | 2 (Virtual) | 3 (Phone) | 4 (Hybrid) |
| presentation | JSON object/list | No |
The Presentation fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| presentation.room_setup_id | integer or null | No | Room Setup. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Theater) | 2 (Classroom) | 3 (Boardroom) | 4 (Panel Table) | 5 (U-Shape) | 6 (Demo Area) | 7 (Other) | 8 (Rounds / Banquet) | 9 (Poster Boards / Stations) |
| presentation.submission_status_id | integer or null | No | Submission Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Draft) | 2 (Not Submitted) | 3 (Submitted) | 4 (Under Review) | 5 (Accepted) | 6 (Rejected) | 7 (Withdrawn) |
| presentation.rehearsal_status_id | integer or null | No | Rehearsal Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Scheduled) | 2 (Scheduled) | 3 (Completed) | 4 (Canceled) |
| presentation.session_format_id | integer or null | No | Session Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (In-Person) | 2 (Virtual) | 3 (Hybrid) |
| networking | JSON object/list | No |
The Networking fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| networking.rsvp_status_id | integer or null | No | RSVP Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 8 (Not Started) | 9 (In Progress) | 10 (Completed) | 11 (Issue / Blocked) |
| networking.access_level_id | integer or null | No | Access Level. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (General Admission) | 2 (Exhibitor) | 3 (Speaker) | 4 (Sponsor) | 5 (VIP) | 7 (Other) | 8 (Staff) | 9 (Press / Media) |
| networking.attendance_priority_id | integer or null | No | Attendance Priority. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Optional) | 2 (Recommended) | 3 (Required) |
| networking.dress_code_id | integer or null | No | Dress Code. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Casual) | 2 (Business Casual) | 3 (Business Formal) | 4 (Cocktail) | 5 (Black Tie) | 6 (Company-Branded Apparel) | 7 (Other) |
| meal_break | JSON object/list | No |
The Meal Break fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| meal_break.purpose_id | integer or null | No | Purpose. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Personal / Routine) | 2 (Team / Internal) | 3 (Customer / Prospect Engagement) | 4 (Partner / Vendor Engagement) | 6 (Other) | 7 (Networking / Relationship Building) | 8 (Working / Planning) | 9 (Hospitality / VIP) | 10 (Celebration / Recognition) |
| meal_break.reservation_status_id | integer or null | No | Reservation Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Required) | 2 (Requested / Pending) | 3 (Confirmed) | 4 (Waitlisted) | 5 (Canceled) | 6 (Not Yet Reserved) |
| meal_break.seating_arrangement_id | integer or null | No | Seating Arrangement. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Private Room) | 2 (Reserved Table) | 3 (Assigned Seating) | 4 (Open Seating) | 5 (Other) |
| registration | JSON object/list | No |
The Registration fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| registration.status_id | integer or null | No | Status. Check-in / Registration offers 6 Not Checked In, 7 Checked In and 12 Issue / Blocked. Other offers 1 Not Started, 2 In Progress, 11 Completed and 12 Issue / Blocked. Send a JSON integer from the current activity type's choices, or JSON null for no choice. Omit this member on PATCH to keep its value. Changing the activity type can clear a status that no longer applies. | Allowed values: 1 (Not Started) | 2 (In Progress) | 6 (Not Checked In) | 7 (Checked In) | 11 (Completed) | 12 (Issue / Blocked) |
| special_event | JSON object/list | No |
The Special Event fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| special_event.staffing_status_id | integer or null | No | Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Fully Staffed) | 4 (Issue / Blocked) |
| special_event.participant_registration_status_id | integer or null | No | Participant Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Started) | 2 (In Progress) | 11 (Completed) | 12 (Issue / Blocked) |
| special_event.participant_waiver_status_id | integer or null | No | Participant Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 2 (In Progress) | 3 (Completed) | 4 (Not Started) | 5 (Issue / Blocked) |
| special_event.waiver_status_id | integer or null | No | Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 2 (In Progress) | 3 (Completed) | 4 (Not Started) | 5 (Issue / Blocked) |
| special_event.registration_status_id | integer or null | No | Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Started) | 2 (In Progress) | 11 (Completed) | 12 (Issue / Blocked) |
| planning | JSON object/list | No |
The Planning fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. Planning contacts are free text; they do not tag users or send notifications. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| tagged_user_ids | JSON object/list | No |
The full list of people tagged in this activity, as an array of unique user IDs from your workspace's active users and resources. Omit it to keep the current people; null or [] removes all tags. Existing tags keep their notification state. Newly tagged people receive the usual assignment notification only when notify_tagged_users is true and their account and email settings allow it. Existing tags keep their notification state.
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.
|
|
| notify_tagged_users | Boolean | No |
Whether newly tagged people may receive the usual assignment email. Omit this option or leave it blank for true. Send false to suppress the new notifications from this request. Existing tags keep their notification state; this option does not resend or cancel earlier notifications. JSON null is refused, even with the ignore-empty option. Delivery still depends on each person's current account, access and email settings.
|
Default: true.
|
| $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
Adds a scheduled activity to an Event's Playbook. The response includes the new activity and its ID.
Creating the activity
Send event_id, title, day_type_id and day_number. The field descriptions below explain the available days, default choices and optional times. Add costs and invoices with the Playbook Cost methods after the activity exists.
Access and locks
Your current API access and the Event's Playbook visibility and lock settings apply.
Sending the request
Use JSON, the query string or form data for values containing commas. Send comma-containing text, related-item lists and detail objects in JSON, query parameters or form fields.
To make a retry safe, send an Idempotency-Key. Resending the same request with the same key returns the saved response instead of adding a second activity.
After the add
Newly tagged people may receive the usual assignment email unless you send notify_tagged_users=false; delivery still depends on their account and email settings.
Confirmed changes appear in activity history; a history-writing failure does not undo the change.
If you can't confirm the result and didn't send an Idempotency-Key, check the Event's Playbook before trying again; the API does not repeat the action automatically.
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 Playbook 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.
Open in ExhibitDay
The created record includes exhibitday_url, the record's page in ExhibitDay. It is the same link that GET /v1/events/playbook_activities/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/playbook_activities" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"event_id\":23456,\"title\":\"Team briefing\",\"day_type_id\":1,\"day_number\":1}"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activities", {
method: "POST",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "event_id": 23456, "title": "Team briefing", "day_type_id": 1, "day_number": 1 })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.post(
"https://api.exhibitday.com/v1/events/playbook_activities",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"event_id": 23456, "title": "Team briefing", "day_type_id": 1, "day_number": 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/playbook_activities",
JsonContent.Create(new { event_id = 23456, title = "Team briefing", day_type_id = 1, day_number = 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/playbook_activities"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"event_id\":23456,\"title\":\"Team briefing\",\"day_type_id\":1,\"day_number\":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/playbook_activities');
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":23456,"title":"Team briefing","day_type_id":1,"day_number":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/playbook_activities')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"event_id":23456,"title":"Team briefing","day_type_id":1,"day_number":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/playbook_activities", strings.NewReader("{\"event_id\":23456,\"title\":\"Team briefing\",\"day_type_id\":1,\"day_number\":1}"))
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
request.Header.Set("Content-Type", "application/json")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"id": 12345,
"event_id": 23456,
"event_name": "Sample Event",
"title": "Team briefing",
"description": null,
"activity_type_id": 1,
"activity_status_id": 1,
"our_role_id": null,
"day_type_id": 1,
"day_number": 1,
"is_all_day": true,
"start_time": null,
"end_time": null,
"timezone": "",
"location": null,
"tagged_users": [],
"created_by": {
"id": null,
"first_name": "ExhibitDay",
"last_name": "API",
"display_name": "ExhibitDay API",
"email": null,
"type": null,
"workspace_role": null,
"is_active": true
},
"booth_operations": null,
"meeting": null,
"presentation": null,
"networking": null,
"meal_break": null,
"registration": null,
"special_event": null,
"planning": null,
"exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=2&riSub=0&riId=12345"
}
{
"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 Playbook 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 Playbook 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 record or its event scope changed. Read its current values and decide whether to retry; this request made no change.",
"error_code": "record_changed",
"errors": [
"The record or its event scope changed. Read its current values and decide whether to retry; this request made no change."
],
"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 Playbook Activity #
|
Updates an existing Playbook activity.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the Playbook activity in that event. Use its ID from the activity list, Info or Create response.
|
|
| title | String | No |
A short title for the scheduled activity, up to 500 characters. This is required on create and cannot be cleared.
|
max length: 500
|
| description | String | No |
Accepts plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
|
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| location | String | No |
The activity location, up to 200 characters.
|
max length: 200
|
| timezone | String | No |
The time-zone label displayed beside the activity's times, up to 20 characters. This does not convert the clock readings. All-day activities clear this label.
|
max length: 20
|
| activity_type_id | Number | No |
Use an id from GET /v1/references/playbook_activity_types. The default on create is General — Other (1).
|
|
| activity_status_id | Number | No |
Whether the activity is Confirmed (1), Tentative (2) or Canceled (3). The default on create is Confirmed. This is independent of proposal, registration and payment statuses.
|
|
| our_role_id | Number | No |
Your team's role in the activity. The available choices depend on the activity type. Omit or leave blank to keep it unless the activity type changes. A supplied role that does not apply, including null, becomes the type's default; types with no role store no role.
|
Allowed values:
1 (Attending; Attending / Participating for Special Event activities) | 2 (Hosting / Organizing) | 3 (Presenting / Participating) |
| day_type_id | Number | No |
Where the scheduled day falls relative to the Event. Combine it with day_number and choose a day currently available in the Event's Playbook. Omit or leave blank to keep it; null cannot clear it. An unchanged older unresolved day may remain while editing other fields. All Pages is a display choice and cannot be saved.
|
Allowed values:
1 (Event Day) | 2 (Days Before the Event) | 3 (Days After the Event) |
| day_number | Number | No |
The positive day number within the selected day type. New activities and day changes must use a day available in this event's Playbook. An existing activity may keep its own older unresolved day while you edit other fields.
|
|
| is_all_day | Boolean | No |
Use true for an all-day activity, or false for a specific start and end time. The default on create is true. All-day activities have no start time, end time or time zone.
|
Default: true.
|
| start_time | String | No |
A time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. A specific-time activity needs both times. An end before the start is swapped with the start; it does not create an overnight activity.
|
|
| end_time | String | No |
A time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. A specific-time activity needs both times. An end before the start is swapped with the start; it does not create an overnight activity.
|
|
| booth_operations | JSON object/list | No |
The Booth Operations fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| booth_operations.inspection_result_id | integer or null | No | Inspection Result. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Pending) | 2 (Passed) | 3 (Corrections Required) | 4 (Failed) |
| booth_operations.execution_status_id | integer or null | No | Execution Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Completed) | 4 (Blocked) |
| booth_operations.staffing_status_id | integer or null | No | Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Fully Staffed) | 4 (Issue / Blocked) |
| meeting | JSON object/list | No |
The Meeting fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| meeting.meeting_format_id | integer or null | No | Meeting Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (In-Person) | 2 (Virtual) | 3 (Phone) | 4 (Hybrid) |
| presentation | JSON object/list | No |
The Presentation fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| presentation.room_setup_id | integer or null | No | Room Setup. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Theater) | 2 (Classroom) | 3 (Boardroom) | 4 (Panel Table) | 5 (U-Shape) | 6 (Demo Area) | 7 (Other) | 8 (Rounds / Banquet) | 9 (Poster Boards / Stations) |
| presentation.submission_status_id | integer or null | No | Submission Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Draft) | 2 (Not Submitted) | 3 (Submitted) | 4 (Under Review) | 5 (Accepted) | 6 (Rejected) | 7 (Withdrawn) |
| presentation.rehearsal_status_id | integer or null | No | Rehearsal Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Scheduled) | 2 (Scheduled) | 3 (Completed) | 4 (Canceled) |
| presentation.session_format_id | integer or null | No | Session Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (In-Person) | 2 (Virtual) | 3 (Hybrid) |
| networking | JSON object/list | No |
The Networking fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| networking.rsvp_status_id | integer or null | No | RSVP Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 8 (Not Started) | 9 (In Progress) | 10 (Completed) | 11 (Issue / Blocked) |
| networking.access_level_id | integer or null | No | Access Level. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (General Admission) | 2 (Exhibitor) | 3 (Speaker) | 4 (Sponsor) | 5 (VIP) | 7 (Other) | 8 (Staff) | 9 (Press / Media) |
| networking.attendance_priority_id | integer or null | No | Attendance Priority. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Optional) | 2 (Recommended) | 3 (Required) |
| networking.dress_code_id | integer or null | No | Dress Code. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Casual) | 2 (Business Casual) | 3 (Business Formal) | 4 (Cocktail) | 5 (Black Tie) | 6 (Company-Branded Apparel) | 7 (Other) |
| meal_break | JSON object/list | No |
The Meal Break fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| meal_break.purpose_id | integer or null | No | Purpose. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Personal / Routine) | 2 (Team / Internal) | 3 (Customer / Prospect Engagement) | 4 (Partner / Vendor Engagement) | 6 (Other) | 7 (Networking / Relationship Building) | 8 (Working / Planning) | 9 (Hospitality / VIP) | 10 (Celebration / Recognition) |
| meal_break.reservation_status_id | integer or null | No | Reservation Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Required) | 2 (Requested / Pending) | 3 (Confirmed) | 4 (Waitlisted) | 5 (Canceled) | 6 (Not Yet Reserved) |
| meal_break.seating_arrangement_id | integer or null | No | Seating Arrangement. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Private Room) | 2 (Reserved Table) | 3 (Assigned Seating) | 4 (Open Seating) | 5 (Other) |
| registration | JSON object/list | No |
The Registration fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| registration.status_id | integer or null | No | Status. Check-in / Registration offers 6 Not Checked In, 7 Checked In and 12 Issue / Blocked. Other offers 1 Not Started, 2 In Progress, 11 Completed and 12 Issue / Blocked. Send a JSON integer from the current activity type's choices, or JSON null for no choice. Omit this member on PATCH to keep its value. Changing the activity type can clear a status that no longer applies. | Allowed values: 1 (Not Started) | 2 (In Progress) | 6 (Not Checked In) | 7 (Checked In) | 11 (Completed) | 12 (Issue / Blocked) |
| special_event | JSON object/list | No |
The Special Event fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| special_event.staffing_status_id | integer or null | No | Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Fully Staffed) | 4 (Issue / Blocked) |
| special_event.participant_registration_status_id | integer or null | No | Participant Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Started) | 2 (In Progress) | 11 (Completed) | 12 (Issue / Blocked) |
| special_event.participant_waiver_status_id | integer or null | No | Participant Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 2 (In Progress) | 3 (Completed) | 4 (Not Started) | 5 (Issue / Blocked) |
| special_event.waiver_status_id | integer or null | No | Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 2 (In Progress) | 3 (Completed) | 4 (Not Started) | 5 (Issue / Blocked) |
| special_event.registration_status_id | integer or null | No | Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. | Allowed values: 1 (Not Started) | 2 (In Progress) | 11 (Completed) | 12 (Issue / Blocked) |
| planning | JSON object/list | No |
The Planning fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. Planning contacts are free text; they do not tag users or send notifications. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
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.
|
|
| tagged_user_ids | JSON object/list | No |
The full list of people tagged in this activity, as an array of unique user IDs from your workspace's active users and resources. Omit it to keep the current people; null or [] removes all tags. Existing tags keep their notification state. Newly tagged people receive the usual assignment notification only when notify_tagged_users is true and their account and email settings allow it. Existing tags keep their notification state.
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.
|
|
| notify_tagged_users | Boolean | No |
Whether newly tagged people may receive the usual assignment email. Omit this option or leave it blank for true. Send false to suppress the new notifications from this request. Existing tags keep their notification state; this option does not resend or cancel earlier notifications. JSON null is refused, even with the ignore-empty option. Delivery still depends on each person's current account, access and email settings.
|
Default: true.
|
| 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
Updates the fields you choose on an existing Playbook activity. Omitted fields keep their current values.
Choosing what to change
Send only what you want to change. Omitted or blank whole parameters keep their values; null clears only fields that allow it. With $ignore_params_with_empty_values=true, a whole JSON-null parameter is ignored, while the text "null" still requests clearing.
An activity cannot move to another Event. Its type and your team's role decide which details apply; see each field below for its rules.
Access and locks
Your current API access and the Event's Playbook visibility and lock settings apply.
Sending the request
Use JSON, the query string or form data for values containing commas. Send comma-containing text, related-item lists and detail objects in JSON, query parameters or form fields. This method ignores Idempotency-Key.
After the update
An unchanged PATCH writes no data, timestamp or history.
Newly tagged people may receive the usual assignment email unless you send notify_tagged_users=false; delivery still depends on their account and email settings.
Confirmed changes appear in activity history; a history-writing failure does not undo the change.
If a save result cannot be confirmed, review the record before trying again; the API does not repeat the action automatically.
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 Playbook 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/playbook_activities" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":34567,\"description\":\"Updated description\"}"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activities", {
method: "PATCH",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "id": 34567, "description": "Updated description" })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.patch(
"https://api.exhibitday.com/v1/events/playbook_activities",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"id": 34567, "description": "Updated description"},
)
print(response.status_code, response.json())
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Net.Http.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
var response = await client.PatchAsync("https://api.exhibitday.com/v1/events/playbook_activities",
JsonContent.Create(new { id = 34567, description = "Updated description" }));
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class ExhibitDayExample {
public static void main(String[] args) throws Exception {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.exhibitday.com/v1/events/playbook_activities"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\"id\":34567,\"description\":\"Updated description\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}
<?php
$curl = curl_init('https://api.exhibitday.com/v1/events/playbook_activities');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"id":34567,"description":"Updated description"}',
]);
$response = curl_exec($curl);
if ($response === false) {
throw new RuntimeException(curl_error($curl));
}
echo curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL . $response;
curl_close($curl);
require 'net/http'
require 'uri'
uri = URI('https://api.exhibitday.com/v1/events/playbook_activities')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"id":34567,"description":"Updated description"}'
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"
package main
import (
"fmt"
"io"
"log"
"net/http"
"strings"
)
func main() {
request, err := http.NewRequest("PATCH", "https://api.exhibitday.com/v1/events/playbook_activities", strings.NewReader("{\"id\":34567,\"description\":\"Updated description\"}"))
if err != nil { log.Fatal(err) }
request.Header.Set("Authorization", "Bearer YOUR_API_KEY")
request.Header.Set("Content-Type", "application/json")
response, err := (&http.Client{}).Do(request)
if err != nil { log.Fatal(err) }
defer response.Body.Close()
body, err := io.ReadAll(response.Body)
if err != nil { log.Fatal(err) }
fmt.Printf("%d %s\n", response.StatusCode, body)
}
Example response
{
"status_code": 200,
"status": "OK",
"message": "Playbook activity 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 Playbook 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 Playbook 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": "Playbook Activity not found. Invalid Playbook Activity ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Activity not found. Invalid Playbook Activity ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Playbook Activity not found. Invalid Playbook Activity ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Activity not found. Invalid Playbook Activity ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This record changed since you read it. Nothing was changed.",
"error_code": "record_changed",
"errors": [
"This record changed since you read it. Nothing was changed."
],
"error_params": [
"expected_revision"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The record or its event scope changed. Read its current values and decide whether to retry; this request made no change.",
"error_code": "record_changed",
"errors": [
"The record or its event scope changed. Read its current values and decide whether to retry; this request made no change."
],
"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 Playbook Activity #
|
Deletes an existing Playbook activity.
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 Playbook activity in that event. Use its ID from the activity list, Info or Create response.
|
What is removed
Deleting the activity also removes its details, tagged people, costs, related-item links and attachment records. Only this activity's own files are scheduled for cleanup.
Access and locks
Your current API access and the Event's Playbook visibility and lock settings apply.
Sending the request
Use JSON, the query string or form data for values containing commas. This method ignores Idempotency-Key.
After the deletion
The deletion appears in the Event's Playbook history; a history-writing failure does not undo it.
If you can't confirm the deletion, retrieve the activity before trying again; the API does not repeat the action automatically.
Hidden or locked tab
If the Event's Playbook 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/playbook_activities?id=34567" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activities?" + new URLSearchParams({ "id": "34567" }), {
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/playbook_activities",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"id": 34567},
)
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/playbook_activities?id=34567");
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/playbook_activities?id=34567"))
.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/playbook_activities?id=34567');
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/playbook_activities?id=34567')
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/playbook_activities?id=34567", 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": "Playbook activity 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 Playbook 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 Playbook 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": "Playbook Activity not found. Invalid Playbook Activity ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Activity not found. Invalid Playbook Activity ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Playbook Activity not found. Invalid Playbook Activity ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Activity not found. Invalid Playbook Activity ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The record or its event scope changed. Read its current values and decide whether to retry; this request made no change.",
"error_code": "record_changed",
"errors": [
"The record or its event scope changed. Read its current values and decide whether to retry; this request made no change."
],
"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 a Single Playbook Cost by ID #
|
Retrieves a single Playbook cost by its ID.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the Playbook cost.
|
|
| $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 record unavailable in this event, return HTTP 200 with {} (or [] in array format). Current-key failures, a record that changes while it is read and unexpected errors keep their normal error status.
|
Good to know
The response includes amounts, payment details and invoice metadata.
Invoice attachment
The response includes invoice_attachment immediately after payment_notes, without a hydration option. It contains the invoice attachment ID, original file name and added time, or null when no invoice is attached. Use the invoice download method for its contents.
An inconsistent saved invoice reference returns HTTP409 rather than being shown as an empty slot. Invoice attachments are separate from the parent record's edit revision.
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 />.
curl -X GET "https://api.exhibitday.com/v1/events/playbook_activity_costs/info?id=34567" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activity_costs/info?" + new URLSearchParams({ "id": "34567" }), {
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/playbook_activity_costs/info",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"id": 34567},
)
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/playbook_activity_costs/info?id=34567");
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/playbook_activity_costs/info?id=34567"))
.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/playbook_activity_costs/info?id=34567');
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/playbook_activity_costs/info?id=34567')
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/playbook_activity_costs/info?id=34567", 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": 34567,
"event_id": 23456,
"event_name": "Sample Event",
"playbook_activity_id": 12345,
"description": "Meeting room booking",
"vendor_payee": null,
"reference_number": null,
"expense_date": null,
"notes": null,
"payment_status_id": 0,
"payment_status": {
"id": 0,
"name": "N/A"
},
"payment_due_date": null,
"next_payment_due_date": null,
"payment_notes": null,
"invoice_attachment": {
"id": 1004567,
"filename": "activity-cost-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
}
]
}
}
{
"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": "Playbook Cost not found. Invalid Playbook Cost ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Cost not found. Invalid Playbook Cost 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 record or its event scope changed. Read its current values and decide whether to retry; this request made no change.",
"error_code": "record_changed",
"errors": [
"The record or its event scope changed. Read its current values and decide whether to retry; this request made no change."
],
"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 Playbook Costs #
|
Retrieves all costs for a Playbook activity.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| filter_by_event_id | Number | Yes |
The ID of the Event whose Playbook costs to list. Every cost of every activity in that Event is returned unless filter_by_playbook_activity_id is also sent.
|
|
| filter_by_playbook_activity_id | Number | No |
Optional: only list the costs of this Playbook activity in that Event.
|
|
| $limit | Number | No |
The most records to return, as a positive whole number. Omit for all remaining records.
|
|
| $offset | Number | No |
How many records to skip: a whole number of 0 or more; 0 by default.
|
|
| $result_format | String | No |
By default, the response is an object containing
list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
|
Allowed values:
array | wrapped_in_array |
Good to know
The response includes amounts, payment details and invoice metadata.
Invoice attachment
The response includes invoice_attachment immediately after payment_notes, without a hydration option. It contains the invoice attachment ID, original file name and added time, or null when no invoice is attached. Use the invoice download method for its contents.
An inconsistent saved invoice reference returns HTTP409 rather than being shown as an empty slot. Invoice attachments are separate from the parent record's edit revision.
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 />.
curl -X GET "https://api.exhibitday.com/v1/events/playbook_activity_costs?filter_by_event_id=23456" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activity_costs?" + new URLSearchParams({ "filter_by_event_id": "23456" }), {
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/playbook_activity_costs",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"filter_by_event_id": 23456},
)
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/playbook_activity_costs?filter_by_event_id=23456");
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/playbook_activity_costs?filter_by_event_id=23456"))
.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/playbook_activity_costs?filter_by_event_id=23456');
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/playbook_activity_costs?filter_by_event_id=23456')
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/playbook_activity_costs?filter_by_event_id=23456", 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
{
"list_type": "playbook_activity_cost",
"list_data": [
{
"id": 34567,
"event_id": 23456,
"event_name": "Sample Event",
"playbook_activity_id": 12345,
"description": "Meeting room booking",
"vendor_payee": null,
"reference_number": null,
"expense_date": null,
"notes": null,
"payment_status_id": 0,
"payment_status": {
"id": 0,
"name": "N/A"
},
"payment_due_date": null,
"next_payment_due_date": null,
"payment_notes": null,
"invoice_attachment": {
"id": 1004567,
"filename": "activity-cost-invoice.pdf",
"attachment_created_timestamp": "2027-01-30T12:00:00Z"
},
"cost": {
"amount": 0.00,
"cost_center_breakdown": []
}
}
],
"records_found": 1,
"total_records": 1,
"has_more": false
}
{
"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": "Playbook Activity not found. Invalid Playbook Activity ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Activity not found. Invalid Playbook Activity ID: 12345."
],
"error_params": [
"playbook_activity_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 record or its event scope changed. Read its current values and decide whether to retry; this request made no change.",
"error_code": "record_changed",
"errors": [
"The record or its event scope changed. Read its current values and decide whether to retry; this request made no change."
],
"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 a Playbook Cost #
|
Adds a cost to a Playbook activity.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| playbook_activity_id | Number | Yes |
The ID of the Playbook activity in that event. Use its ID from the activity list, Info or Create response.
|
|
| description | String | Yes |
A description for this cost, up to 400 characters. This is required on create and cannot be cleared.
|
max length: 400
|
| vendor_payee | String | No |
Vendor Payee, up to 200 characters.
|
max length: 200
|
| reference_number | String | No |
Reference Number, up to 200 characters.
|
max length: 200
|
| expense_date | String | No |
A calendar date in YYYY-MM-DD format, without a time or time zone.
|
|
| notes | String | No |
Plain-text Notes, up to 80,000 characters as saved, including formatting and encoded characters. Line breaks are retained. An over-limit value is refused, never shortened. On PATCH, an omitted or blank value keeps the current Notes; null clears them.
|
Max length: 80000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| payment_status_id | Number | No |
The cost's payment status. Omit or send null for N/A. This does not change the recorded amount or attach an invoice.
|
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.
|
|
| next_payment_due_date | Date | No |
A calendar date in YYYY-MM-DD format, without a time or time zone. Applies only when the payment status is Partially Paid. With any other status, supplying either this date or the payment status clears the date.
|
|
| payment_notes | String | No |
Payment Notes, up to 200 characters.
|
max length: 200
|
| 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
Adds a cost to a Playbook activity. The response includes the new cost and its ID.
Creating the cost
Send playbook_activity_id and description. An activity can contain up to 500 costs. Costs cannot move between activities.
Creating this record does not attach an invoice; its invoice attachment metadata is null. Add an invoice using the separate invoice attachment method.
Access and locks
Your current API access and the Event's Playbook visibility and lock settings apply, along with access to activity costs.
Sending the request
Use JSON, the query string or form data for values containing commas. Send comma-containing text and cost-center breakdowns in JSON, query parameters or form fields.
To make a retry safe, send an Idempotency-Key. Resending the same request with the same key returns the saved response instead of adding a second cost.
After the add
This action sends no business email.
Confirmed changes appear in activity history; a history-writing failure does not undo the change.
If you can't confirm the result and didn't send an Idempotency-Key, retrieve the activity's costs before trying again; the API does not repeat the action automatically.
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 Playbook 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 POST "https://api.exhibitday.com/v1/events/playbook_activity_costs" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"playbook_activity_id\":12345,\"description\":\"Meeting room booking\"}"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activity_costs", {
method: "POST",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "playbook_activity_id": 12345, "description": "Meeting room booking" })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.post(
"https://api.exhibitday.com/v1/events/playbook_activity_costs",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"playbook_activity_id": 12345, "description": "Meeting room booking"},
)
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/playbook_activity_costs",
JsonContent.Create(new { playbook_activity_id = 12345, description = "Meeting room booking" }));
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/playbook_activity_costs"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("{\"playbook_activity_id\":12345,\"description\":\"Meeting room booking\"}"))
.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/playbook_activity_costs');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"playbook_activity_id":12345,"description":"Meeting room booking"}',
]);
$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/playbook_activity_costs')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"playbook_activity_id":12345,"description":"Meeting room booking"}'
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/playbook_activity_costs", strings.NewReader("{\"playbook_activity_id\":12345,\"description\":\"Meeting room booking\"}"))
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": 34567,
"event_id": 23456,
"event_name": "Sample Event",
"playbook_activity_id": 12345,
"description": "Meeting room booking",
"vendor_payee": null,
"reference_number": null,
"expense_date": null,
"notes": null,
"payment_status_id": 0,
"payment_status": {
"id": 0,
"name": "N/A"
},
"payment_due_date": null,
"next_payment_due_date": null,
"payment_notes": null,
"invoice_attachment": null,
"cost": {
"amount": 0.00,
"cost_center_breakdown": []
}
}
{
"status_code": 400,
"status": "Bad Request",
"message": "X-HTTP-Method-Override: hTTP method override is not supported.",
"error_code": "invalid_request",
"errors": [
"Send the documented HTTP method directly. X-HTTP-Method-Override cannot change a request's HTTP method."
],
"error_params": [
"X-HTTP-Method-Override"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "This Idempotency-Key was already used with a different request. Use a new key for a new request.",
"error_code": "idempotency_key_reused",
"errors": [
"This Idempotency-Key was already used with a different request. Use a new key for a new request."
],
"error_params": [
"Idempotency-Key"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 400,
"status": "Bad Request",
"message": "The Playbook 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 Playbook 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 record or its event scope changed. Read its current values and decide whether to retry; this request made no change.",
"error_code": "record_changed",
"errors": [
"The record or its event scope changed. Read its current values and decide whether to retry; this request made no change."
],
"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 Playbook Cost #
|
Updates an existing Playbook cost.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| id | Number | Yes |
The ID of the cost in that activity. Use its ID from the cost list, Info or Create response; this is not an invoice or cost-allocation ID.
|
|
| description | String | No |
A description for this cost, up to 400 characters. This is required on create and cannot be cleared.
|
max length: 400
|
| vendor_payee | String | No |
Vendor Payee, up to 200 characters.
|
max length: 200
|
| reference_number | String | No |
Reference Number, up to 200 characters.
|
max length: 200
|
| expense_date | String | No |
A calendar date in YYYY-MM-DD format, without a time or time zone.
|
|
| notes | String | No |
Plain-text Notes, up to 80,000 characters as saved, including formatting and encoded characters. Line breaks are retained. An over-limit value is refused, never shortened. On PATCH, an omitted or blank value keeps the current Notes; null clears them.
|
Max length: 80000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
|
| payment_status_id | Number | No |
The cost's payment status. Omit or leave blank to keep it; null cannot clear it. This does not change the recorded amount or attach an invoice.
|
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.
|
|
| next_payment_due_date | Date | No |
A calendar date in YYYY-MM-DD format, without a time or time zone. Applies only when the payment status is Partially Paid. With any other status, supplying either this date or the payment status clears the date.
|
|
| payment_notes | String | No |
Payment Notes, up to 200 characters.
|
max length: 200
|
| 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
Updates the fields you choose on an existing Playbook cost. Omitted fields keep their current values.
Choosing what to change
Send only what you want to change. Omitted or blank whole parameters keep their values; null clears only fields that allow it. With $ignore_params_with_empty_values=true, a whole JSON-null parameter is ignored, while the text "null" still requests clearing.
A cost cannot move to another activity. Use the cost fields below to change its description, payment details or amounts.
Access and locks
Your current API access and the Event's Playbook visibility and lock settings apply, along with access to activity costs.
Sending the request
Use JSON, the query string or form data for values containing commas. Send comma-containing text and cost-center breakdowns in JSON, query parameters or form fields. This method ignores Idempotency-Key.
After the update
This action sends no business email.
An unchanged PATCH writes no data, timestamp or history.
Confirmed changes appear in activity history; a history-writing failure does not undo the change.
If a save result cannot be confirmed, review the cost before trying again; the API does not repeat the action automatically.
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 Playbook 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/playbook_activity_costs" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":34567,\"description\":\"Meeting room booking\"}"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activity_costs", {
method: "PATCH",
headers: { "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json" },
body: JSON.stringify({ "id": 34567, "description": "Meeting room booking" })
});
const data = await response.json();
console.log(response.status, data);
import requests
response = requests.patch(
"https://api.exhibitday.com/v1/events/playbook_activity_costs",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={"id": 34567, "description": "Meeting room booking"},
)
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/playbook_activity_costs",
JsonContent.Create(new { id = 34567, description = "Meeting room booking" }));
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/playbook_activity_costs"))
.header("Authorization", "Bearer YOUR_API_KEY")
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString("{\"id\":34567,\"description\":\"Meeting room booking\"}"))
.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/playbook_activity_costs');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY', 'Content-Type: application/json'],
CURLOPT_POSTFIELDS => '{"id":34567,"description":"Meeting room booking"}',
]);
$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/playbook_activity_costs')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = '{"id":34567,"description":"Meeting room booking"}'
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/playbook_activity_costs", strings.NewReader("{\"id\":34567,\"description\":\"Meeting room booking\"}"))
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": "Playbook cost 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 Playbook 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 Playbook 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": "Playbook Cost not found. Invalid Playbook Cost ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Cost not found. Invalid Playbook Cost ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Playbook Cost not found. Invalid Playbook Cost ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Cost not found. Invalid Playbook Cost ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "This record changed since you read it. Nothing was changed.",
"error_code": "record_changed",
"errors": [
"This record changed since you read it. Nothing was changed."
],
"error_params": [
"expected_revision"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The record or its event scope changed. Read its current values and decide whether to retry; this request made no change.",
"error_code": "record_changed",
"errors": [
"The record or its event scope changed. Read its current values and decide whether to retry; this request made no change."
],
"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 Playbook Cost #
|
Deletes an existing Playbook cost.
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 cost in that activity. Use its ID from the cost list, Info or Create response; this is not an invoice or cost-allocation ID.
|
Good to know
Permanently deletes one Playbook cost, its cost-center breakdown and its invoice. Other costs on the activity stay as they are.
Access and locks
Your current API access and the Event's Playbook visibility and lock settings apply, along with access to activity costs.
Sending the request
Use JSON, the query string or form data for values containing commas. This method ignores Idempotency-Key.
After the deletion
This action sends no business email.
The deletion appears in activity history; a history-writing failure does not undo it.
If you can't confirm the deletion, retrieve the activity's costs before trying again; the API does not repeat the action automatically.
Hidden or locked tab
If the Event's Playbook 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/playbook_activity_costs?id=34567" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activity_costs?" + new URLSearchParams({ "id": "34567" }), {
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/playbook_activity_costs",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"id": 34567},
)
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/playbook_activity_costs?id=34567");
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/playbook_activity_costs?id=34567"))
.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/playbook_activity_costs?id=34567');
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/playbook_activity_costs?id=34567')
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/playbook_activity_costs?id=34567", 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": "Playbook cost 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 Playbook 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 Playbook 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": "Playbook Cost not found. Invalid Playbook Cost ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Cost not found. Invalid Playbook Cost ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "Playbook Cost not found. Invalid Playbook Cost ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Cost not found. Invalid Playbook Cost ID: 12345."
],
"error_params": [
"id"
],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 409,
"status": "Conflict",
"message": "The record or its event scope changed. Read its current values and decide whether to retry; this request made no change.",
"error_code": "record_changed",
"errors": [
"The record or its event scope changed. Read its current values and decide whether to retry; this request made no change."
],
"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 Playbook Cost Invoice Attachment #
|
Downloads the Invoice Attachment for a Playbook Cost.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| playbook_activity_cost_id | Number | Yes |
The ID of the Playbook cost entry.
|
Use the cost entry's id from Retrieve Playbook Costs (GET /v1/events/playbook_activity_costs), rather than a cost-center allocation ID. Each cost entry has its own Invoice Attachment. The API finds the cost's Playbook activity, so playbook_activity_id is not sent.
|
Good to know
Downloads the original Invoice Attachment for this Playbook Cost. Use this method to retrieve the file itself.
Finding the file
In the web app, this is the invoice control beside the selected Playbook activity's cost entry. 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/playbook_activity_costs/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 Playbook 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/playbook_activity_costs/invoice_attachment/download?playbook_activity_cost_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/playbook_activity_costs/invoice_attachment/download?playbook_activity_cost_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/playbook_activity_costs/invoice_attachment/download?playbook_activity_cost_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/playbook_activity_costs/invoice_attachment/download?playbook_activity_cost_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/playbook_activity_costs/invoice_attachment/download?playbook_activity_cost_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/playbook_activity_costs/invoice_attachment/download?playbook_activity_cost_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/playbook_activity_costs/invoice_attachment/download?playbook_activity_cost_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/playbook_activity_costs/invoice_attachment/download?playbook_activity_cost_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": [],
"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 Playbook Cost Invoice Attachment #
|
Adds an Invoice Attachment to a Playbook Cost.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| playbook_activity_cost_id | Number | Yes |
The ID of the Playbook cost entry.
|
Use the cost entry's id from Retrieve Playbook Costs (GET /v1/events/playbook_activity_costs), rather than a cost-center allocation ID. Each cost entry has its own Invoice Attachment. The API finds the cost's Playbook activity, so playbook_activity_id is not sent.
|
| 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 Playbook Cost. 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 selected Playbook activity's cost entry 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/playbook_activity_costs/info and inspect invoice_attachment before deciding whether to retry.
Hidden or locked tab
If the Event's Playbook 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/playbook_activity_costs/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "playbook_activity_cost_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("playbook_activity_cost_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/playbook_activity_costs/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/playbook_activity_costs/invoice_attachment", headers={'Authorization': 'Bearer YOUR_API_KEY'}, files=files, data={"playbook_activity_cost_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/playbook_activity_costs/invoice_attachment");
var form = new MultipartFormDataContent();
form.Add(new StringContent("12345"), "playbook_activity_cost_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/playbook_activity_costs/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=\"playbook_activity_cost_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/playbook_activity_costs/invoice_attachment');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
CURLOPT_POSTFIELDS => [
'playbook_activity_cost_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/playbook_activity_costs/invoice_attachment')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
files = []
begin
parts = [
['playbook_activity_cost_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("playbook_activity_cost_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/playbook_activity_costs/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 Playbook 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 Playbook 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 Playbook tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Playbook 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": "Playbook Cost not found. Invalid Playbook Cost ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Cost not found. Invalid Playbook Cost 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 Playbook Cost Invoice Attachment #
|
Replaces a Playbook Cost's Invoice Attachment.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| playbook_activity_cost_id | Number | Yes |
The ID of the Playbook cost entry.
|
Use the cost entry's id from Retrieve Playbook Costs (GET /v1/events/playbook_activity_costs), rather than a cost-center allocation ID. Each cost entry has its own Invoice Attachment. The API finds the cost's Playbook activity, so playbook_activity_id is not sent.
|
| 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 Playbook Cost'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/playbook_activity_costs/info and inspect invoice_attachment before deciding whether to retry.
Hidden or locked tab
If the Event's Playbook 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/playbook_activity_costs/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "playbook_activity_cost_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("playbook_activity_cost_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/playbook_activity_costs/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/playbook_activity_costs/invoice_attachment", headers={'Authorization': 'Bearer YOUR_API_KEY'}, files=files, data={"playbook_activity_cost_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/playbook_activity_costs/invoice_attachment");
var form = new MultipartFormDataContent();
form.Add(new StringContent("12345"), "playbook_activity_cost_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/playbook_activity_costs/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=\"playbook_activity_cost_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/playbook_activity_costs/invoice_attachment');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
CURLOPT_POSTFIELDS => [
'playbook_activity_cost_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/playbook_activity_costs/invoice_attachment')
request = Net::HTTP::Patch.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
files = []
begin
parts = [
['playbook_activity_cost_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("playbook_activity_cost_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/playbook_activity_costs/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 Playbook 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 Playbook 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 Playbook tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Playbook 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": "Playbook Cost not found. Invalid Playbook Cost ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Cost not found. Invalid Playbook Cost 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 Playbook Cost Invoice Attachment #
|
Deletes a Playbook Cost'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 |
|---|---|---|---|---|
| playbook_activity_cost_id | Number | Yes |
The ID of the Playbook cost entry.
|
Use the cost entry's id from Retrieve Playbook Costs (GET /v1/events/playbook_activity_costs), rather than a cost-center allocation ID. Each cost entry has its own Invoice Attachment. The API finds the cost's Playbook activity, so playbook_activity_id is not sent.
|
Good to know
Removes this Playbook Cost'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 Playbook Cost 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/playbook_activity_costs/info and inspect invoice_attachment before deciding whether to retry.
Hidden or locked tab
If the Event's Playbook 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/playbook_activity_costs/invoice_attachment?playbook_activity_cost_id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activity_costs/invoice_attachment?" + new URLSearchParams({ "playbook_activity_cost_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/playbook_activity_costs/invoice_attachment",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"playbook_activity_cost_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/playbook_activity_costs/invoice_attachment?playbook_activity_cost_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/playbook_activity_costs/invoice_attachment?playbook_activity_cost_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/playbook_activity_costs/invoice_attachment?playbook_activity_cost_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/playbook_activity_costs/invoice_attachment?playbook_activity_cost_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/playbook_activity_costs/invoice_attachment?playbook_activity_cost_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 Playbook 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 Playbook 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 Playbook tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Playbook 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": "Playbook Cost not found. Invalid Playbook Cost ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Cost not found. Invalid Playbook Cost ID: 12345."
],
"error_params": [],
"request_id": "0123456789abcdef0123456789abcdef"
}
{
"status_code": 404,
"status": "Not Found",
"message": "This Playbook Cost has no invoice to remove.",
"error_code": "not_found",
"errors": [
"This Playbook Cost 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 Playbook Activity General File Attachments #
|
Retrieves the General File Attachments on a Playbook Activity.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| playbook_activity_id | Number | Yes |
The ID of the Playbook activity, from Retrieve Playbook Activities (GET /v1/events/playbook_activities) 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 Playbook Activity. 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
A Playbook activity can have several cost entries, each with its own Invoice Attachment. Those files use the cost-invoice methods; this list contains the activity's General File Attachments.
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 Playbook 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/playbook_activities/attachments?playbook_activity_id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activities/attachments?" + new URLSearchParams({ "playbook_activity_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/playbook_activities/attachments",
headers={"Authorization": "Bearer YOUR_API_KEY"},
params={"playbook_activity_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/playbook_activities/attachments?playbook_activity_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/playbook_activities/attachments?playbook_activity_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/playbook_activities/attachments?playbook_activity_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/playbook_activities/attachments?playbook_activity_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/playbook_activities/attachments?playbook_activity_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": "Playbook Activity not found. Invalid Playbook Activity ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Activity not found. Invalid Playbook Activity 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 Playbook Activity General File Attachments #
|
Adds General File Attachments to a Playbook Activity.
| Name | Type | Required? | Description | Details |
|---|---|---|---|---|
| playbook_activity_id | Number | Yes |
The ID of the Playbook activity, from Retrieve Playbook Activities (GET /v1/events/playbook_activities) 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 Playbook Activity. 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 supporting files to the activity. Use the Playbook Cost Invoice Attachment methods with the cost entry's ID to attach an invoice or receipt to a specific cost. Adding supporting files does not change the activity's costs or payments.
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 Playbook 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/playbook_activities/attachments" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "playbook_activity_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("playbook_activity_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/playbook_activities/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/playbook_activities/attachments", headers={'Authorization': 'Bearer YOUR_API_KEY'}, files=files, data={"playbook_activity_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/playbook_activities/attachments");
var form = new MultipartFormDataContent();
form.Add(new StringContent("12345"), "playbook_activity_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/playbook_activities/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=\"playbook_activity_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/playbook_activities/attachments');
curl_setopt_array($curl, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
CURLOPT_POSTFIELDS => [
'playbook_activity_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/playbook_activities/attachments')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer YOUR_API_KEY'
files = []
begin
parts = [
['playbook_activity_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("playbook_activity_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/playbook_activities/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 Playbook 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 Playbook 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 Playbook tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Playbook 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": "Playbook Activity not found. Invalid Playbook Activity ID: 12345.",
"error_code": "not_found",
"errors": [
"Playbook Activity not found. Invalid Playbook Activity 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 Playbook Activity General File Attachment #
|
Deletes a General File Attachment from a Playbook Activity.
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 Playbook Activity. 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 Playbook 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/playbook_activities/attachments?id=12345" -H "Authorization: Bearer YOUR_API_KEY"
const response = await fetch("https://api.exhibitday.com/v1/events/playbook_activities/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/playbook_activities/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/playbook_activities/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/playbook_activities/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/playbook_activities/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/playbook_activities/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/playbook_activities/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 Playbook 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 Playbook 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 Playbook tab is locked on this Event. Unlock it in ExhibitDay before trying again.",
"error_code": "not_allowed",
"errors": [
"The Playbook 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/playbook_activities/attachments.",
"error_code": "not_found",
"errors": [
"Attachment not found. Use an Attachment ID from GET /v1/events/playbook_activities/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 Playbook Activity General File Attachment #
|
Downloads a General File Attachment from a Playbook Activity.
| 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 Playbook Activity. 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 Playbook 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/playbook_activities/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/playbook_activities/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/playbook_activities/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/playbook_activities/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/playbook_activities/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/playbook_activities/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/playbook_activities/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/playbook_activities/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": [],
"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"
}