EventsTravel Reservations

Travel Reservations

Retrieve a Single Travel Reservation by ID #

Method
GET
Endpoint
Sample Object

Retrieves a single Travel Reservation by its ID.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Travel Reservation.
Use the id from Retrieve Travel Reservations (GET /v1/events/travel_reservations) or from the add response. You don't send the Event ID; the record's Event is found automatically.
$result_format String No
By default, the response is a single object. Send array to get it inside a one-item array.
Allowed values: array | object
$include_record_revision Boolean No
Whether to include record_revision in the response.
Default: false. Send true to get record_revision, then send that value as expected_revision when you update this reservation. See What $include_record_revision covers below.
$on_error_return_empty_result Boolean No
Whether an invalid or unavailable reservation should return an empty result.
Default: false. True returns HTTP 200 with {} (or [] for array format) for invalid IDs or an unavailable reservation. API key errors, conflicts with a change in progress, inconsistent invoice information and unexpected errors keep their normal status.
If-None-Match String No
An ETag from an earlier response to this GET.
Optional HTTP header. If the successful response is unchanged, the API returns HTTP 304 with no body.

Good to know

The response includes booking details, tagged people, costs and payment information.

What $include_record_revision covers

Setting $include_record_revision=true returns record_revision for use as expected_revision on a later update.

record_revision covers the saved reservation details, payment fields, cost allocations, tagged-person IDs, related-item links and Event binding. File Attachment or Invoice Attachment metadata/contents and notification delivery state are not included.

Files and access

Invoice Attachment metadata is included as invoice_attachment, or null if no invoice is attached. Supporting File Attachments have their own collection and download operation.

The Event's Travel Reservations tab must be available and readable. A locked tab can still be read. Inconsistent invoice information returns HTTP 409 instead of exposing another record's file.

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.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/events/travel_reservations/info?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "id": 12345,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=9&riSub=0&riId=12345",
  "event_id": 23456,
  "event_name": "Sample Event",
  "reservation_type_id": 1,
  "booking_status_id": null,
  "book_by_date": null,
  "date_booked": null,
  "booking_url": null,
  "cancellation_instructions": null,
  "vehicle_drop_off_location": null,
  "reservation_number": "AB123",
  "origin_vendor_name": "Example Airline",
  "origin_flight_number": null,
  "origin_reservation_item_info": null,
  "origin_checkin_location": null,
  "origin_checkin_date": "2027-02-03",
  "origin_checkin_time": "09:30",
  "origin_reservation_details": null,
  "origin_destination_location": null,
  "origin_destination_date": null,
  "origin_destination_time": null,
  "origin_reservation_final_details": null,
  "return_vendor_name": null,
  "return_flight_number": null,
  "return_reservation_item_info": null,
  "return_checkin_location": null,
  "return_checkin_date": null,
  "return_checkin_time": null,
  "return_reservation_details": null,
  "return_destination_location": null,
  "return_destination_date": null,
  "return_destination_time": null,
  "return_reservation_final_details": null,
  "origin_vendor_address": null,
  "notes": "",
  "payment_status_id": 0,
  "payment_due_date": null,
  "next_payment_due_date": null,
  "payment_notes": null,
  "invoice_attachment": {
    "id": 882345,
    "filename": "travel-reservation-invoice.pdf",
    "attachment_created_timestamp": "2027-01-30T12:00:00Z"
  },
  "reservation_type": "Flight",
  "reservation_group": "Transportation",
  "booking_status": "Not Specified",
  "payment_status": {
    "id": 0,
    "name": "N/A"
  },
  "cost": {
    "amount": 200.00,
    "cost_center_breakdown": [
      {
        "cost_center_id": 54321,
        "cost_center": "Marketing",
        "charge": 125.50
      },
      {
        "cost_center_id": 54322,
        "cost_center": "Operations",
        "charge": 74.50
      }
    ]
  },
  "tagged_users": [
    {
      "id": "11111111-2222-4333-8444-555555555551",
      "first_name": "Alex",
      "last_name": "Rivera",
      "display_name": "Alex Rivera",
      "email": "alex@example.invalid",
      "type": "user",
      "workspace_role": "team_member",
      "is_active": true
    },
    {
      "id": "11111111-2222-4333-8444-555555555552",
      "first_name": "Jamie",
      "last_name": "Chen",
      "display_name": "Jamie Chen",
      "email": "jamie@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
  },
  "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"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Retrieve Travel Reservations #

Method
GET
Endpoint

Retrieves Travel Reservations across the Events you can read.

Parameters
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 limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "oneOf": [
    {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "\\S"
    },
    {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128,
        "pattern": "\\S"
      }
    }
  ],
  "x-normalization": "one string becomes a one-item array; trimmed distinct IDs; no record-count cap",
  "nullable": false,
  "x-maximum-depth": 1,
  "x-empty-create-means-omitted": false,
  "example": [
    "user-id"
  ]
}
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 Travel Reservations to return: a whole number of 1 or more. Omit it for all remaining matches; a blank value or null is refused, so leave the parameter out instead.
$offset Number No
How many matching Travel Reservations to skip: a whole number of 0 or more. Default: 0. A blank value or null is refused.
$result_format String No
By default, the response is an object containing list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
Allowed values: array | wrapped_in_array
hydrate_related_items Boolean No
Set to true to include each record's related_items: the Tasks and items linked to it, with the key to use when adding or removing a link. Omit it or send false to leave related_items out of list results. Single-record GETs always include related_items.
Default: false.

Good to know

Retrieves records across your workspace's readable Event tabs. Use filter_by_event_id to narrow the results to one Event, or omit it for the workspace list. Each record includes its event_id and Event name. Use filter_by_tagged_user_ids to select tagged people or Resources. any is the default; all requires every selected ID and permits additional tags.

Choosing Events

Omit filter_by_event_id to retrieve records across readable Event tabs, or supply one Event ID to narrow the list. Each result retains its own event_id and Event name.

Hidden or unavailable Event tabs are not included. A locked tab can still be read. If no records match, the response is an empty list.

Filtering tagged people

filter_by_tagged_user_ids accepts one user ID string or an array. Set filter_by_tagged_user_ids_match_type=any (the default) to match at least one selected ID, or all to require every selected ID. Additional tags are allowed. Omit the IDs, leave them blank or send [] for no tag filter. Sending filter_by_tagged_user_ids_match_type without IDs is ignored with a warning.

Stored assignments and tags match directly: inactive and deactivated people, Resources and people no longer in this workspace still match the records they are on. IDs never used on this workspace's records match nothing; this is not an error. The people and Event filters combine with AND before counting and paging.

Reading pages

The Event filter and any people filter are applied before the total count and paging. Results are ordered by Event start date ascending, Event ID ascending, then Travel display order, then Travel ID descending.

Use $limit and $offset for successive pages. Omit $limit to return all remaining matches. total_records and X-Total-Count describe all matches; records_found counts this response.

Omit $result_format for the normal list wrapper. array returns only the records; wrapped_in_array places the normal wrapper in a one-item array.

Handling input and changes

Unrecognized parameters are ignored and listed in the X-API-Warnings response header. Conflicting or malformed filter values return HTTP 400; send arrays in JSON, query parameters or form fields rather than comma-bearing headers.

Current API access is checked even when the list is empty. A concurrent change can return HTTP 409; retrieve the list again. These filters retrieve records and do not change tags, assignments or notification settings.

Related items

Set hydrate_related_items=true to include each record's related_items: the Tasks and items linked to it. Add or remove links with POST and DELETE /v1/related_items. It is left out by default to keep lists fast. Retrieving one record always includes related_items.

Formatted text in the response

Notes and other rich-text values in the response contain the stored HTML, including encoded characters and line breaks such as <br />.

Events with a hidden Travel tab

Records on Events whose Travel 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.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/events/travel_reservations" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "list_type": "travel_reservation",
  "list_data": [
    {
      "id": 12345,
      "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=9&riSub=0&riId=12345",
      "event_id": 23456,
      "event_name": "Sample Event",
      "reservation_type_id": 1,
      "booking_status_id": null,
      "book_by_date": null,
      "date_booked": null,
      "booking_url": null,
      "cancellation_instructions": null,
      "vehicle_drop_off_location": null,
      "reservation_number": "AB123",
      "origin_vendor_name": "Example Airline",
      "origin_flight_number": null,
      "origin_reservation_item_info": null,
      "origin_checkin_location": null,
      "origin_checkin_date": "2027-02-03",
      "origin_checkin_time": "09:30",
      "origin_reservation_details": null,
      "origin_destination_location": null,
      "origin_destination_date": null,
      "origin_destination_time": null,
      "origin_reservation_final_details": null,
      "return_vendor_name": null,
      "return_flight_number": null,
      "return_reservation_item_info": null,
      "return_checkin_location": null,
      "return_checkin_date": null,
      "return_checkin_time": null,
      "return_reservation_details": null,
      "return_destination_location": null,
      "return_destination_date": null,
      "return_destination_time": null,
      "return_reservation_final_details": null,
      "origin_vendor_address": null,
      "notes": "",
      "payment_status_id": 0,
      "payment_due_date": null,
      "next_payment_due_date": null,
      "payment_notes": null,
      "invoice_attachment": {
        "id": 882345,
        "filename": "travel-reservation-invoice.pdf",
        "attachment_created_timestamp": "2027-01-30T12:00:00Z"
      },
      "reservation_type": "Flight",
      "reservation_group": "Transportation",
      "booking_status": "Not Specified",
      "payment_status": {
        "id": 0,
        "name": "N/A"
      },
      "cost": {
        "amount": 200.00,
        "cost_center_breakdown": [
          {
            "cost_center_id": 54321,
            "cost_center": "Marketing",
            "charge": 125.50
          },
          {
            "cost_center_id": 54322,
            "cost_center": "Operations",
            "charge": 74.50
          }
        ]
      },
      "tagged_users": [
        {
          "id": "11111111-2222-4333-8444-555555555551",
          "first_name": "Alex",
          "last_name": "Rivera",
          "display_name": "Alex Rivera",
          "email": "alex@example.invalid",
          "type": "user",
          "workspace_role": "team_member",
          "is_active": true
        },
        {
          "id": "11111111-2222-4333-8444-555555555552",
          "first_name": "Jamie",
          "last_name": "Chen",
          "display_name": "Jamie Chen",
          "email": "jamie@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
      }
    },
    {
      "id": 12346,
      "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=9&riSub=0&riId=12346",
      "event_id": 23456,
      "event_name": "Sample Event",
      "reservation_type_id": 6,
      "booking_status_id": null,
      "book_by_date": null,
      "date_booked": null,
      "booking_url": null,
      "cancellation_instructions": null,
      "vehicle_drop_off_location": null,
      "reservation_number": "HOTEL456",
      "origin_vendor_name": "Example Hotel",
      "origin_flight_number": null,
      "origin_reservation_item_info": null,
      "origin_checkin_location": null,
      "origin_checkin_date": "2027-02-03",
      "origin_checkin_time": "09:30",
      "origin_reservation_details": null,
      "origin_destination_location": null,
      "origin_destination_date": null,
      "origin_destination_time": null,
      "origin_reservation_final_details": null,
      "return_vendor_name": null,
      "return_flight_number": null,
      "return_reservation_item_info": null,
      "return_checkin_location": null,
      "return_checkin_date": null,
      "return_checkin_time": null,
      "return_reservation_details": null,
      "return_destination_location": null,
      "return_destination_date": null,
      "return_destination_time": null,
      "return_reservation_final_details": null,
      "origin_vendor_address": null,
      "notes": "",
      "payment_status_id": 0,
      "payment_due_date": null,
      "next_payment_due_date": null,
      "payment_notes": null,
      "invoice_attachment": {
        "id": 882346,
        "filename": "travel-reservation-invoice.pdf",
        "attachment_created_timestamp": "2027-01-30T12:00:00Z"
      },
      "reservation_type": "Hotel",
      "reservation_group": "Lodging",
      "booking_status": "Not Specified",
      "payment_status": {
        "id": 0,
        "name": "N/A"
      },
      "cost": {
        "amount": 200.00,
        "cost_center_breakdown": [
          {
            "cost_center_id": 54321,
            "cost_center": "Marketing",
            "charge": 125.50
          },
          {
            "cost_center_id": 54322,
            "cost_center": "Operations",
            "charge": 74.50
          }
        ]
      },
      "tagged_users": [
        {
          "id": "11111111-2222-4333-8444-555555555551",
          "first_name": "Alex",
          "last_name": "Rivera",
          "display_name": "Alex Rivera",
          "email": "alex@example.invalid",
          "type": "user",
          "workspace_role": "team_member",
          "is_active": true
        },
        {
          "id": "11111111-2222-4333-8444-555555555552",
          "first_name": "Jamie",
          "last_name": "Chen",
          "display_name": "Jamie Chen",
          "email": "jamie@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
      }
    }
  ],
  "records_found": 2,
  "total_records": 2,
  "has_more": false
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Add a Travel Reservation #

Method
POST
Endpoint

Adds a Travel Reservation to an Event.

Parameters
Name Type Required? Description Details
event_id Number Yes
The ID of the Event.
The reservation will be added to this Event.
reservation_type_id Number Yes
The transportation or lodging type. Required when adding a reservation. Choose a type currently returned by GET /v1/references/travel_reservation_types. The selected type determines which travel-detail fields apply; blank or null is refused as missing.
Allowed values: 1 (Flight) | 2 (Train) | 3 (Bus) | 4 (Automobile) | 5 (Other Transportation) | 6 (Hotel) | 7 (Other Lodging) | 8 (Bed and Breakfast)
booking_status_id Number No
The reservation's booking status. Omit or send null for Not Specified.
Allowed values: 10 (Not Booked Yet) | 20 (Booked) | 30 (Canceled)
book_by_date String No
The date by which you want to book the reservation.
Use a calendar date in YYYY-MM-DD format. Omit for no value.
date_booked String No
The date the reservation was booked.
Use a calendar date in YYYY-MM-DD format. Omit for no value.
booking_url String No
A link to book or manage the reservation.
Up to 2,000 characters, excluding surrounding spaces. Omit for no value.
cancellation_instructions String No
Instructions for canceling the reservation.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
vehicle_drop_off_location String No
The drop-off location for Automobile or Other Transportation.
Up to 1,000 characters, excluding surrounding spaces. Omit for no value. Applies to Automobile (4), Other Transportation (5).
reservation_number String No
The confirmation or reservation number.
Up to 125 characters, excluding surrounding spaces. Omit for no value.
origin_vendor_name String No
The outbound airline, transport operator, rental company or lodging name.
Up to 125 characters, excluding surrounding spaces. Omit for no value.
origin_flight_number String No
The outbound flight number.
Up to 100 characters, excluding surrounding spaces. Omit for no value. Applies to Flight (1).
origin_reservation_item_info String No
The outbound class or seat information, vehicle type or lodging room information.
Up to 125 characters, excluding surrounding spaces. Omit for no value. Applies to Flight (1), Train (2), Bus (3), Automobile (4), Hotel (6), Other Lodging (7), Bed and Breakfast (8).
origin_checkin_location String No
The outbound departure airport or station.
Up to 250 characters, excluding surrounding spaces. Omit for no value. Applies to Flight (1), Train (2), Bus (3).
origin_checkin_date String No
The outbound departure, vehicle pickup or lodging check-in date.
Use a calendar date in YYYY-MM-DD format. Omit for no value.
origin_checkin_time String No
The local outbound departure, vehicle pickup or lodging check-in time.
Use local HH:mm, from 00:00 through 23:59, with no time zone conversion. See Dates and local times below. Omit for no value.
origin_reservation_details String No
Outbound layover or connection information.
Up to 750 characters, excluding surrounding spaces. Omit for no value. Applies to Flight (1).
origin_destination_location String No
The outbound arrival airport or station.
Up to 250 characters, excluding surrounding spaces. Omit for no value. Applies to Flight (1), Train (2), Bus (3).
origin_destination_date String No
The outbound arrival date.
Use a calendar date in YYYY-MM-DD format. Omit for no value. Applies to Flight (1), Train (2), Bus (3).
origin_destination_time String No
The local outbound arrival time.
Use local HH:mm, from 00:00 through 23:59, with no time zone conversion. See Dates and local times below. Omit for no value. Applies to Flight (1), Train (2), Bus (3).
origin_reservation_final_details String No
Outbound arrival information, pickup notes or lodging check-in information.
Up to 750 characters, excluding surrounding spaces. Omit for no value.
return_vendor_name String No
The return airline or transport operator.
Up to 125 characters, excluding surrounding spaces. Omit for no value. Applies to Flight (1), Train (2), Bus (3).
return_flight_number String No
The return flight number.
Up to 100 characters, excluding surrounding spaces. Omit for no value. Applies to Flight (1).
return_reservation_item_info String No
The return class, cabin or seat information.
Up to 125 characters, excluding surrounding spaces. Omit for no value. Applies to Flight (1), Train (2), Bus (3).
return_checkin_location String No
The return departure airport or station.
Up to 250 characters, excluding surrounding spaces. Omit for no value. Applies to Flight (1), Train (2), Bus (3).
return_checkin_date String No
The return departure, vehicle drop-off or lodging check-out date.
Use a calendar date in YYYY-MM-DD format. Omit for no value.
return_checkin_time String No
The local return departure, vehicle drop-off or lodging check-out time.
Use local HH:mm, from 00:00 through 23:59, with no time zone conversion. See Dates and local times below. Omit for no value.
return_reservation_details String No
Return layover or connection information.
Up to 750 characters, excluding surrounding spaces. Omit for no value. Applies to Flight (1).
return_destination_location String No
The return arrival airport or station.
Up to 250 characters, excluding surrounding spaces. Omit for no value. Applies to Flight (1), Train (2), Bus (3).
return_destination_date String No
The return arrival date.
Use a calendar date in YYYY-MM-DD format. Omit for no value. Applies to Flight (1), Train (2), Bus (3).
return_destination_time String No
The local return arrival time.
Use local HH:mm, from 00:00 through 23:59, with no time zone conversion. See Dates and local times below. Omit for no value. Applies to Flight (1), Train (2), Bus (3).
return_reservation_final_details String No
Return arrival information, drop-off notes or lodging check-out information.
Up to 750 characters, excluding surrounding spaces. Omit for no value.
origin_vendor_address String No
The pickup or lodging address.
Up to 500 characters, excluding surrounding spaces. Omit for no value. Applies to Automobile (4), Other Transportation (5), Hotel (6), Other Lodging (7), Bed and Breakfast (8).
notes String No
Notes about this Travel Reservation.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
payment_status_id Number No
The reservation's payment status. Omit for N/A. A status other than Partially Paid clears the next partial payment due date.
Allowed values: 0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet)
payment_due_date String No
The reservation payment due date.
Use a calendar date in YYYY-MM-DD format. Omit for no value.
next_payment_due_date Date No
The next partial payment due date.
Use a calendar date in YYYY-MM-DD format. Applies only to Partially Paid (2). Supplying it with another payment status clears the date; choosing another status also clears it. Omit for no value.
payment_notes String No
Notes about the reservation payment.
Up to 200 characters, excluding surrounding spaces. Omit for no value.
tagged_user_ids JSON object/list No
The people associated with this reservation.
View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "maxItems": 2147483647,
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": [
    "user-id"
  ]
}
A JSON array of unique, active workspace user or resource IDs, each 1 to 128 characters with no surrounding whitespace. A supplied array replaces the full tag list. Omit for no tagged people. Retained tags keep their notification state; only newly added tags can schedule notifications.
notify_tagged_users Boolean No
Whether to notify newly tagged people.
Default: true when omitted or blank, subject to each person's preferences and recipient eligibility. False suppresses notifications only for tags added by this request. Existing tags are unchanged. JSON null is refused even when ignore-empty is true. Changing this option alone makes no reservation change or revision change.
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 limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "anyOf": [
    {
      "type": "number",
      "minimum": 0,
      "description": "Shorthand for an object with amount. The amount is rounded to cents before the supported storage range is checked.",
      "nullable": true
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "number",
          "minimum": 0.0,
          "maximum": 79228162514264337593543950335.0
        },
        "cost_center_breakdown": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "cost_center_id": {
                "type": "integer",
                "format": "int64",
                "nullable": true
              },
              "charge": {
                "type": "number",
                "minimum": 0.0,
                "maximum": 79228162514264337593543950335.0
              },
              "cost_center": {
                "type": "string",
                "description": "Optional and read-only: the cost center name a read returns, so a cost can be sent back unchanged. It is ignored; the line is saved by cost_center_id, and a name that doesn't match that cost center is explained in a warning.",
                "nullable": true
              }
            },
            "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
            "required": [
              "charge"
            ]
          },
          "maxItems": 2147483647
        }
      },
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
      "anyOf": [
        {
          "required": [
            "amount"
          ]
        },
        {
          "required": [
            "cost_center_breakdown"
          ]
        }
      ],
      "nullable": true
    }
  ],
  "x-numeric-shorthand": "A number is equivalent to {amount:number}.",
  "nullable": true,
  "x-maximum-depth": 3,
  "x-empty-create-means-omitted": true,
  "example": {
    "amount": 125.50
  }
}
Optional; defaults to zero.
$result_format String No
By default, the response is a single object. Send array to get it inside a one-item array.
Allowed values: array | object
Idempotency-Key String No
A unique key for safely retrying this add request.
Optional HTTP header: 1 to 255 visible ASCII characters without spaces or commas. Retry the identical request with the same key to replay its first saved response. Use a new key for a different request.
$ignore_params_with_empty_values Boolean No
Whether supplied JSON null values should be omitted.
Default: false. With true, actual JSON null fields and tag lists are omitted. Nonempty text null still requests clearing where supported. This option does not bypass required values, strict notify_tagged_users input or revision checks.
$request_principal_name String No
A display label for API-origin creation or newly added tags.
Optional; up to 122 characters. Omit or leave blank for ExhibitDay API. This is a display label, not a workspace user ID.

Good to know

Adds a Travel Reservation to an Event. Choose the transportation or lodging type, then record its booking details and the people it is for.

Choosing travel details

The selected reservation type determines which fields are used. The origin fields describe the outbound journey, vehicle pickup or lodging check-in; return fields describe the return journey, drop-off or check-out.

A supplied field that does not apply to the selected type is not kept; the table shows which types use each field.

Dates and local times

Enter each clock time in the local time at the relevant departure, arrival, pickup, drop-off or lodging location. The API does not convert timezones.

Changing a date preserves an already recorded matching clock time. Clearing a date alone does not clear its clock time. To remove both, clear both fields. A clock time can also be supplied without a date.

Tagging people and notifications

A supplied tagged_user_ids array replaces the full tag list. Include any currently tagged people you want to keep. Users and Resources can both be tagged; notifications depend on actual recipient eligibility and preferences.

notify_tagged_users defaults to true for newly added tags. False suppresses only those new notifications. Retained tags keep their existing notification state; changing the option alone saves no reservation change.

After the add

The response includes the new reservation and its id. The change is recorded in Event history. File Attachments and the Invoice Attachment are uploaded separately.

Recording costs does not attach an invoice, mark a payment complete or change the Event's planned Travel budget. If a save outcome cannot be confirmed, retrieve the current reservation before deciding whether to retry.

Access

The Event's Travel Reservations tab must be available, visible and unlocked, and your current access must allow the change.

Sending values

Use JSON, query parameters or form fields for text containing commas and tag arrays.

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 Travel 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.

Fields for each reservation type

Each trip field applies only to some reservation types. A value for a field that doesn't apply to the reservation's type is not saved, and the response includes a warning that names the field and the type.

  • reservation_number: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_vendor_name: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_flight_number: Flight
  • origin_reservation_item_info: Flight, Train, Bus, Automobile, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_checkin_date: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_checkin_time: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_reservation_details: Flight
  • origin_destination_date: Flight, Train, Bus
  • origin_destination_time: Flight, Train, Bus
  • origin_reservation_final_details: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • return_vendor_name: Flight, Train, Bus
  • return_flight_number: Flight
  • return_reservation_item_info: Flight, Train, Bus
  • return_checkin_date: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • return_checkin_time: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • return_reservation_details: Flight
  • return_destination_date: Flight, Train, Bus
  • return_destination_time: Flight, Train, Bus
  • return_reservation_final_details: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_vendor_address: Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)

Open in ExhibitDay

The created record includes exhibitday_url, the record's page in ExhibitDay. It is the same link that GET /v1/events/travel_reservations/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.

Code Samples
curl -X POST "https://api.exhibitday.com/v1/events/travel_reservations" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"event_id\":23456,\"reservation_type_id\":1}"

Example response

{
  "id": 12345,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=9&riSub=0&riId=12345",
  "event_id": 23456,
  "event_name": "Sample Event",
  "reservation_type_id": 1,
  "booking_status_id": null,
  "book_by_date": null,
  "date_booked": null,
  "booking_url": null,
  "cancellation_instructions": null,
  "vehicle_drop_off_location": null,
  "reservation_number": null,
  "origin_vendor_name": null,
  "origin_flight_number": null,
  "origin_reservation_item_info": null,
  "origin_checkin_location": null,
  "origin_checkin_date": null,
  "origin_checkin_time": null,
  "origin_reservation_details": null,
  "origin_destination_location": null,
  "origin_destination_date": null,
  "origin_destination_time": null,
  "origin_reservation_final_details": null,
  "return_vendor_name": null,
  "return_flight_number": null,
  "return_reservation_item_info": null,
  "return_checkin_location": null,
  "return_checkin_date": null,
  "return_checkin_time": null,
  "return_reservation_details": null,
  "return_destination_location": null,
  "return_destination_date": null,
  "return_destination_time": null,
  "return_reservation_final_details": null,
  "origin_vendor_address": null,
  "notes": "",
  "payment_status_id": 0,
  "payment_due_date": null,
  "next_payment_due_date": null,
  "payment_notes": null,
  "invoice_attachment": null,
  "reservation_type": "Flight",
  "reservation_group": "Transportation",
  "booking_status": "Not Specified",
  "payment_status": {
    "id": 0,
    "name": "N/A"
  },
  "cost": {
    "amount": 0.00,
    "cost_center_breakdown": []
  },
  "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
  }
}
Note: IDs are illustrative; use IDs from your workspace.

Update a Travel Reservation #

Method
PATCH
Endpoint

Updates an existing Travel Reservation.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Travel Reservation.
Use its id from the list, single-record read or add response.
reservation_type_id Number No
The transportation or lodging type. Choose a type currently returned by GET /v1/references/travel_reservation_types. Omit or leave blank to keep it; null cannot clear it. Changing type clears details not used by the new type.
Allowed values: 1 (Flight) | 2 (Train) | 3 (Bus) | 4 (Automobile) | 5 (Other Transportation) | 6 (Hotel) | 7 (Other Lodging) | 8 (Bed and Breakfast)
booking_status_id Number No
The reservation's booking status. Omit or leave blank to keep it; null means Not Specified.
Allowed values: 10 (Not Booked Yet) | 20 (Booked) | 30 (Canceled)
book_by_date String No
The date by which you want to book the reservation.
Use a calendar date in YYYY-MM-DD format. Omit or leave blank to keep it; null clears it.
date_booked String No
The date the reservation was booked.
Use a calendar date in YYYY-MM-DD format. Omit or leave blank to keep it; null clears it.
booking_url String No
A link to book or manage the reservation.
Up to 2,000 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
cancellation_instructions String No
Instructions for canceling the reservation.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
vehicle_drop_off_location String No
The drop-off location for Automobile or Other Transportation.
Up to 1,000 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Automobile (4), Other Transportation (5).
reservation_number String No
The confirmation or reservation number.
Up to 125 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
origin_vendor_name String No
The outbound airline, transport operator, rental company or lodging name.
Up to 125 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
origin_flight_number String No
The outbound flight number.
Up to 100 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Flight (1).
origin_reservation_item_info String No
The outbound class or seat information, vehicle type or lodging room information.
Up to 125 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Flight (1), Train (2), Bus (3), Automobile (4), Hotel (6), Other Lodging (7), Bed and Breakfast (8).
origin_checkin_location String No
The outbound departure airport or station.
Up to 250 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Flight (1), Train (2), Bus (3).
origin_checkin_date String No
The outbound departure, vehicle pickup or lodging check-in date.
Use a calendar date in YYYY-MM-DD format. Omit or leave blank to keep it; null clears it.
origin_checkin_time String No
The local outbound departure, vehicle pickup or lodging check-in time.
Use local HH:mm, from 00:00 through 23:59, with no time zone conversion. See Dates and local times below. Omit or leave blank to keep it; null clears it.
origin_reservation_details String No
Outbound layover or connection information.
Up to 750 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Flight (1).
origin_destination_location String No
The outbound arrival airport or station.
Up to 250 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Flight (1), Train (2), Bus (3).
origin_destination_date String No
The outbound arrival date.
Use a calendar date in YYYY-MM-DD format. Omit or leave blank to keep it; null clears it. Applies to Flight (1), Train (2), Bus (3).
origin_destination_time String No
The local outbound arrival time.
Use local HH:mm, from 00:00 through 23:59, with no time zone conversion. See Dates and local times below. Omit or leave blank to keep it; null clears it. Applies to Flight (1), Train (2), Bus (3).
origin_reservation_final_details String No
Outbound arrival information, pickup notes or lodging check-in information.
Up to 750 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
return_vendor_name String No
The return airline or transport operator.
Up to 125 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Flight (1), Train (2), Bus (3).
return_flight_number String No
The return flight number.
Up to 100 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Flight (1).
return_reservation_item_info String No
The return class, cabin or seat information.
Up to 125 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Flight (1), Train (2), Bus (3).
return_checkin_location String No
The return departure airport or station.
Up to 250 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Flight (1), Train (2), Bus (3).
return_checkin_date String No
The return departure, vehicle drop-off or lodging check-out date.
Use a calendar date in YYYY-MM-DD format. Omit or leave blank to keep it; null clears it.
return_checkin_time String No
The local return departure, vehicle drop-off or lodging check-out time.
Use local HH:mm, from 00:00 through 23:59, with no time zone conversion. See Dates and local times below. Omit or leave blank to keep it; null clears it.
return_reservation_details String No
Return layover or connection information.
Up to 750 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Flight (1).
return_destination_location String No
The return arrival airport or station.
Up to 250 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Flight (1), Train (2), Bus (3).
return_destination_date String No
The return arrival date.
Use a calendar date in YYYY-MM-DD format. Omit or leave blank to keep it; null clears it. Applies to Flight (1), Train (2), Bus (3).
return_destination_time String No
The local return arrival time.
Use local HH:mm, from 00:00 through 23:59, with no time zone conversion. See Dates and local times below. Omit or leave blank to keep it; null clears it. Applies to Flight (1), Train (2), Bus (3).
return_reservation_final_details String No
Return arrival information, drop-off notes or lodging check-out information.
Up to 750 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
origin_vendor_address String No
The pickup or lodging address.
Up to 500 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies to Automobile (4), Other Transportation (5), Hotel (6), Other Lodging (7), Bed and Breakfast (8).
notes String No
Notes about this Travel Reservation.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
payment_status_id Number No
The reservation's payment status. Omit or leave blank to keep it; null resets it to N/A. A status other than Partially Paid clears the next partial payment due date.
Allowed values: 0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet)
payment_due_date String No
The reservation payment due date.
Use a calendar date in YYYY-MM-DD format. Omit or leave blank to keep it; null clears it.
next_payment_due_date Date No
The next partial payment due date.
Use a calendar date in YYYY-MM-DD format. Applies only to Partially Paid (2). Supplying it with another payment status clears the date; choosing another status also clears it. Omit or leave blank to keep it; null clears it.
payment_notes String No
Notes about the reservation payment.
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
tagged_user_ids JSON object/list No
The people associated with this reservation.
View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "maxItems": 2147483647,
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": [
    "user-id"
  ]
}
A JSON array of unique, active workspace user or resource IDs, each 1 to 128 characters with no surrounding whitespace. A supplied array replaces the full tag list. Omit to keep existing tags; null or [] removes them. Actual JSON null is omitted when the ignore-empty option is true. Retained tags keep their notification state; only newly added tags can schedule notifications.
notify_tagged_users Boolean No
Whether to notify newly tagged people.
Default: true when omitted or blank, subject to each person's preferences and recipient eligibility. False suppresses notifications only for tags added by this request. Existing tags are unchanged. JSON null is refused even when ignore-empty is true. Changing this option alone makes no reservation change or revision change.
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 limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "anyOf": [
    {
      "type": "number",
      "minimum": 0,
      "description": "Shorthand for an object with amount. The amount is rounded to cents before the supported storage range is checked.",
      "nullable": true
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "number",
          "minimum": 0.0,
          "maximum": 79228162514264337593543950335.0
        },
        "cost_center_breakdown": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "cost_center_id": {
                "type": "integer",
                "format": "int64",
                "nullable": true
              },
              "charge": {
                "type": "number",
                "minimum": 0.0,
                "maximum": 79228162514264337593543950335.0
              },
              "cost_center": {
                "type": "string",
                "description": "Optional and read-only: the cost center name a read returns, so a cost can be sent back unchanged. It is ignored; the line is saved by cost_center_id, and a name that doesn't match that cost center is explained in a warning.",
                "nullable": true
              }
            },
            "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
            "required": [
              "charge"
            ]
          },
          "maxItems": 2147483647
        }
      },
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
      "anyOf": [
        {
          "required": [
            "amount"
          ]
        },
        {
          "required": [
            "cost_center_breakdown"
          ]
        }
      ],
      "nullable": true
    }
  ],
  "x-numeric-shorthand": "A number is equivalent to {amount:number}.",
  "nullable": true,
  "x-maximum-depth": 3,
  "x-empty-create-means-omitted": true,
  "example": {
    "amount": 125.50
  }
}
Omit to keep the saved cost. A supplied value replaces its full allocation.
expected_revision String No
The record_revision from an earlier read of this Travel Reservation.
Optional. Obtain it from GET /v1/events/travel_reservations/info with $include_record_revision=true. A changed reservation returns HTTP 409 without saving this update. Omission skips the check; blank, null and malformed values are refused.
$ignore_params_with_empty_values Boolean No
Whether supplied JSON null values should be omitted.
Default: false. With true, actual JSON null fields and tag lists are omitted. Nonempty text null still requests clearing where supported. This option does not bypass required values, strict notify_tagged_users input or revision checks.
$request_principal_name String No
A display label for API-origin creation or newly added tags.
Optional; up to 122 characters. Omit or leave blank for ExhibitDay API. This is a display label, not a workspace user ID.

Good to know

Updates a Travel Reservation's booking, travel, payment or tagged-person details. Send only the fields you want to change.

Choosing travel details

The selected reservation type determines which fields are used. The origin fields describe the outbound journey, vehicle pickup or lodging check-in; return fields describe the return journey, drop-off or check-out.

A supplied field that does not apply to the selected type is not kept; the table shows which types use each field.

Dates and local times

Enter each clock time in the local time at the relevant departure, arrival, pickup, drop-off or lodging location. The API does not convert timezones.

Changing a date preserves an already recorded matching clock time. Clearing a date alone does not clear its clock time. To remove both, clear both fields. A clock time can also be supplied without a date.

Tagging people and notifications

A supplied tagged_user_ids array replaces the full tag list. Include any currently tagged people you want to keep. Users and Resources can both be tagged; notifications depend on actual recipient eligibility and preferences.

notify_tagged_users defaults to true for newly added tags. False suppresses only those new notifications. Retained tags keep their existing notification state; changing the option alone saves no reservation change.

Choosing what to change

Omitted or blank fields keep their values. Null clears or resets supported fields; reservation_type_id cannot be cleared. Clearing payment_status_id resets it to N/A. With $ignore_params_with_empty_values=true, a JSON null is ignored instead. Changing reservation_type_id clears the details the new type does not use. An update that keeps the type keeps the details you leave out. An attached Invoice Attachment keeps its file; its label follows the new type.

An unchanged request saves no business data or history and keeps its revision. File Attachments and the Invoice Attachment are managed separately.

Using expected_revision

  1. Retrieve this reservation with GET /v1/events/travel_reservations/info and $include_record_revision=true.
  2. Send the returned record_revision unchanged as expected_revision with this update.
  3. If the API reports a change, read the current reservation and decide what to update.

After the update

A real change is recorded in Event history. Supporting files and the Invoice Attachment use their separate file operations.

Recording costs does not attach an invoice, mark a payment complete or change the Event's planned Travel budget. If a save outcome cannot be confirmed, retrieve the current reservation before deciding whether to retry.

Access

The Event's Travel Reservations tab must be available, visible and unlocked, and your current access must allow the change.

Sending values

Use JSON, query parameters or form fields for text containing commas and tag arrays.

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 Travel 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.

Fields for each reservation type

Each trip field applies only to some reservation types. A value for a field that doesn't apply to the reservation's type is not saved, and the response includes a warning that names the field and the type.

  • reservation_number: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_vendor_name: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_flight_number: Flight
  • origin_reservation_item_info: Flight, Train, Bus, Automobile, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_checkin_date: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_checkin_time: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_reservation_details: Flight
  • origin_destination_date: Flight, Train, Bus
  • origin_destination_time: Flight, Train, Bus
  • origin_reservation_final_details: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • return_vendor_name: Flight, Train, Bus
  • return_flight_number: Flight
  • return_reservation_item_info: Flight, Train, Bus
  • return_checkin_date: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • return_checkin_time: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • return_reservation_details: Flight
  • return_destination_date: Flight, Train, Bus
  • return_destination_time: Flight, Train, Bus
  • return_reservation_final_details: Flight, Train, Bus, Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
  • origin_vendor_address: Automobile, Other Transportation, Hotel, Other Lodging, Bed and Breakfast (B&B)
Code Samples
curl -X PATCH "https://api.exhibitday.com/v1/events/travel_reservations" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"notes\":\"Updated text\"}"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Travel reservation updated.",
  "errors": []
}

Delete a Travel Reservation #

Method
DELETE
Endpoint

Deletes an existing Travel Reservation.

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.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Travel Reservation.
Use its id from the list, single-record read or add response.

Good to know

Deletes a Travel Reservation and its saved costs, taggings, related-item links, File Attachments and Invoice Attachment. Workspace members and linked Tasks or other records remain in place.

After the deletion

The reservation, its taggings, costs, related-item links and attachment records are removed together. Only its files are scheduled for physical cleanup after the save. Tagged workspace members and linked records remain.

The deletion is recorded in Event history. An unavailable reservation returns HTTP 404. If the save outcome cannot be confirmed, retrieve the current reservations before deciding whether to retry.

Access

The Event's Travel Reservations tab must be available, visible and unlocked, and your current access must allow the change.

Hidden or locked tab

If the Event's Travel 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.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/events/travel_reservations?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Travel reservation removed.",
  "errors": []
}

Download Travel Reservation Invoice Attachment #

Method
GET
Endpoint

Downloads the Invoice Attachment for a Travel Reservation.

Parameters
Name Type Required? Description Details
travel_reservation_id Number Yes
The ID of the Travel Reservation, from Retrieve Travel Reservations (GET /v1/events/travel_reservations) or its add response.

Good to know

Downloads the original Invoice Attachment for this Travel Reservation. Use this method to retrieve the file itself.

Finding the file

In the web app, this is the invoice control beside the Travel Reservation's cost and payment details. Each cost has one Invoice Attachment even when its amount is split among cost centers.

For file metadata, retrieve the parent record with GET /v1/events/travel_reservations/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 Travel 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.

Code Samples
# 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/travel_reservations/invoice_attachment/download?travel_reservation_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'

Example response

File: invoice.pdf
Content type: application/octet-stream
Note: The response body contains file bytes.

Add Travel Reservation Invoice Attachment #

Method
POST
Endpoint

Adds an Invoice Attachment to a Travel Reservation.

Parameters
Name Type Required? Description Details
travel_reservation_id Number Yes
The ID of the Travel Reservation, from Retrieve Travel Reservations (GET /v1/events/travel_reservations) or its add response.
file File (multipart) Yes
The Invoice Attachment to upload.

Maximum size per file: 25 MiB (26,214,400 bytes).

Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip.

Maximum files per request: 1.

View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "string",
  "format": "binary",
  "x-maximum-bytes": 26214400,
  "x-allowed-extensions": [
    "png",
    "jpg",
    "jpeg",
    "bmp",
    "gif",
    "pdf",
    "msg",
    "eml",
    "doc",
    "docx",
    "ppt",
    "pptx",
    "xls",
    "xlsx",
    "csv",
    "rtf",
    "odp",
    "odt",
    "ods",
    "txt",
    "wks",
    "zip"
  ]
}
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 Travel Reservation. 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 Travel Reservation's cost and payment details in the web app.

After the upload

The response's invoice_attachment contains the attached file's id, filename and attachment_created_timestamp. The amount, payment fields, cost-center breakdown and other files are unchanged.

The upload is recorded in Event history. Attaching an invoice does not mark the record as paid.

Access and retries

A current upload-enabled plan, record and financial permissions, and an editable applicable tab are required. Each uploaded file must fit its supported type and size limits.

expected_revision is not supported by this file method. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/travel_reservations/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Travel 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.

Code Samples
# 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/travel_reservations/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "travel_reservation_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

Example response

{
  "invoice_attachment": {
    "id": 12345,
    "filename": "invoice.pdf",
    "attachment_created_timestamp": "2027-01-30T12:00:00Z"
  }
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Replace Travel Reservation Invoice Attachment #

Method
PATCH
Endpoint

Replaces a Travel Reservation's Invoice Attachment.

Parameters
Name Type Required? Description Details
travel_reservation_id Number Yes
The ID of the Travel Reservation, from Retrieve Travel Reservations (GET /v1/events/travel_reservations) or its add response.
file File (multipart) Yes
The Invoice Attachment to upload.

Maximum size per file: 25 MiB (26,214,400 bytes).

Allowed file types: .png, .jpg, .jpeg, .bmp, .gif, .pdf, .msg, .eml, .doc, .docx, .ppt, .pptx, .xls, .xlsx, .csv, .rtf, .odp, .odt, .ods, .txt, .wks, .zip.

Maximum files per request: 1.

View value format and limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "string",
  "format": "binary",
  "x-maximum-bytes": 26214400,
  "x-allowed-extensions": [
    "png",
    "jpg",
    "jpeg",
    "bmp",
    "gif",
    "pdf",
    "msg",
    "eml",
    "doc",
    "docx",
    "ppt",
    "pptx",
    "xls",
    "xlsx",
    "csv",
    "rtf",
    "odp",
    "odt",
    "ods",
    "txt",
    "wks",
    "zip"
  ]
}
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 Travel Reservation'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/travel_reservations/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Travel 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.

Code Samples
# 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/travel_reservations/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "travel_reservation_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

Example response

{
  "invoice_attachment": {
    "id": 12345,
    "filename": "invoice.pdf",
    "attachment_created_timestamp": "2027-01-30T12:00:00Z"
  }
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Remove Travel Reservation Invoice Attachment #

Method
DELETE
Endpoint

Deletes a Travel Reservation'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.

Parameters
Name Type Required? Description Details
travel_reservation_id Number Yes
The ID of the Travel Reservation, from Retrieve Travel Reservations (GET /v1/events/travel_reservations) or its add response.

Good to know

Removes this Travel Reservation'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 Travel Reservation 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/travel_reservations/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Travel 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.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/events/travel_reservations/invoice_attachment?travel_reservation_id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Attachment removed.",
  "errors": []
}

Retrieve Travel Reservation General File Attachments #

Method
GET
Endpoint

Retrieves the General File Attachments on a Travel Reservation.

Parameters
Name Type Required? Description Details
travel_reservation_id Number Yes
The ID of the Travel Reservation, from Retrieve Travel Reservations (GET /v1/events/travel_reservations) 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 Travel Reservation. Each result includes the file's ID, name and added time; use the download method for its contents.

Reading the file list

Files are ordered by added time, then attachment ID, lowest first. Only files available under your current access are included.

Paging totals and X-Total-Count count all matching files before $limit and $offset are applied. A record with no files you can view returns an empty list. This list does not return edit revisions or support changed-since filtering.

Supporting files and invoices

These are the record's General File Attachments. Its cost Invoice Attachment is separate and has its own download and upload methods. Use this list's id values for these supporting-file downloads and removals.

Access

The record's Event and tab must be available, and the tab must not be hidden. A locked tab can still be read.

Hidden tab

If the Event's Travel 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.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/events/travel_reservations/attachments?travel_reservation_id=12345" -H "Authorization: Bearer YOUR_API_KEY"

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"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Add Travel Reservation General File Attachments #

Method
POST
Endpoint

Adds General File Attachments to a Travel Reservation.

Parameters
Name Type Required? Description Details
travel_reservation_id Number Yes
The ID of the Travel Reservation, from Retrieve Travel Reservations (GET /v1/events/travel_reservations) 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 limits

File uploads use multipart form data. Other structured values use a JSON object or array; form/query values use JSON text.

{
  "type": "array",
  "items": {
    "type": "string",
    "format": "binary",
    "x-maximum-bytes": 26214400,
    "x-allowed-extensions": [
      "png",
      "jpg",
      "jpeg",
      "bmp",
      "gif",
      "pdf",
      "msg",
      "eml",
      "doc",
      "docx",
      "ppt",
      "pptx",
      "xls",
      "xlsx",
      "csv",
      "rtf",
      "odp",
      "odt",
      "ods",
      "txt",
      "wks",
      "zip"
    ]
  }
}
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 Travel Reservation. Send each file as a multipart upload part named file.

After the upload

The response's list_data contains the newly attached files, including each id, filename and attachment_created_timestamp. Existing files are kept. Use each returned id to download or remove that file.

Identical repeated files in one request are attached once when their cleaned filename, length and contents match. Files with different contents remain separate even when their names match. This does not remove or replace files already attached to the record.

Choosing the right file method

These uploads add General File Attachments. Use this record's Invoice Attachment methods for its cost invoice or receipt. Adding supporting files does not change amounts, payments or cost-center allocations.

Access

Current record and file-change permissions and applicable Event/tab locks must allow this upload. An upload-enabled paid plan is required.

History and retries

A confirmed file change is recorded in history. expected_revision is not supported by these file methods. If the save outcome cannot be confirmed, retrieve the current file list before deciding whether to retry; the API does not automatically repeat an uncertain change.

Supporting File Attachments have no PATCH replacement. To replace one, add the new file and remove the old one using their separate requests; each request has its own outcome.

Hidden or locked tab

If the Event's Travel 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.

Code Samples
# 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/travel_reservations/attachments" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "travel_reservation_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

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"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Remove a Travel Reservation General File Attachment #

Method
DELETE
Endpoint

Deletes a General File Attachment from a Travel Reservation.

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.

Parameters
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 Travel Reservation. 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 Travel 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.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/events/travel_reservations/attachments?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Attachment removed.",
  "errors": []
}

Download a Travel Reservation General File Attachment #

Method
GET
Endpoint

Downloads a General File Attachment from a Travel Reservation.

Parameters
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 Travel Reservation. 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 Travel 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.

Code Samples
# 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/travel_reservations/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'

Example response

File: attachment.pdf
Content type: application/octet-stream
Note: The response body contains file bytes.