Workspace Settings

Retrieve Workspace Settings #

Method
GET
Endpoint
Sample Object

Retrieves your workspace settings.

Parameters
Name Type Required? Description Details
include_available_options Boolean No
Include the available currency, time-zone and fiscal-year start-month choices. The default is false; available_options is null unless requested.
Default: false.
$include_record_revision Boolean No
Set to true to include record_revision in the response. Send that value as expected_revision when updating to check for conflicting changes.
Default: false.
$result_format String No
By default, the response is a single object. Send array to get it inside a one-item array.
Allowed values: array | object
$ignore_params_with_empty_values Boolean No
Set to true to ignore blank values and JSON null. Text null is not ignored. All supplied copies of this option must agree.
Default: false.

Good to know

The response includes display preferences, units of measure, available features, currency and the budget-year basis.

Available features and choices

Unavailable Task Workflows and AI Assistant controls return null. This differs from an available control whose saved value is Disabled.

Set include_available_options=true to retrieve accepted currencies, time zones and fiscal-year start months. Without this option, available_options is null.

Updating settings

workspace_currency_code and workspace_currency_symbol describe the currency currently used by this workspace. They are read-only. workspace_currency_id and workspace_fiscal_year_start_month can be changed with PATCH.

Changing the currency changes the symbol shown on all amounts; the numbers are not converted. Changing the fiscal-year start month changes which budget year each cost belongs to. This affects Annual Budget and Metrics reports and API results grouped or filtered by budget year.

GET /v1/references/workspace_info remains the separate simple workspace summary.

  1. Retrieve these settings with $include_record_revision=true if you want to check for intervening changes.
  2. Send PATCH to this same URL with the fields you want to change and, optionally, that expected_revision.
Code Samples
curl -X GET "https://api.exhibitday.com/v1/workspace_settings" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "name": "Sample Events Team",
  "timezone_id": "UTC",
  "workspace_currency_id": 1,
  "workspace_currency_code": "USD",
  "workspace_currency_symbol": "$",
  "user_display_name_format_id": 1,
  "attendee_double_book_warning_mode_id": 1,
  "is_activity_feed_enabled": true,
  "is_event_id_display_enabled": false,
  "event_cards_view_mode_id": 1,
  "task_workflows_mode_id": 1,
  "user_permission_denial_behavior_type_id": 1,
  "related_items_summary_mode_id": 1,
  "asset_weight_unit_type_id": 1,
  "asset_dimensions_unit_type_id": 1,
  "workspace_fiscal_year_start_month": 1,
  "ai_chatbot_availability_type_id": 1,
  "available_options": null,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Settings/98765"
}

Update Workspace Settings #

Method
PATCH
Endpoint

Updates your workspace settings.

Parameters
Name Type Required? Description Details
name String No
The workspace name. A changed name must have 1 to 30 characters, excluding surrounding spaces. Some emoji count as more than one character. A blank name keeps the current name and returns a warning; your other changes are still saved.
max length: 30
timezone_id String No
The ID of a time zone in available_options.timezones. IDs are matched without regard to case or surrounding spaces and saved with the listed spelling.
workspace_currency_id Number No
The currency used to display workspace amounts. Choose an ID from available_options.currencies. Changing the currency changes the symbol shown on all amounts; the numbers are not converted.
user_display_name_format_id Number No
Choose First Last to show the given name before the family name, or Last, First to show the family name first.
Allowed values: 1 (First Last) | 2 (Last, First)
attendee_double_book_warning_mode_id Number No
Smart considers each Event's Participation Status before warning about overlapping attendee bookings. Strict warns for all such overlaps. Disabled turns these warnings off.
Allowed values: 1 (Smart) | 2 (Strict) | 3 (Disabled)
is_activity_feed_enabled Boolean No
Whether the Recent Activity Feed is enabled.
is_event_id_display_enabled Boolean No
Whether Event IDs are displayed.
event_cards_view_mode_id Number No
Choose Compact for smaller Event cards or Expanded for larger cards.
Allowed values: 1 (Compact) | 2 (Expanded)
task_workflows_mode_id Number No
Task Workflows define actions that run when a task is complete. Enhanced can also prompt users to create a relevant task, such as reserving an Event booth. Choose Enhanced, Enabled or Disabled. Send a different value only when GET returns a number for this field. null means this feature is unavailable in your workspace.
Allowed values: 1 (Enhanced) | 2 (Enabled) | 3 (Disabled)
user_permission_denial_behavior_type_id Number No
For Team Members and Guests, show an Access Denied message when an area is unavailable, or hide the unavailable area.
Allowed values: 1 (show an Access Denied message) | 2 (hide unavailable areas)
related_items_summary_mode_id Number No
Hide Summary Details keeps linked-item summaries hidden from users who cannot view the item. Show Limited Summaries lets them see a brief summary without granting access to the full item.
Allowed values: 1 (Hide Summary Details) | 2 (Show Limited Summaries)
asset_weight_unit_type_id Number No
Choose Pounds or Kilograms for weight. Changing this preference does not rescale stored measurements.
Allowed values: 1 (Pounds) | 2 (Kilograms)
asset_dimensions_unit_type_id Number No
Choose Inches / Cubic Feet or Centimeters / Cubic Meters for dimensions and volume. Changing this preference does not rescale stored measurements.
Allowed values: 1 (Inches / Cubic Feet) | 2 (Centimeters / Cubic Meters)
workspace_fiscal_year_start_month Number No
The month in which the budget year starts. Changing it changes which budget year each cost belongs to. This affects Annual Budget and Metrics reports and API results grouped or filtered by budget year.
Allowed values: 1 (calendar year, January through December) | 2 (February) | 3 (March) | 4 (April) | 5 (May) | 6 (June) | 7 (July) | 8 (August) | 9 (September) | 10 (October) | 11 (November) | 12 (December)
ai_chatbot_availability_type_id Number No
This setting is for Planna (ExhibitDay's AI Assistant / Chatbot). Data-restricted answers questions about ExhibitDay features. Data-enabled can use workspace data. Disabled turns the AI Assistant off. Send a different value only when GET returns a number for this field. null means this feature is unavailable in your workspace.
Allowed values: 1 (Data-restricted: answers about ExhibitDay features only) | 2 (Data-enabled: can use your workspace data) | 3 (Disabled)
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.
$ignore_params_with_empty_values Boolean No
Set to true to ignore blank values and JSON null. Text null is not ignored. All supplied copies of this option must agree.
Default: false.

Good to know

Updates the workspace settings you supply. Omitted settings keep their saved values.

Saving changes

Send the settings you want to change. Omitted settings, blank Boolean settings and a blank name keep their saved values; a blank name returns a warning. A supplied value that equals the saved value is a no-op, including an unchanged legacy name over 30 characters and an unavailable feature's saved mode or returned null.

You may send back unchanged workspace_currency_code, workspace_currency_symbol, record_revision and available_options values from GET. They are read-only; a different value is refused. Omit them if you do not need to echo the full response. An available_options value of null matches the default GET response.

Blank values, JSON null and the text null cannot clear settings. With $ignore_params_with_empty_values=true, blank values and JSON null are ignored; the text null is still refused for a changed setting. An unchanged unavailable feature's returned null remains a no-op.

All actual changes are validated before anything is saved. A changed name must have 1 to 30 characters, excluding surrounding spaces. Some emoji count as more than one character. An unavailable feature cannot be changed. A request that changes nothing leaves the settings timestamp, history and notifications unchanged.

A successful response includes the current record_revision. The revision changes when a writable setting or feature availability changes. It excludes the saved modes of unavailable features. Use expected_revision to refuse a save when the available settings have changed since your read. Without it, the last save wins. The Workspace Settings page in ExhibitDay also uses the last saved values.

Changing the currency changes the symbol shown on all amounts; the numbers are not converted. Changing the fiscal-year start month changes which budget year each cost belongs to. This affects Annual Budget and Metrics reports and API results grouped or filtered by budget year. Changing measurement units does not rescale existing measurements.

History and AI Assistant notices

Committed changes are recorded with API attribution. Workspace name changes appear in the activity feed; other settings history does not.

Changing the AI Assistant to Data-enabled or Disabled also notifies ExhibitDay by e-mail. A history or notice-delivery failure does not undo a committed setting change.

Code Samples
curl -X PATCH "https://api.exhibitday.com/v1/workspace_settings" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"name\":\"Sample Events Team Updated\"}"

Example response

{
  "status_code": 200,
  "status": "OK",
  "message": "Workspace Settings updated.",
  "errors": [],
  "record_revision": "r1:52vvEXb8Ed14e4vKiq5ZIdK3BgVmu0aXtmUBC-kueMk"
}