Assets

Retrieve a Single Asset by ID #

Method
GET
Endpoint
Sample Object

Retrieves a single Asset by its ID.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Asset to retrieve.
Use id for this method. Use filter_by_asset_id on GET /v1/assets.
hydrate_reservations Boolean No
Whether to include the reservations you can read.
Default: false. True includes the full readable reservation list, without granting extra access.
$include_record_revision Boolean No
Whether to include record_revision for a later change.
Default: false. A revision can be used when updating, archiving or restoring this Asset.
$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
$on_error_return_empty_result Boolean No
Whether to return an empty result for validation or not-found errors.
Default: false. True returns {} or [] with HTTP 200. Authentication, rate limits and unexpected failures keep their normal errors.
$include_error_list_in_response_message Boolean No
Whether to add validation errors to the error message.
Default: false.
If-None-Match String No
An ETag from an earlier response to this GET.
Optional HTTP header. If the successful response still matches, the API returns HTTP 304 with no response body.

Good to know

Retrieves one Asset’s details, including tags, custom fields, Optional Accessories, images, current status and storage quantities. Reservations are left out unless you request them. Capital Assets are individual reusable items; Collateral is tracked in quantities.

Current inventory status

current_status describes Available / In Storage, a checked-out Event or Other Purpose reservation, multiple active reservations, Archived, or Collateral quantities. Archived Collateral keeps its actual Quantity Available in Storage and Projected Future Balance, including zero and negative balances.

Dates in current_status and returns_to_storage use the full English month, day and year, such as May 4, 2026. returns_to_storage also says when a current Capital reservation ends; it is empty when no current return is reported.

When a shared Asset is checked out for another workspace's Event, current_status names that Event, as in the Assets area. With hydrate_reservations=true, each reservation also shows the Event name and the reservation notes. Because the Event belongs to another workspace, event_id is null and Event methods can't open it with this key. Your own Events keep their IDs. A borrowing workspace reads its own reservation through GET /v1/assets/reservations; sharing does not open the owner's full Asset details.

Retrieving the Asset

  1. Supply the Asset’s id.
  2. Set hydrate_reservations=true only if you also need its readable reservations.
  3. If you plan to change the Asset, set $include_record_revision=true and keep the returned record_revision for that later request.

Access and returned details

Sharing an Asset or using it in an old reservation does not grant access to the other workspace’s full Asset details. This method retrieves Assets in your workspace, including Archived Assets.

Custom dates stay calendar dates. Custom times retain their recorded wall-clock time and time-zone label. An unreadable saved custom value is marked value_state=invalid rather than shown as an empty valid date.

File metadata does not grant extra download permission or provide a permanent public URL.

What $include_record_revision covers

Set $include_record_revision=true to receive record_revision in this GET response. It covers editable Asset fields, tags, custom values and sharing settings. It excludes availability, reservations, Optional Accessories, images and file contents.

Use it as expected_revision with a later update, archive or restore. A stale revision returns HTTP 409 with error_code=record_changed; retrieve the current Asset and review it before trying again. A record that keeps changing while it is read can also return this error.

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

Example response

{
  "workspace_id": 98765,
  "id": 12345,
  "asset_reservation_policy_id": 1,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Asset/98765?aid=12345",
  "internal_identifier": "",
  "asset_type_id": 1,
  "make_or_model": "",
  "asset_status_id": 1,
  "asset_status": "Active",
  "description": "",
  "name": "Display stand",
  "default_storage_location_id": 2345,
  "current_status": "Available / In Storage",
  "storage_location_name": "Main Warehouse",
  "returns_to_storage": "",
  "storage_location_address_display_name": "Boston, MA",
  "storage_area": "",
  "pull_notes": "",
  "status_message": null,
  "in_progress_reservation_count": 0,
  "quantity_available_in_storage": 1,
  "status_message_expires": null,
  "projected_future_balance": 1,
  "cost": {
    "amount": 0.00
  },
  "current_storage_footprint": 0.00,
  "dimensions_length": null,
  "projected_future_footprint": 0.00,
  "dimensions_width": null,
  "dimensions_unit": "in",
  "dimensions_height": null,
  "volume_unit": "cu ft",
  "dimensions_notes": "",
  "has_complete_dimensions": false,
  "dimensions_packaged_length": null,
  "dimensions_packaged_width": null,
  "dimensions_packaged_height": null,
  "dimensions_packaged_notes": "",
  "weight": null,
  "weight_notes": "",
  "weight_packaged": null,
  "weight_packaged_notes": "",
  "integration_metadata_field_1": null,
  "integration_metadata_field_2": null,
  "integration_metadata_field_3": null,
  "integration_metadata_field_4": null,
  "integration_metadata_field_5": null,
  "asset_created_timestamp": "2030-01-02T17:00:00Z",
  "weight_unit": "lb",
  "tags": [
    "Trade shows",
    "East coast"
  ],
  "optional_accessories": [
    {
      "id": 13001,
      "optional_accessory_status_id": 1,
      "optional_accessory_status": "Active",
      "name": "Transport case",
      "description": "Protective case for the display stand.",
      "max_quantity": 1,
      "default_quantity": 1,
      "optional_accessory_created_timestamp": "2030-01-02T17:00:00Z"
    },
    {
      "id": 13002,
      "optional_accessory_status_id": 1,
      "optional_accessory_status": "Active",
      "name": "Spotlight",
      "description": "Clip-on display lighting.",
      "max_quantity": 2,
      "default_quantity": 1,
      "optional_accessory_created_timestamp": "2030-01-02T17:00:00Z"
    }
  ],
  "custom_fields": [
    {
      "id": 12001,
      "field_type_id": 1000000,
      "name": "Responsible team",
      "is_multi_line": false,
      "value": "Event operations",
      "value_state": "set",
      "file": null,
      "date_time": null,
      "url": null
    },
    {
      "id": 12002,
      "field_type_id": 5000000,
      "name": "Setup guide",
      "is_multi_line": false,
      "value": null,
      "value_state": "set",
      "file": null,
      "date_time": null,
      "url": {
        "url": "https://example.com/setup-guide",
        "display_name": "Setup guide"
      }
    }
  ],
  "images": [
    {
      "display_rank": 1,
      "image_filename": "11111111-1111-4111-8111-111111111111.jpg",
      "image_last_update_timestamp": "2030-01-02T17:00:00Z"
    },
    {
      "display_rank": 2,
      "image_filename": "22222222-2222-4222-8222-222222222222.jpg",
      "image_last_update_timestamp": "2030-01-02T17:00:00Z"
    }
  ],
  "reservations": null
}
Note: IDs are illustrative; use IDs from your workspace.

Retrieve Assets #

Method
GET
Endpoint

Retrieves the Assets in your workspace.

Parameters
Name Type Required? Description Details
filter_by_asset_id Number No
The ID of the Asset you want to retrieve. The result is still a list. For a single Asset object, use GET /v1/assets/info with id.
filter_by_asset_type_id Number With any reservation date filter
Include Assets of the selected type. Capital tracks individual items, such as display stands. Collateral tracks quantities, such as brochures. Omit to include both types.
Allowed values: 1 (Capital) | 2 (Collateral)
filter_by_asset_status_id Number No
Include Assets with the selected status. Omit to include both Active and Archived Assets.
Allowed values: 1 (Active) | 2 (Archived)
filter_by_asset_name_contains_text String No
Text to find anywhere in the Asset name. %, _ and square brackets are treated as literal characters.
Maximum: 300 characters.
filter_by_asset_tag String No
The Asset tag to match. Matching follows the same case and accent rules as Asset search in ExhibitDay.
Maximum: 150 characters.
filter_by_default_storage_location_id Number No
Include Capital Assets whose saved default Storage Location is this ID. Collateral/Multi-quantity items don't have a default Storage Location, so they are never included when you use this filter. To check stock or availability at a location, use GET /v1/assets/availability.
filter_by_integration_metadata_field_1 String No
The value to match in integration metadata field 1.
Maximum: 3,000 characters.
filter_by_integration_metadata_field_2 String No
The value to match in integration metadata field 2.
Maximum: 3,000 characters.
filter_by_integration_metadata_field_3 String No
The value to match in integration metadata field 3.
Maximum: 3,000 characters.
filter_by_integration_metadata_field_4 String No
The value to match in integration metadata field 4.
Maximum: 3,000 characters.
filter_by_integration_metadata_field_5 String No
The value to match in integration metadata field 5.
Maximum: 3,000 characters.
filter_by_custom_field_value_setting_id Number With a custom field value
The ID of a visible Asset text or dropdown custom field in your workspace.
filter_by_custom_field_value_setting_value String With a custom field ID
The value to match in the selected field. An empty string matches Assets whose saved value is empty or missing.
filter_by_reservation_date_greater_than_or_equal_to Date No
The earliest checkout date for Capital Assets or the earliest Reservation Date for Collateral.
YYYY-MM-DD.
filter_by_reservation_date_smaller_than_or_equal_to Date No
The latest checkout date for Capital Assets or the latest Reservation Date for Collateral.
YYYY-MM-DD.
filter_by_reservation_return_date_greater_than_or_equal_to Date No
The earliest reservation return date. Capital Assets only.
YYYY-MM-DD.
filter_by_reservation_return_date_smaller_than_or_equal_to Date No
The latest reservation return date. Capital Assets only.
YYYY-MM-DD.
filter_by_reservation_overlaps_start_date Date When filtering by overlap
The first day of the period you want to check. Send both overlap dates. Capital Assets only.
YYYY-MM-DD.
filter_by_reservation_overlaps_end_date Date When filtering by overlap
The last day of the period you want to check. Send both overlap dates. Capital Assets only.
YYYY-MM-DD.
$result_sort String No
Order Assets by name, creation time or ID. Omit for name ascending. Name and creation-time ties use the lower Asset ID first. Unsupported values are refused.
Allowed values: name_asc | name_desc | create_timestamp_asc | create_timestamp_desc | id_asc | id_desc
$limit Number No
The maximum number of Assets to return. Omit to return all remaining matches.
A whole number of 1 or more.
$offset Number No
How many matching Assets to skip. For the next page, add the number of Assets you received to the current offset.
A whole number of 0 or more. Default 0.
hydrate_reservations Boolean No
Set to true to include all reservations you can access for each full Asset result.
Default: false. Applies to full results only.
$return_asset_lites Boolean No
Set to true for a shorter result with Asset identification, current status, quantities and storage summaries.
Default: false.
$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
$on_error_return_empty_result Boolean No
Set to true to receive an empty result for supported validation or not-found errors. Authentication errors, rate limits, read conflicts and unexpected server errors still return an error response.
Default: false.
$include_error_list_in_response_message Boolean No
Set to true to include individual validation errors in the error message.
Default: false.

Good to know

Retrieves Assets in your workspace. By default, the API returns both Active and Archived Assets, sorted by name, with full Asset details. An Asset must match every filter you send to appear in the results.

Current inventory status

current_status describes Available / In Storage, a checked-out Event or Other Purpose reservation, multiple active reservations, Archived, or Collateral quantities. Archived Collateral keeps its actual Quantity Available in Storage and Projected Future Balance, including zero and negative balances.

Dates in current_status and returns_to_storage use the full English month, day and year, such as May 4, 2026. returns_to_storage also says when a current Capital reservation ends; it is empty when no current return is reported.

When a shared Asset is checked out for another workspace's Event, current_status names that Event, as in the Assets area. With hydrate_reservations=true, each reservation also shows the Event name and the reservation notes. Because the Event belongs to another workspace, event_id is null and Event methods can't open it with this key. Your own Events keep their IDs. A borrowing workspace reads its own reservation through GET /v1/assets/reservations; sharing does not open the owner's full Asset details.

Filtering by metadata or a custom field

For integration metadata, omit a parameter to skip that filter. Sending an empty string applies the filter and looks for an empty value.

For a custom field, send both its ID and the value to match. For dropdown fields, the API uses the saved selection. If an Asset has no saved selection, the configured default choice does not count as a match. Hidden fields, other field types and fields from another workspace cannot be used for this filter.

Filtering by reservation dates

Use YYYY-MM-DD for all dates. For Capital Assets, checkout-date filters find reservations that start during a period; the two overlap filters find reservations that cover any part of the period, including those that started earlier. All date filters you combine must match the same reservation.

A reservation with no return date does not match return-date or overlap filters. There is no separate filter for an unknown return date.

For Collateral, use the Reservation Date filters. Return-date and overlap filters are rejected. Manual inventory adjustments are separate from Event reservations.

Reservation filters determine which Assets appear. With hydrate_reservations=true, each matching Asset includes all reservations you can access for it, including reservations outside the filter’s date range.

Paging through results

There is no default page size or fixed maximum number of results. To retrieve 50 Assets at a time, start with $limit=50&$offset=0, then use $limit=50&$offset=50 for the next page. Keep the same filters and sort order between requests. Results and counts can change if another request edits Assets between pages.

In the standard response, records_found counts Assets returned on this page, total_records counts all Assets matching your filters before paging, and has_more tells you whether more matches remain after this page. list_data contains the Assets. With $result_format=array, only that list is returned.

Choosing how much detail to return

Full Asset results include custom field values, Optional Accessories, image details, current status and storage quantities. Use $return_asset_lites=true when you only need identification and inventory details. Short results omit longer text, custom fields, Optional Accessories, files and reservations; setting hydrate_reservations=true does not add reservations to a short result.

To obtain a revision for a later update, retrieve the individual Asset with GET /v1/assets/info and set $include_record_revision=true. This list response does not include record_revision.

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

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "asset",
  "list_data": [
    {
      "workspace_id": 98765,
      "id": 12345,
      "asset_reservation_policy_id": 1,
      "exhibitday_url": "https://www.exhibitday.com/Workspace/Asset/98765?aid=12345",
      "internal_identifier": "",
      "asset_type_id": 1,
      "make_or_model": "",
      "asset_status_id": 1,
      "asset_status": "Active",
      "description": "",
      "name": "Display stand",
      "default_storage_location_id": 2345,
      "current_status": "Available / In Storage",
      "storage_location_name": "Main Warehouse",
      "returns_to_storage": "",
      "storage_location_address_display_name": "Boston, MA",
      "storage_area": "",
      "pull_notes": "",
      "status_message": null,
      "in_progress_reservation_count": 0,
      "quantity_available_in_storage": 1,
      "status_message_expires": null,
      "projected_future_balance": 1,
      "cost": {
        "amount": 0.00
      },
      "current_storage_footprint": 0.00,
      "dimensions_length": null,
      "projected_future_footprint": 0.00,
      "dimensions_width": null,
      "dimensions_unit": "in",
      "dimensions_height": null,
      "volume_unit": "cu ft",
      "dimensions_notes": "",
      "has_complete_dimensions": false,
      "dimensions_packaged_length": null,
      "dimensions_packaged_width": null,
      "dimensions_packaged_height": null,
      "dimensions_packaged_notes": "",
      "weight": null,
      "weight_notes": "",
      "weight_packaged": null,
      "weight_packaged_notes": "",
      "integration_metadata_field_1": null,
      "integration_metadata_field_2": null,
      "integration_metadata_field_3": null,
      "integration_metadata_field_4": null,
      "integration_metadata_field_5": null,
      "asset_created_timestamp": "2030-01-02T17:00:00Z",
      "weight_unit": "lb",
      "tags": [],
      "optional_accessories": [],
      "custom_fields": [],
      "images": [],
      "reservations": null
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace.

Add an Asset #

Method
POST
Endpoint

Adds a new Asset.

Parameters
Name Type Required? Description Details
asset_type_id Number Yes
The type of Asset to create. Capital tracks one item; Collateral tracks quantities. The new Asset is Active, and its type cannot be changed later.
Allowed values: 1 (Capital) | 2 (Collateral)
name String No
The Asset name.
Up to 300 characters after text cleanup. Omitted, blank or null uses the name Asset.
default_storage_location_id Number When asset_type_id=1
The default Storage Location for a Capital Asset.
Use a Storage Location in your workspace. This changes the default setting, not inventory, and cannot be cleared. Collateral/Multi-quantity items don't have a default Storage Location; a value sent for one is ignored with a warning.
asset_reservation_policy_id Number No
For Capital, Strict blocks every day of an existing reservation, including checkout and return; Moderate allows those first and last days; Liberal allows overlaps. Omit to use your workspace default for Capital. Collateral always uses Liberal; any other value is refused.
Allowed values: 1 (Strict) | 2 (Moderate) | 3 (Liberal)
internal_identifier String No
Your internal identifier for the Asset.
Text, up to 100 characters.
make_or_model String No
The Asset’s type, make or model.
Text, up to 500 characters.
description String No
The Asset description as plain text.
Line breaks are retained. Both the saved value and the editor’s count must fit within 30,000 characters; encoded characters count toward these limits. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
storage_area String No
A more specific storage area, such as a shelf or bin.
Text, up to 500 characters. This does not move inventory.
pull_notes String No
Plain-text instructions for preparing or pulling this Asset.
Line breaks are retained. Both the saved value and the editor’s count must fit within 30,000 characters. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
cost Number or cost object No
The Asset cost, as a number or an object containing amount. 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
        }
      },
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
      "required": [
        "amount"
      ],
      "nullable": true
    },
    {
      "type": "string",
      "description": "Existing Asset numeric text is supported: an invariant decimal, including grouping separators and an exponent. Blank/null retain the documented omission/clear rules.",
      "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
  }
}
No cost center breakdowns. Omit on PATCH to keep the cost; new Assets default to zero.
dimensions_length Number No
The unpackaged length.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Omit for no measurement.
dimensions_width Number No
The unpackaged width.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Omit for no measurement.
dimensions_height Number No
The unpackaged height.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Omit for no measurement.
dimensions_notes String No
Notes about the unpackaged dimensions.
Text, up to 150 characters.
dimensions_packaged_length Number No
The packaged length.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Omit for no measurement.
dimensions_packaged_width Number No
The packaged width.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Omit for no measurement.
dimensions_packaged_height Number No
The packaged height.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Omit for no measurement.
dimensions_packaged_notes String No
Notes about the packaged dimensions.
Text, up to 150 characters.
weight Number No
The unpackaged weight.
A nonnegative number up to 99999999999999999.99 in your workspace’s weight unit, rounded to two decimal places. This does not change the unit setting. Omit for no measurement.
weight_notes String No
Notes about the unpackaged weight.
Text, up to 150 characters.
weight_packaged Number No
The packaged weight.
A nonnegative number up to 99999999999999999.99 in your workspace’s weight unit, rounded to two decimal places. This does not change the unit setting. Omit for no measurement.
weight_packaged_notes String No
Notes about the packaged weight.
Text, up to 150 characters.
integration_metadata_field_1 String No
A text value for your integration, such as an ID from another system.
Up to 3,000 characters. The value is not copied into history.
integration_metadata_field_2 String No
A text value for your integration, such as an ID from another system.
Up to 3,000 characters. The value is not copied into history.
integration_metadata_field_3 String No
A text value for your integration, such as an ID from another system.
Up to 3,000 characters. The value is not copied into history.
integration_metadata_field_4 String No
A text value for your integration, such as an ID from another system.
Up to 3,000 characters. The value is not copied into history.
integration_metadata_field_5 String No
A text value for your integration, such as an ID from another system.
Up to 3,000 characters. The value is not copied into history.
tags JSON object/list No
The complete list of tags for this Asset.
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": [
    "Conference",
    "Reusable"
  ]
}
Send an array of strings, such as ["Conference","Reusable"]. The same separator cleanup as the Asset page applies. A comma inside one entry of a JSON array splits it into separate tags, with a warning. Duplicate tags are combined without regard to case; each cleaned tag allows 30 characters. Omitted, blank, null or [] creates no tags. There is no fixed tag-count limit. asset_tags is an older name for this parameter and is still accepted; send one of them (if you send both, they must have the same value).
custom_NNNNNN Varies by field No
A visible Asset custom field.
The value depends on the configured field: text, a dropdown choice, a URL object or a date/time object. Replace NNNNNN with the field id from GET /v1/references/asset_custom_fields. Its digit count can vary. File fields use the separate file-attachment methods.
$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
Idempotency-Key String No
A unique key for safely repeating this create request.
Optional HTTP header: 1–255 visible ASCII characters, with no spaces. Reuse it only for the same request; the replay window is 24 hours.

Asset Custom Fields

You can also set the custom fields that your workspace has added to the Asset Info tab. The parameters depend on your workspace's fields, so they are not listed individually in the table above.

  1. Use GET /v1/references/asset_custom_fields to find each field's ID, name and type. For dropdown fields, the response also lists the available choices.
  2. Use custom_ followed by that field's ID as the parameter name. For example, field ID 12345 becomes custom_12345.
  3. Send the value in the format for that field's type, as shown below. You only need to include the fields you want to set.
Field typeWhat to send
TextA text value, such as "Inspected and ready". A multi-line text field also accepts line breaks.
DropdownOne of the field's configured choices, such as "Blue". Letter case and surrounding spaces are ignored.
URLAn object with url and an optional display_name, as in the example below.
Date or timeAn object containing the parts supported by that field. For example, a single-date field can use {"start_date":"2030-05-12"}. Dates use YYYY-MM-DD; times use HH:mm. Date ranges and date/time fields can also use their applicable end date, start/end times, time zone and notes.
FileUse the Asset custom-field file endpoints to upload or remove a file. Do not send file bytes in this request.

Example: update a text field and a URL field

Send the following JSON to PATCH /v1/assets, with your API key in the Authorization: Bearer header. Replace the example asset and field IDs with IDs from your workspace. The first custom field must be a text field and the second a URL field.

{
  "asset_id": 6789,
  "custom_12345": "Inspected and ready",
  "custom_67890": {
    "url": "https://example.com/assembly-guide",
    "display_name": "Assembly guide"
  }
}

When updating an asset, leaving a field out keeps its current value. To clear a field, send null; the common $ignore_params_with_empty_values option still applies. An empty string leaves the current value unchanged. Each field must match its configured type; you cannot change its type through this endpoint.

View technical schema and field limits

This is a schema describing the supported formats and limits. It is not an example request to copy. Only the format matching your field's configured type applies.

[
  {
    "namePattern": "^custom_\\d+$",
    "description": "Use a positive Int64 definition ID suffix. Repeated copies for the same ID count once when they match. Different copies are refused.",
    "schema": {
      "nullable": true,
      "anyOf": [
        {
          "type": "string",
          "description": "Text/rich text (1000000) or literal current dropdown option (3000000), selected by the current definition. Dropdown labels are not HTML-stripped."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "url": {
              "type": "string",
              "nullable": true,
              "maxLength": 4000
            },
            "display_name": {
              "type": "string",
              "nullable": true,
              "maxLength": 2000
            }
          },
          "x-asset-field-type-id": 5000000
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null.",
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4000000,
          "x-applicable-members": [
            "start_date",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4000000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null.",
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4100000,
          "x-applicable-members": [
            "start_date",
            "end_date",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4100000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4200000,
          "x-applicable-members": [
            "start_date",
            "start_time",
            "timezone",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4200000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4300000,
          "x-applicable-members": [
            "start_time",
            "timezone",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4300000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4400000,
          "x-applicable-members": [
            "start_date",
            "start_time",
            "end_time",
            "timezone",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4400000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4500000,
          "x-applicable-members": [
            "start_date",
            "end_date",
            "start_time",
            "end_time",
            "timezone",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4500000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        }
      ],
      "description": "Current owned visible transaction-locked Asset definitions select the shape. Unknown, mixed and repeated members, arrays and non-text members are refused. Empty URL/date objects clear. PATCH blank keeps the field; JSON null or text null clears. Optional POST blank/null is omitted. Plain text limit 2999; multiline rich text uses the existing 30000 inline limit, preserving/shortening existing longer values. File fields use scoped file operations.",
      "x-definition-validation": "Asset custom inputs use current owned visible definitions. Before saving custom fields, the API validates the type, applicable parts and literal dropdown choices. A refused update rolls back earlier changes from the same request.",
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants refused"
    }
  }
]

Good to know

Creates an Active Capital Asset or Collateral item. Capital Assets are individual reusable items, such as display stands; Collateral is tracked in quantities, such as brochures. Capital needs a default Storage Location; Collateral inventory is added separately.

Creating a Capital Asset or Collateral item

  1. Choose asset_type_id=1 for an individual Capital Asset, or 2 for quantity-tracked Collateral.
  2. For Capital, supply a default_storage_location_id; for Collateral it is ignored with a warning. Optionally choose a name, reservation policy, cost, measurements, tags and visible custom values.
  3. Save the returned Asset ID. Collateral starts without an inventory movement; add stock separately through the inventory-adjustment method.

Defaults and plan limits

An omitted, blank or null name becomes Asset. Cost defaults to zero. Capital uses your workspace’s default reservation policy; Collateral uses Liberal. Optional text is empty and omitted measurements have no value.

On the Lite and Professional plans, creating an Asset is refused if one of that type already exists, including an Archived Asset. This method does not create sharing settings, images, Optional Accessories, reservations or files.

Understanding the reservation policy

  • 1 — Strict: every day of an existing Capital reservation is blocked, including checkout and return.
  • 2 — Moderate: another reservation can use the checkout and return days; only the days between them are blocked. A one- or two-day reservation therefore blocks no days.
  • 3 — Liberal: overlapping reservations are allowed. Collateral always uses this policy.

Custom-field values and formats

Get the field id and type from GET /v1/references/asset_custom_fields. Add the custom_ prefix to the ID to form the input name. Sending an object does not change a text field into another type. Hidden, removed, foreign or unsupported definitions are refused.

Text and dropdown fields take JSON strings. Single-line text allows 2,999 saved characters; multiline text uses the same 30,000-character saved/editor limits as Description. An existing longer text value can be kept or shortened. Choose a current dropdown option; surrounding spaces and letter case do not affect the match.

URL fields take an object with url and optional display_name, both text or null. URL input allows 4,000 characters and the label 2,000. Line breaks and control separators are removed. If a nonempty URL lacks http:// or https://, http:// is added; an empty URL clears the whole value.

Date/time fields take an object containing only their enabled parts: start_date, end_date, start_time, end_time, timezone and notes. Members are optional text or null. Dates use YYYY-MM-DD; times use 24-hour HH:mm. The time-zone label allows 20 characters and notes 1,000. These are recorded calendar dates and wall-clock times, without conversion to UTC.

A supplied URL or date/time object replaces that custom value as a whole; it does not merge omitted object members into the old value. Partial ranges, reversed dates and overnight times follow the existing form. Omit an inapplicable part; a nonblank value for one is refused.

Sending custom fields

  1. Use GET /v1/references/asset_custom_fields to find the field id, type and any choices.
  2. For a text field with id 123456, send "custom_123456":"Checked and ready". For a dropdown field, send one of its returned choices as text.
  3. For a URL field, a value can be {"url":"https://example.com/setup","display_name":"Setup guide"}. For a date-only field, a value can be {"start_date":"2030-05-14","notes":"Annual inspection"}.
  4. Send each value under custom_ followed by the field id, as in the examples above. The IDs and field types in these examples are illustrative; they must match your workspace’s current definitions.

Receiving the result and repeating a request

A successful response contains the new Asset. Core fields, tags and supplied custom values are created together; an invalid value does not leave a partial Asset.

Use the optional Idempotency-Key header when you need to repeat the same create request safely. Keep the key and request unchanged; do not create a new key merely because the first response was interrupted. If the outcome could not be confirmed, retrieve the current state before repeating a create.

What happens after saving

Confirmed changes are recorded in Asset history and the activity feed. This request does not send business notifications or create an Event expense, payment or invoice. A history-writing error does not undo a saved change.

If the server reports that the outcome could not be confirmed, retrieve the current Asset before deciding what to do next. Do not assume the change was rolled back or automatically repeat it.

Code Samples
curl -X POST "https://api.exhibitday.com/v1/assets" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"asset_type_id\":1,\"name\":\"Sample Asset\",\"default_storage_location_id\":12345}"

Example response

{
  "workspace_id": 98765,
  "id": 6789,
  "asset_reservation_policy_id": 1,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Asset/98765?aid=6789",
  "internal_identifier": "",
  "asset_type_id": 1,
  "make_or_model": "",
  "asset_status_id": 1,
  "asset_status": "Active",
  "description": "",
  "name": "Sample Asset",
  "default_storage_location_id": 12345,
  "current_status": "Available / In Storage",
  "storage_location_name": "Main Warehouse",
  "returns_to_storage": "",
  "storage_location_address_display_name": "Boston, MA",
  "storage_area": "",
  "pull_notes": "",
  "status_message": null,
  "in_progress_reservation_count": 0,
  "quantity_available_in_storage": 1,
  "status_message_expires": null,
  "projected_future_balance": 1,
  "cost": {
    "amount": 0.00
  },
  "current_storage_footprint": 0.00,
  "dimensions_length": null,
  "projected_future_footprint": 0.00,
  "dimensions_width": null,
  "dimensions_unit": "in",
  "dimensions_height": null,
  "volume_unit": "cu ft",
  "dimensions_notes": "",
  "has_complete_dimensions": false,
  "dimensions_packaged_length": null,
  "dimensions_packaged_width": null,
  "dimensions_packaged_height": null,
  "dimensions_packaged_notes": "",
  "weight": null,
  "weight_notes": "",
  "weight_packaged": null,
  "weight_packaged_notes": "",
  "integration_metadata_field_1": null,
  "integration_metadata_field_2": null,
  "integration_metadata_field_3": null,
  "integration_metadata_field_4": null,
  "integration_metadata_field_5": null,
  "asset_created_timestamp": "2030-01-02T17:00:00Z",
  "weight_unit": "lb",
  "tags": [],
  "optional_accessories": [],
  "custom_fields": [],
  "images": [],
  "reservations": null
}
Note: IDs are illustrative; use IDs from your workspace.

Update an Asset #

Method
PATCH
Endpoint

Updates an existing Asset.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Asset to update.
asset_type_id Number No
Optionally confirm the existing Asset type. Capital tracks one item; Collateral tracks quantities. If supplied, it must match; the type cannot be changed or cleared.
Allowed values: 1 (Capital) | 2 (Collateral)
name String No
The Asset name.
Up to 300 characters after text cleanup. Cannot be cleared.
default_storage_location_id Number No
The default Storage Location for a Capital Asset.
Use a Storage Location in your workspace. This changes the default setting, not inventory, and cannot be cleared. Collateral/Multi-quantity items don't have a default Storage Location; a value sent for one is ignored with a warning.
asset_reservation_policy_id Number No
For Capital, Strict blocks every day of an existing reservation, including checkout and return; Moderate allows those first and last days; Liberal allows overlaps. Collateral only accepts Liberal. Omit to keep the current policy. It cannot be cleared.
Allowed values: 1 (Strict) | 2 (Moderate) | 3 (Liberal)
internal_identifier String No
Your internal identifier for the Asset.
Text, up to 100 characters.
make_or_model String No
The Asset’s type, make or model.
Text, up to 500 characters.
description String No
The Asset description as plain text.
Line breaks are retained. Both the saved value and the editor’s count must fit within 30,000 characters; encoded characters count toward these limits. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
storage_area String No
A more specific storage area, such as a shelf or bin.
Text, up to 500 characters. This does not move inventory.
pull_notes String No
Plain-text instructions for preparing or pulling this Asset.
Line breaks are retained. Both the saved value and the editor’s count must fit within 30,000 characters. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
cost Number or cost object No
The Asset cost, as a number or an object containing amount. 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
        }
      },
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
      "required": [
        "amount"
      ],
      "nullable": true
    },
    {
      "type": "string",
      "description": "Existing Asset numeric text is supported: an invariant decimal, including grouping separators and an exponent. Blank/null retain the documented omission/clear rules.",
      "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
  }
}
No cost center breakdowns. Omit on PATCH to keep the cost; new Assets default to zero.
dimensions_length Number No
The unpackaged length.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Null clears the measurement.
dimensions_width Number No
The unpackaged width.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Null clears the measurement.
dimensions_height Number No
The unpackaged height.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Null clears the measurement.
dimensions_notes String No
Notes about the unpackaged dimensions.
Text, up to 150 characters.
dimensions_packaged_length Number No
The packaged length.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Null clears the measurement.
dimensions_packaged_width Number No
The packaged width.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Null clears the measurement.
dimensions_packaged_height Number No
The packaged height.
A nonnegative number up to 99999999999999999.99 in your workspace’s dimension unit, rounded to two decimal places. This does not change the unit setting. Null clears the measurement.
dimensions_packaged_notes String No
Notes about the packaged dimensions.
Text, up to 150 characters.
weight Number No
The unpackaged weight.
A nonnegative number up to 99999999999999999.99 in your workspace’s weight unit, rounded to two decimal places. This does not change the unit setting. Null clears the measurement.
weight_notes String No
Notes about the unpackaged weight.
Text, up to 150 characters.
weight_packaged Number No
The packaged weight.
A nonnegative number up to 99999999999999999.99 in your workspace’s weight unit, rounded to two decimal places. This does not change the unit setting. Null clears the measurement.
weight_packaged_notes String No
Notes about the packaged weight.
Text, up to 150 characters.
integration_metadata_field_1 String No
A text value for your integration, such as an ID from another system.
Up to 3,000 characters. The value is not copied into history.
integration_metadata_field_2 String No
A text value for your integration, such as an ID from another system.
Up to 3,000 characters. The value is not copied into history.
integration_metadata_field_3 String No
A text value for your integration, such as an ID from another system.
Up to 3,000 characters. The value is not copied into history.
integration_metadata_field_4 String No
A text value for your integration, such as an ID from another system.
Up to 3,000 characters. The value is not copied into history.
integration_metadata_field_5 String No
A text value for your integration, such as an ID from another system.
Up to 3,000 characters. The value is not copied into history.
tags JSON object/list No
The complete list of tags for this Asset.
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": [
    "Conference",
    "Reusable"
  ]
}
Send an array of strings, such as ["Conference","Reusable"]. The same separator cleanup as the Asset page applies. A comma inside one entry of a JSON array splits it into separate tags, with a warning. Duplicate tags are combined without regard to case; each cleaned tag allows 30 characters. This replaces the old list. Use [] or null to clear it. There is no fixed tag-count limit. asset_tags is an older name for this parameter and is still accepted; send one of them (if you send both, they must have the same value).
custom_NNNNNN Varies by field No
A visible Asset custom field.
The value depends on the configured field: text, a dropdown choice, a URL object or a date/time object. Replace NNNNNN with the field id from GET /v1/references/asset_custom_fields. Its digit count can vary. File fields use the separate file-attachment methods.
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.
Optional. Blank, null, malformed or conflicting copies are refused with HTTP 400. A stale revision returns HTTP 409 with error_code=record_changed.
$ignore_params_with_empty_values Boolean No
Whether to ignore empty values instead of applying their empty-value meaning.
Default: false. With true, real JSON null and blank values are omitted. The text "null" still clears a clearable field. This does not hide an invalid expected_revision.

Asset Custom Fields

You can also set the custom fields that your workspace has added to the Asset Info tab. The parameters depend on your workspace's fields, so they are not listed individually in the table above.

  1. Use GET /v1/references/asset_custom_fields to find each field's ID, name and type. For dropdown fields, the response also lists the available choices.
  2. Use custom_ followed by that field's ID as the parameter name. For example, field ID 12345 becomes custom_12345.
  3. Send the value in the format for that field's type, as shown below. You only need to include the fields you want to set.
Field typeWhat to send
TextA text value, such as "Inspected and ready". A multi-line text field also accepts line breaks.
DropdownOne of the field's configured choices, such as "Blue". Letter case and surrounding spaces are ignored.
URLAn object with url and an optional display_name, as in the example below.
Date or timeAn object containing the parts supported by that field. For example, a single-date field can use {"start_date":"2030-05-12"}. Dates use YYYY-MM-DD; times use HH:mm. Date ranges and date/time fields can also use their applicable end date, start/end times, time zone and notes.
FileUse the Asset custom-field file endpoints to upload or remove a file. Do not send file bytes in this request.

Example: update a text field and a URL field

Send the following JSON to PATCH /v1/assets, with your API key in the Authorization: Bearer header. Replace the example asset and field IDs with IDs from your workspace. The first custom field must be a text field and the second a URL field.

{
  "asset_id": 6789,
  "custom_12345": "Inspected and ready",
  "custom_67890": {
    "url": "https://example.com/assembly-guide",
    "display_name": "Assembly guide"
  }
}

When updating an asset, leaving a field out keeps its current value. To clear a field, send null; the common $ignore_params_with_empty_values option still applies. An empty string leaves the current value unchanged. Each field must match its configured type; you cannot change its type through this endpoint.

View technical schema and field limits

This is a schema describing the supported formats and limits. It is not an example request to copy. Only the format matching your field's configured type applies.

[
  {
    "namePattern": "^custom_\\d+$",
    "description": "Use a positive Int64 definition ID suffix. Repeated copies for the same ID count once when they match. Different copies are refused.",
    "schema": {
      "nullable": true,
      "anyOf": [
        {
          "type": "string",
          "description": "Text/rich text (1000000) or literal current dropdown option (3000000), selected by the current definition. Dropdown labels are not HTML-stripped."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "url": {
              "type": "string",
              "nullable": true,
              "maxLength": 4000
            },
            "display_name": {
              "type": "string",
              "nullable": true,
              "maxLength": 2000
            }
          },
          "x-asset-field-type-id": 5000000
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null.",
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4000000,
          "x-applicable-members": [
            "start_date",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4000000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null.",
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4100000,
          "x-applicable-members": [
            "start_date",
            "end_date",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4100000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4200000,
          "x-applicable-members": [
            "start_date",
            "start_time",
            "timezone",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4200000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4300000,
          "x-applicable-members": [
            "start_time",
            "timezone",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4300000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "pattern": "^\\s*$",
              "description": "Not applicable to this definition; omit or supply blank/null."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4400000,
          "x-applicable-members": [
            "start_date",
            "start_time",
            "end_time",
            "timezone",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4400000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "start_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "end_date": {
              "type": "string",
              "nullable": true,
              "description": "YYYY-MM-DD calendar date, blank or null; no UTC conversion."
            },
            "start_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "end_time": {
              "type": "string",
              "nullable": true,
              "description": "24-hour HH:mm local wall-clock time, blank or null; no UTC conversion."
            },
            "timezone": {
              "type": "string",
              "nullable": true,
              "maxLength": 20
            },
            "notes": {
              "type": "string",
              "nullable": true,
              "maxLength": 1000
            }
          },
          "x-asset-field-type-id": 4500000,
          "x-applicable-members": [
            "start_date",
            "end_date",
            "start_time",
            "end_time",
            "timezone",
            "notes"
          ],
          "description": "Selected only by current owned visible definition type 4500000. Parts are independent and optional; partial/reversed ranges and overnight times follow the existing form."
        }
      ],
      "description": "Current owned visible transaction-locked Asset definitions select the shape. Unknown, mixed and repeated members, arrays and non-text members are refused. Empty URL/date objects clear. PATCH blank keeps the field; JSON null or text null clears. Optional POST blank/null is omitted. Plain text limit 2999; multiline rich text uses the existing 30000 inline limit, preserving/shortening existing longer values. File fields use scoped file operations.",
      "x-definition-validation": "Asset custom inputs use current owned visible definitions. Before saving custom fields, the API validates the type, applicable parts and literal dropdown choices. A refused update rolls back earlier changes from the same request.",
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants refused"
    }
  }
]

Good to know

Updates an Asset’s details, tags and visible custom-field values. Send only the fields you want to change. Its type stays the same, and changing its default Storage Location does not move inventory.

Updating only the values you mean to change

Omit a field to keep its current value. A blank or whitespace-only value also keeps it and may add an empty-field warning. For a clearable field, real JSON null or the text "null" clears it; cost resets to zero. Name, type, default Storage Location and reservation policy cannot be cleared.

With $ignore_params_with_empty_values=true, a real JSON null is omitted instead of clearing. The text "null" still asks to clear. A supplied tag list replaces the old list; [] is an explicit clear.

Core fields, tags and supplied custom values are saved together. An invalid value refuses the change rather than saving the other fields. An unchanged saved result returns No changes were made.

Storage, measurements and existing long text

A new default Storage Location must belong to your workspace. Omitting the setting keeps the current default. Changing this setting does not move the Asset or its inventory.

Measurements use the units already configured for your workspace. Description and Pull Notes accept plain text, preserve line breaks and store safe formatting. Existing text above a normal limit can be kept or shortened, but cannot grow beyond the existing allowed count.

Understanding the reservation policy

  • 1 — Strict: every day of an existing Capital reservation is blocked, including checkout and return.
  • 2 — Moderate: another reservation can use the checkout and return days; only the days between them are blocked. A one- or two-day reservation therefore blocks no days.
  • 3 — Liberal: overlapping reservations are allowed. Collateral always uses this policy.

Custom-field values and formats

Get the field id and type from GET /v1/references/asset_custom_fields. Add the custom_ prefix to the ID to form the input name. Sending an object does not change a text field into another type. Hidden, removed, foreign or unsupported definitions are refused.

Text and dropdown fields take JSON strings. Single-line text allows 2,999 saved characters; multiline text uses the same 30,000-character saved/editor limits as Description. An existing longer text value can be kept or shortened. Choose a current dropdown option; surrounding spaces and letter case do not affect the match.

URL fields take an object with url and optional display_name, both text or null. URL input allows 4,000 characters and the label 2,000. Line breaks and control separators are removed. If a nonempty URL lacks http:// or https://, http:// is added; an empty URL clears the whole value.

Date/time fields take an object containing only their enabled parts: start_date, end_date, start_time, end_time, timezone and notes. Members are optional text or null. Dates use YYYY-MM-DD; times use 24-hour HH:mm. The time-zone label allows 20 characters and notes 1,000. These are recorded calendar dates and wall-clock times, without conversion to UTC.

A supplied URL or date/time object replaces that custom value as a whole; it does not merge omitted object members into the old value. Partial ranges, reversed dates and overnight times follow the existing form. Omit an inapplicable part; a nonblank value for one is refused.

Sending custom fields

  1. Use GET /v1/references/asset_custom_fields to find the field id, type and any choices.
  2. For a text field with id 123456, send "custom_123456":"Checked and ready". For a dropdown field, send one of its returned choices as text.
  3. For a URL field, a value can be {"url":"https://example.com/setup","display_name":"Setup guide"}. For a date-only field, a value can be {"start_date":"2030-05-14","notes":"Annual inspection"}.
  4. Send each value under custom_ followed by the field id, as in the examples above. The IDs and field types in these examples are illustrative; they must match your workspace’s current definitions.

Avoiding overwriting another change

This revision covers the editable Asset fields, tags, custom values and sharing settings. It does not cover availability, reservations, Optional Accessories, images or file contents. A successful request includes the new record_revision only when expected_revision was supplied.

  1. Retrieve this Asset through /v1/assets/info, using its id and $include_record_revision=true.
  2. Send that response’s record_revision as expected_revision with this request. Treat it as an opaque value.
  3. If the API returns HTTP 409 with error_code=record_changed, retrieve the current Asset, review it and decide whether to send the request again. The API does not retry it for you.

What happens after saving

Confirmed changes are recorded in Asset history and the activity feed. This request does not send business notifications or create an Event expense, payment or invoice. A history-writing error does not undo a saved change.

If the server reports that the outcome could not be confirmed, retrieve the current Asset before deciding what to do next. Do not assume the change was rolled back or automatically repeat it.

Code Samples
curl -X PATCH "https://api.exhibitday.com/v1/assets" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"name\":\"Updated asset name\"}"

Example response

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

Archive an Asset #

Method
POST
Endpoint

Archives an Asset.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Asset to archive.
unshare_on_archive Boolean No
Whether to remove the Asset’s sharing settings.
Default: true. A blank value uses the default. Send false to keep the sharing settings. JSON null is refused.
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.
Optional. Blank, null, malformed or conflicting copies are refused with HTTP 400. A stale revision returns HTTP 409 with error_code=record_changed.

Good to know

Marks an Asset as Archived and, by default, stops sharing it with other workspaces. Choose whether to keep its sharing settings. Upcoming reservations can prevent archiving.

Before archiving

Capital cannot be archived while it has an upcoming or in-progress reservation, including an Other Purpose reservation. Collateral cannot be archived while it has a future Event reservation. Manual inventory adjustments do not count as Event reservations for this check.

The checks also run when the Asset is already Archived. Archiving does not cancel reservations, move inventory or delete files.

Choosing what happens to sharing

  • Omit unshare_on_archive, or send true, to remove sharing settings. This also removes remaining shares on an already Archived Asset.
  • Send unshare_on_archive=false to retain the current sharing settings. Restoring the Asset later does not recreate shares that were removed.

Avoiding overwriting another change

This revision covers the editable Asset fields, tags, custom values and sharing settings. It does not cover availability, reservations, Optional Accessories, images or file contents. A successful request includes the new record_revision only when expected_revision was supplied.

  1. Retrieve this Asset through /v1/assets/info, using its id and $include_record_revision=true.
  2. Send that response’s record_revision as expected_revision with this request. Treat it as an opaque value.
  3. If the API returns HTTP 409 with error_code=record_changed, retrieve the current Asset, review it and decide whether to send the request again. The API does not retry it for you.

Sending this action

Do not send Idempotency-Key: this conditional action does not accept that header. The optional expected_revision protects against another change; it is not an idempotency key.

The response is a status object. If there is a real change it is recorded in history; a true no-op preserves the revision.

What happens after saving

Confirmed changes are recorded in Asset history and the activity feed. This request does not send business notifications or create an Event expense, payment or invoice. A history-writing error does not undo a saved change.

If the server reports that the outcome could not be confirmed, retrieve the current Asset before deciding what to do next. Do not assume the change was rolled back or automatically repeat it.

Code Samples
curl -X POST "https://api.exhibitday.com/v1/assets/archive" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345}"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Asset archived.",
  "errors": []
}

Restore an Archived Asset #

Method
POST
Endpoint

Makes an Archived Asset Active again.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Asset to restore.
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.
Optional. Blank, null, malformed or conflicting copies are refused with HTTP 400. A stale revision returns HTTP 409 with error_code=record_changed.

Good to know

Makes an Archived Asset Active again, so it can be used normally. It does not restore sharing settings or other records that were previously removed.

What restoring changes

The Asset becomes Active again. Restoring does not recreate removed sharing settings, deleted records, inventory movements or cancelled reservations.

If it is already Active and nothing changes, the request returns No changes were made and does not add another history entry.

Avoiding overwriting another change

This revision covers the editable Asset fields, tags, custom values and sharing settings. It does not cover availability, reservations, Optional Accessories, images or file contents. A successful request includes the new record_revision only when expected_revision was supplied.

  1. Retrieve this Asset through /v1/assets/info, using its id and $include_record_revision=true.
  2. Send that response’s record_revision as expected_revision with this request. Treat it as an opaque value.
  3. If the API returns HTTP 409 with error_code=record_changed, retrieve the current Asset, review it and decide whether to send the request again. The API does not retry it for you.

Sending this action

Do not send Idempotency-Key: this conditional action does not accept that header. The optional expected_revision protects against another change; it is not an idempotency key.

The response is a status object. If there is a real change it is recorded in history; a true no-op preserves the revision.

What happens after saving

Confirmed changes are recorded in Asset history and the activity feed. This request does not send business notifications or create an Event expense, payment or invoice. A history-writing error does not undo a saved change.

If the server reports that the outcome could not be confirmed, retrieve the current Asset before deciding what to do next. Do not assume the change was rolled back or automatically repeat it.

Code Samples
curl -X POST "https://api.exhibitday.com/v1/assets/unarchive" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345}"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Asset unarchived.",
  "errors": []
}

Retrieve an Asset Custom File Attachment #

Method
GET
Endpoint

Retrieves the File Attachment details in an Asset's custom File field.

Parameters
Name Type Required? Description Details
asset_id Number Yes
The ID of the Asset, from Retrieve Assets (GET /v1/assets) or its create response.
The Asset must be owned by your workspace. Sharing an Asset does not grant access to its custom files here.
field_name String Yes
The custom File field to retrieve or change.
Use the File field ID with the custom_ prefix, for example custom_12345. GET /v1/references/asset_custom_fields lists File field definitions, including hidden fields by default. The ID after custom_ must be positive with no leading zeros; the whole name is at most 26 characters. Use the query string, a header or a form field. Matching copies of the same selector count once. Copies with different values are refused. Cookies and JSON-body selectors do not select these file fields.
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 an Asset's selected custom File field and its attached-file details. An empty field returns file_attachment: null.

Choosing a custom File field

This is a workspace-defined File field on the Asset's Information tab. Select the field with field_name; no attachment ID or tab flag is needed. Other custom fields, standard Event documents and cost invoices use their own methods.

In GET /v1/assets/custom_fields/file_attachment, is_hidden indicates whether the field is hidden on the form. You can select a known hidden File field if your access permits it.

Reading the field

The response identifies field_name and field_label, with file metadata in file_attachment. A valid empty field returns HTTP 200 with file_attachment set to null. A populated field includes the file's id, filename and attachment_created_timestamp. Use the download method for its contents.

Conflicting duplicate saved values or an invalid file reference are refused; the API does not choose a value or expose another record's file.

Access

Current Assets read access is required. The Asset must belong to your workspace; archived Assets follow the same file permissions. Permitted reads remain available on the Free plan.

Code Samples
curl -X GET "https://api.exhibitday.com/v1/assets/custom_fields/file_attachment?asset_id=12345&field_name=custom_12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "field_name": "custom_12345",
  "field_label": "Integration status",
  "is_hidden": false,
  "file_attachment": {
    "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 an Asset Custom File Attachment #

Method
POST
Endpoint

Adds a File Attachment to an Asset's custom File field.

Parameters
Name Type Required? Description Details
asset_id Number Yes
The ID of the Asset, from Retrieve Assets (GET /v1/assets) or its create response.
The Asset must be owned by your workspace. Sharing an Asset does not grant access to its custom files here.
field_name String Yes
The custom File field to retrieve or change.
Use the File field ID with the custom_ prefix, for example custom_12345. GET /v1/references/asset_custom_fields lists File field definitions, including hidden fields by default. The ID after custom_ must be positive with no leading zeros; the whole name is at most 26 characters. Use the query string, a header or a form field. Matching copies of the same selector count once. Copies with different values are refused. Cookies and JSON-body selectors do not select these file fields.
file File (multipart) Yes
The Asset Custom File 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 part named file. Supported types and the current per-file limit are shown below; the complete request limit also includes multipart overhead. A website link, missing file or null file does not upload or remove a file.
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 File Attachment to an empty custom File field on an Asset. Use PATCH to replace a file that is already attached.

Choosing a custom File field

This is a workspace-defined File field on the Asset's Information tab. Select the field with field_name; no attachment ID or tab flag is needed. Other custom fields, standard Event documents and cost invoices use their own methods.

In GET /v1/assets/custom_fields/file_attachment, is_hidden indicates whether the field is hidden on the form. You can select a known hidden File field if your access permits it.

Before you upload

POST requires an empty field. An occupied field returns HTTP 409, including one holding an unavailable saved reference. Use PATCH to replace a valid existing file.

The selected field and its current binding are checked again before saving. If the definition, value or file changes during your upload, the request is refused instead of replacing a different file.

After the upload

The response includes the selected field and the new file's metadata. Only this selected custom File field changes. A successful change is recorded in Asset history.

Use DELETE to remove a file; an empty or null upload is invalid and is not a removal request.

Access and retries

Current Asset edit access and an upload-enabled paid plan are required. The standard Event Information documents' Free-plan upload exception does not apply to custom File fields.

expected_revision is not supported by this file method. If the save outcome cannot be confirmed, retrieve this field's current metadata before deciding whether to submit another change.

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/assets/custom_fields/file_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "asset_id=12345" --form-string "field_name=custom_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

{
  "field_name": "custom_12345",
  "field_label": "Integration status",
  "is_hidden": false,
  "file_attachment": {
    "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.

Replace an Asset Custom File Attachment #

Method
PATCH
Endpoint

Replaces the File Attachment in an Asset's custom File field.

Parameters
Name Type Required? Description Details
asset_id Number Yes
The ID of the Asset, from Retrieve Assets (GET /v1/assets) or its create response.
The Asset must be owned by your workspace. Sharing an Asset does not grant access to its custom files here.
field_name String Yes
The custom File field to retrieve or change.
Use the File field ID with the custom_ prefix, for example custom_12345. GET /v1/references/asset_custom_fields lists File field definitions, including hidden fields by default. The ID after custom_ must be positive with no leading zeros; the whole name is at most 26 characters. Use the query string, a header or a form field. Matching copies of the same selector count once. Copies with different values are refused. Cookies and JSON-body selectors do not select these file fields.
file File (multipart) Yes
The Asset Custom File 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 part named file. Supported types and the current per-file limit are shown below; the complete request limit also includes multipart overhead. A website link, missing file or null file does not upload or remove a file.

Good to know

Replaces the File Attachment in an Asset's selected custom File field. A valid existing file is required.

Choosing a custom File field

This is a workspace-defined File field on the Asset's Information tab. Select the field with field_name; no attachment ID or tab flag is needed. Other custom fields, standard Event documents and cost invoices use their own methods.

In GET /v1/assets/custom_fields/file_attachment, is_hidden indicates whether the field is hidden on the form. You can select a known hidden File field if your access permits it.

Replacing the current file

PATCH requires a valid current file. An empty field returns HTTP 404; a malformed or unavailable saved reference is refused. The replacement receives a new file ID even when its contents are identical.

The selected field and its current binding are checked again before saving. If the definition, value or file changes during your upload, the request is refused instead of replacing a different file.

After the replacement

The response includes the selected field and the new file's metadata. Only this selected custom File field changes. A successful change is recorded in Asset history.

An old file that is safe to remove is scheduled for physical cleanup after the save; cleanup may finish later. Other fields and items that still own that file retain their references and file.

Access and retries

Current Asset edit access and an upload-enabled paid plan are required. The standard Event Information documents' Free-plan upload exception does not apply to custom File fields.

expected_revision is not supported by this file method. PATCH does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve this field's current metadata before deciding whether to submit another change.

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/assets/custom_fields/file_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "asset_id=12345" --form-string "field_name=custom_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

{
  "field_name": "custom_12345",
  "field_label": "Integration status",
  "is_hidden": false,
  "file_attachment": {
    "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 an Asset Custom File Attachment #

Method
DELETE
Endpoint

Deletes the File Attachment from an Asset's custom File field.

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
asset_id Number Yes
The ID of the Asset, from Retrieve Assets (GET /v1/assets) or its create response.
The Asset must be owned by your workspace. Sharing an Asset does not grant access to its custom files here.
field_name String Yes
The custom File field to retrieve or change.
Use the File field ID with the custom_ prefix, for example custom_12345. GET /v1/references/asset_custom_fields lists File field definitions, including hidden fields by default. The ID after custom_ must be positive with no leading zeros; the whole name is at most 26 characters. Use the query string, a header or a form field. Matching copies of the same selector count once. Copies with different values are refused. Cookies and JSON-body selectors do not select these file fields.

Good to know

Removes the File Attachment from an Asset's selected custom File field. If the field is already empty, the response is 404 Not Found and nothing changes.

Choosing a custom File field

This is a workspace-defined File field on the Asset's Information tab. Select the field with field_name; no attachment ID or tab flag is needed. Other custom fields, standard Event documents and cost invoices use their own methods.

In GET /v1/assets/custom_fields/file_attachment, is_hidden indicates whether the field is hidden on the form. You can select a known hidden File field if your access permits it.

After the removal

Only the selected custom File field is cleared. If the field is already empty, DELETE returns HTTP 404 Not Found and changes no saved metadata or history. A real change is recorded in Asset history.

DELETE can also clear a single malformed, dangling or foreign saved reference while leaving that other file untouched. Files still referenced by another field or a structured record are preserved. Conflicting duplicate saved values return HTTP 409 rather than choosing which value to clear.

An unshared owned file that is safe to remove is scheduled for physical cleanup after the save; cleanup may finish later. Other custom fields, Asset information and standard documents stay in place.

Access and retries

Current Asset edit access and attachment add/remove permission are required. Permitted removals remain available on the Free plan. Do not send file parts with DELETE.

expected_revision is not supported, and DELETE does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve this field's current metadata before deciding whether to submit another change.

Code Samples
curl -X DELETE "https://api.exhibitday.com/v1/assets/custom_fields/file_attachment?asset_id=12345&field_name=custom_12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Custom File field cleared.",
  "errors": []
}

Download an Asset Custom File Attachment #

Method
GET
Endpoint

Downloads the file in an Asset's custom File field.

Parameters
Name Type Required? Description Details
asset_id Number Yes
The ID of the Asset, from Retrieve Assets (GET /v1/assets) or its create response.
The Asset must be owned by your workspace. Sharing an Asset does not grant access to its custom files here.
field_name String Yes
The custom File field to retrieve or change.
Use the File field ID with the custom_ prefix, for example custom_12345. GET /v1/references/asset_custom_fields lists File field definitions, including hidden fields by default. The ID after custom_ must be positive with no leading zeros; the whole name is at most 26 characters. Use the query string, a header or a form field. Matching copies of the same selector count once. Copies with different values are refused. Cookies and JSON-body selectors do not select these file fields.

Choosing a custom File field

This is a workspace-defined File field on the Asset's Information tab. Select the field with field_name; no attachment ID or tab flag is needed. Other custom fields, standard Event documents and cost invoices use their own methods.

In GET /v1/assets/custom_fields/file_attachment, is_hidden indicates whether the field is hidden on the form. You can select a known hidden File field if your access permits it.

Download response

A successful response contains the original uploaded file with a safe download filename. An empty field returns HTTP 404; API errors use the usual JSON response.

Conflicting duplicate saved values or an invalid file reference are refused; the API does not choose a value or expose another record's file.

Access

Current Assets read access is required. The Asset must belong to your workspace; archived Assets follow the same file permissions. Permitted reads 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.

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/assets/custom_fields/file_attachment/download?asset_id=12345&field_name=custom_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.