EventsPlaybook

Playbook

Retrieve a Single Playbook Activity by ID #

Method
GET
Endpoint
Sample Object

Retrieves a single Playbook activity by its ID.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Playbook activity.
$result_format String No
By default, the response is a single object. Send array to get it inside a one-item array.
Allowed values: array | object
$include_record_revision Boolean No
Set to true to include record_revision in the response. Send that value as expected_revision when updating to check for conflicting changes.
Default: false.
$on_error_return_empty_result Boolean No
For missing or invalid IDs, or a record unavailable in this event, return HTTP 200 with {} (or [] in array format). Current-key failures, a record that changes while it is read and unexpected errors keep their normal error status.

Good to know

Retrieves one Playbook activity, including its schedule, details and tagged people. Costs and invoices use their separate methods.

Formatted text in the response

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

Open in ExhibitDay

Each record includes exhibitday_url, the record's page in ExhibitDay. It opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.

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

Example response

{
  "id": 34567,
  "event_id": 23456,
  "event_name": "Sample Event",
  "title": "Team briefing",
  "description": null,
  "activity_type_id": 1,
  "activity_status_id": 1,
  "our_role_id": null,
  "day_type_id": 1,
  "day_number": 1,
  "is_all_day": true,
  "start_time": null,
  "end_time": null,
  "timezone": "",
  "location": null,
  "tagged_users": [
    {
      "id": "11111111-2222-4333-8444-555555555555",
      "first_name": "Jane",
      "last_name": "Smith",
      "display_name": "Jane Smith",
      "email": "jane@example.invalid",
      "type": "user",
      "workspace_role": "team_member",
      "is_active": true
    },
    {
      "id": "66666666-7777-4888-8999-aaaaaaaaaaaa",
      "first_name": "Alex",
      "last_name": "Morgan",
      "display_name": "Alex Morgan",
      "email": "alex@example.invalid",
      "type": "user",
      "workspace_role": "team_member",
      "is_active": true
    }
  ],
  "created_by": {
    "id": "11111111-2222-4333-8444-555555555555",
    "first_name": "Jane",
    "last_name": "Smith",
    "display_name": "Jane Smith",
    "email": "jane@example.invalid",
    "type": "user",
    "workspace_role": "team_member",
    "is_active": true
  },
  "booth_operations": null,
  "meeting": null,
  "presentation": null,
  "networking": null,
  "meal_break": null,
  "registration": null,
  "special_event": null,
  "planning": null,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=2&riSub=0&riId=34567",
  "related_items": [
    {
      "id": 5551,
      "related_item_id": 67890,
      "related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/TaskView/98765?tid=67890",
      "related_item_type_id": 1,
      "related_item_type": "Task",
      "related_item_asset_type_id": null,
      "related_item_name": "Confirm booth graphics with the printer",
      "related_item_created_timestamp": "2030-01-10T14:03:00Z"
    },
    {
      "id": 5552,
      "related_item_id": 45678,
      "related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/RelatedItemView/98765?typeId=4&subTypeId=0&rid=45678",
      "related_item_type_id": 4,
      "related_item_type": "Shipment",
      "related_item_asset_type_id": null,
      "related_item_name": "Booth crates to convention center",
      "related_item_created_timestamp": "2030-01-10T14:03:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace.

Retrieve Playbook Activities #

Method
GET
Endpoint

Retrieves Playbook activities across the Events you can read.

Parameters
Name Type Required? Description Details
filter_by_event_id Number No
Return records for this Event only. Omit for all readable Events in your workspace.
filter_by_tagged_user_ids String or JSON array No
Return records tagged with these users or resources. Send one user ID or an array of user IDs, for example "user-id" or ["user-id","other-user-id"]. Omit, leave blank or send [] for no tagged-user filter. Duplicate IDs collapse. Inactive and deactivated people, and people no longer in this workspace, still match the records they are tagged on; IDs never tagged in this workspace match nothing. Use filter_by_tagged_user_ids_match_type to require at least one or every selected person. This filter combines with the other filters before counting and paging.
View value format and limits

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

{
  "oneOf": [
    {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "\\S"
    },
    {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 128,
        "pattern": "\\S"
      }
    }
  ],
  "x-normalization": "one string becomes a one-item array; trimmed distinct IDs; no record-count cap",
  "nullable": false,
  "x-maximum-depth": 1,
  "x-empty-create-means-omitted": false,
  "example": [
    "user-id"
  ]
}
filter_by_tagged_user_ids_match_type String No
How to match the selected tagged people. Omit or leave blank to return records tagged with at least one selected person (the default), or require every selected person; records can have other tags too. This combines with the other filters before counting and paging. If filter_by_tagged_user_ids has no IDs, this option is ignored and the response includes a warning. Values are case-insensitive.
Allowed values: any | all
$limit Number No
The most records to return, as a positive whole number. Omit for all remaining records.
$offset Number No
How many records to skip: a whole number of 0 or more; 0 by default.
$result_format String No
By default, the response is an object containing list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
Allowed values: array | wrapped_in_array

Good to know

Lists Playbook activities in the Events you can read. Use Event and tagged-user filters to narrow the results.

Filtering and paging

Omit filter_by_event_id for all readable Events in your workspace. A supplied Event that is missing or unavailable returns an empty list with a warning. A readable Event with no matching activities returns an empty list without that warning.

Event and tagged-user filters combine with AND before counts and paging. any matches at least one selected person; all requires every selected person and permits extra tags. Inactive and deactivated people, and people no longer in this workspace, still match the activities they are tagged on; IDs never tagged match nothing. Sending filter_by_tagged_user_ids_match_type without IDs is ignored with a warning.

The list is ordered by activity ID. Omit $limit for all remaining matching activities; $offset defaults to 0. Each returned activity carries its own event_id and Event name. Costs are managed through the separate activity-cost methods.

Formatted text in the response

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

Events with a hidden Playbook tab

Records on Events whose Playbook tab is hidden are not listed. If filter_by_event_id names such an Event, the response is HTTP 200 with no records for it and a warning that names the tab and the Event.

Open in ExhibitDay

Each record includes exhibitday_url, the record's page in ExhibitDay. It opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.

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

Example response

{
  "list_type": "playbook_activity",
  "list_data": [
    {
      "id": 12345,
      "event_id": 23456,
      "event_name": "Sample Event",
      "title": "Team briefing",
      "description": null,
      "activity_type_id": 1,
      "activity_status_id": 1,
      "our_role_id": null,
      "day_type_id": 1,
      "day_number": 1,
      "is_all_day": true,
      "start_time": null,
      "end_time": null,
      "timezone": "",
      "location": null,
      "tagged_users": [
        {
          "id": "11111111-2222-4333-8444-555555555555",
          "first_name": "Jane",
          "last_name": "Smith",
          "display_name": "Jane Smith",
          "email": "jane@example.invalid",
          "type": "user",
          "workspace_role": "team_member",
          "is_active": true
        },
        {
          "id": "66666666-7777-4888-8999-aaaaaaaaaaaa",
          "first_name": "Alex",
          "last_name": "Morgan",
          "display_name": "Alex Morgan",
          "email": "alex@example.invalid",
          "type": "user",
          "workspace_role": "team_member",
          "is_active": true
        }
      ],
      "created_by": {
        "id": "11111111-2222-4333-8444-555555555555",
        "first_name": "Jane",
        "last_name": "Smith",
        "display_name": "Jane Smith",
        "email": "jane@example.invalid",
        "type": "user",
        "workspace_role": "team_member",
        "is_active": true
      },
      "booth_operations": null,
      "meeting": null,
      "presentation": null,
      "networking": null,
      "meal_break": null,
      "registration": null,
      "special_event": null,
      "planning": null,
      "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=2&riSub=0&riId=12345"
    }
  ],
  "records_found": 1,
  "total_records": 1,
  "has_more": false
}
Note: IDs are illustrative; use IDs from your workspace.

Add a Playbook Activity #

Method
POST
Endpoint

Adds a Playbook activity to an Event.

Parameters
Name Type Required? Description Details
event_id Number Yes
The ID of the Event in your workspace.
title String Yes
A short title for the scheduled activity, up to 500 characters. This is required on create and cannot be cleared.
max length: 500
day_type_id Number Yes
Where the scheduled day falls relative to the Event. Required when adding an activity; combine it with day_number and choose a day currently available in the Event's Playbook. All Pages is a display choice and cannot be saved.
Allowed values: 1 (Event Day) | 2 (Days Before the Event) | 3 (Days After the Event)
day_number Number Yes
The positive day number within the selected day type. New activities and day changes must use a day available in this event's Playbook. An existing activity may keep its own older unresolved day while you edit other fields.
description String No
Accepts plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
location String No
The activity location, up to 200 characters.
max length: 200
timezone String No
The time-zone label displayed beside the activity's times, up to 20 characters. This does not convert the clock readings. All-day activities clear this label.
max length: 20
activity_type_id Number No
Use an id from GET /v1/references/playbook_activity_types. The default on create is General — Other (1).
activity_status_id Number No
Whether the activity is Confirmed (1), Tentative (2) or Canceled (3). The default on create is Confirmed. This is independent of proposal, registration and payment statuses.
our_role_id Number No
Your team's role in the activity. The available choices depend on the activity type. Omit to use that type's default. A supplied role that does not apply, including null, becomes the type's default; types with no role store no role.
Allowed values: 1 (Attending; Attending / Participating for Special Event activities) | 2 (Hosting / Organizing) | 3 (Presenting / Participating)
is_all_day Boolean No
Use true for an all-day activity, or false for a specific start and end time. The default on create is true. All-day activities have no start time, end time or time zone.
Default: true.
start_time String No
A time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. A specific-time activity needs both times. An end before the start is swapped with the start; it does not create an overnight activity.
end_time String No
A time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. A specific-time activity needs both times. An end before the start is swapped with the start; it does not create an overnight activity.
booth_operations JSON object/list No
The Booth Operations fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "area_or_station": {
      "type": "string",
      "description": "Area Or Station. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "required_headcount": {
      "type": "string",
      "description": "Required Headcount. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "team_staffing_requirements": {
      "type": "string",
      "description": "Team Staffing Requirements. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_name": {
      "type": "string",
      "description": "On Site Contact Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_phone": {
      "type": "string",
      "description": "On Site Contact Phone. Optional text, up to 50 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_email": {
      "type": "string",
      "description": "On Site Contact Email. Optional text, up to 320 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "materials_equipment": {
      "type": "string",
      "description": "Materials Equipment. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "handoff_instructions": {
      "type": "string",
      "description": "Handoff Instructions. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "blocking_issue": {
      "type": "string",
      "description": "Blocking Issue. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "inspection_result_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Inspection Result. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Pending) | `2` (Passed) | `3` (Corrections Required) | `4` (Failed)",
      "nullable": true
    },
    "inspection_scope_type": {
      "type": "string",
      "description": "Inspection Scope Type. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "issues_deficiencies": {
      "type": "string",
      "description": "Issues Deficiencies. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "corrective_action_follow_up": {
      "type": "string",
      "description": "Corrective Action Followup. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "execution_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Execution Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `3` (Completed) | `4` (Blocked)",
      "nullable": true
    },
    "staffing_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `3` (Fully Staffed) | `4` (Issue / Blocked)",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
booth_operations.inspection_result_id integer or null No Inspection Result. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Pending) | 2 (Passed) | 3 (Corrections Required) | 4 (Failed)
booth_operations.execution_status_id integer or null No Execution Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Completed) | 4 (Blocked)
booth_operations.staffing_status_id integer or null No Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Fully Staffed) | 4 (Issue / Blocked)
meeting JSON object/list No
The Meeting fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "meeting_format_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Meeting Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (In-Person) | `2` (Virtual) | `3` (Phone) | `4` (Hybrid)",
      "nullable": true
    },
    "organization": {
      "type": "string",
      "description": "Organization. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "virtual_meeting_url": {
      "type": "string",
      "description": "Virtual Meeting URL. Optional text, up to 1000 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "purpose": {
      "type": "string",
      "description": "Purpose. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "agenda": {
      "type": "string",
      "description": "Agenda. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "preparation_requirements": {
      "type": "string",
      "description": "Preparation Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "desired_outcome": {
      "type": "string",
      "description": "Desired Outcome. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "actual_outcome": {
      "type": "string",
      "description": "Actual Outcome. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "next_steps": {
      "type": "string",
      "description": "Next Steps. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "follow_up_date": {
      "type": "string",
      "description": "Follow Up Date. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    },
    "external_attendees": {
      "type": "string",
      "description": "External Attendees. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
meeting.meeting_format_id integer or null No Meeting Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (In-Person) | 2 (Virtual) | 3 (Phone) | 4 (Hybrid)
presentation JSON object/list No
The Presentation fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "session_number": {
      "type": "string",
      "description": "Session Number. Optional text, up to 100 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "track": {
      "type": "string",
      "description": "Track. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "organizer": {
      "type": "string",
      "description": "Organizer. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "report_time": {
      "type": "string",
      "description": "Report Time. Use a time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "room_access_time": {
      "type": "string",
      "description": "Room Access Time. Use a time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "audience": {
      "type": "string",
      "description": "Audience. Optional text, up to 1000 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "expected_attendance": {
      "type": "string",
      "description": "Expected Attendance. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "room_setup_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "description": "Room Setup. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Theater) | `2` (Classroom) | `3` (Boardroom) | `4` (Panel Table) | `5` (U-Shape) | `6` (Demo Area) | `7` (Other) | `8` (Rounds / Banquet) | `9` (Poster Boards / Stations)",
      "nullable": true
    },
    "session_abstract": {
      "type": "string",
      "description": "Session Abstract. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "learning_objectives": {
      "type": "string",
      "description": "Learning Objectives. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "av_requirements": {
      "type": "string",
      "description": "A/V Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "material_requirements": {
      "type": "string",
      "description": "Material Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "submission_deadline": {
      "type": "string",
      "description": "Submission Deadline. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    },
    "rehearsal_required": {
      "type": "boolean",
      "description": "Rehearsal Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "speaker_preparation_notes": {
      "type": "string",
      "description": "Speaker Preparation Notes. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "speakers_participants": {
      "type": "string",
      "description": "Speakers Participants. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "submission_portal_url": {
      "type": "string",
      "description": "Submission Portal Link. Optional text, up to 500 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "report_location": {
      "type": "string",
      "description": "Report Location. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "recording_audio": {
      "type": "boolean",
      "description": "Recording Audio. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "recording_video": {
      "type": "boolean",
      "description": "Recording Video. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "recording_livestream": {
      "type": "boolean",
      "description": "Recording Livestream. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "recording_photography": {
      "type": "boolean",
      "description": "Recording Photography. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "qa_live_audience_questions": {
      "type": "boolean",
      "description": "Q&A Live Audience Questions. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "qa_moderated": {
      "type": "boolean",
      "description": "Q&A Moderated. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "qa_pre_submitted": {
      "type": "boolean",
      "description": "Q&A Pre Submitted. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "submission_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6,
        7
      ],
      "description": "Submission Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Draft) | `2` (Not Submitted) | `3` (Submitted) | `4` (Under Review) | `5` (Accepted) | `6` (Rejected) | `7` (Withdrawn)",
      "nullable": true
    },
    "rehearsal_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Rehearsal Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Scheduled) | `2` (Scheduled) | `3` (Completed) | `4` (Canceled)",
      "nullable": true
    },
    "materials_due_date": {
      "type": "string",
      "description": "Materials Due Date. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    },
    "session_format_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3
      ],
      "description": "Session Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (In-Person) | `2` (Virtual) | `3` (Hybrid)",
      "nullable": true
    },
    "session_join_url": {
      "type": "string",
      "description": "Session Join Link. Optional text, up to 1000 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
presentation.room_setup_id integer or null No Room Setup. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Theater) | 2 (Classroom) | 3 (Boardroom) | 4 (Panel Table) | 5 (U-Shape) | 6 (Demo Area) | 7 (Other) | 8 (Rounds / Banquet) | 9 (Poster Boards / Stations)
presentation.submission_status_id integer or null No Submission Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Draft) | 2 (Not Submitted) | 3 (Submitted) | 4 (Under Review) | 5 (Accepted) | 6 (Rejected) | 7 (Withdrawn)
presentation.rehearsal_status_id integer or null No Rehearsal Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Scheduled) | 2 (Scheduled) | 3 (Completed) | 4 (Canceled)
presentation.session_format_id integer or null No Session Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (In-Person) | 2 (Virtual) | 3 (Hybrid)
networking JSON object/list No
The Networking fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "host_or_sponsor": {
      "type": "string",
      "description": "Host Or Sponsor. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "preparation_requirements": {
      "type": "string",
      "description": "Preparation Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "rsvp_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        8,
        9,
        10,
        11
      ],
      "description": "RSVP Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `8` (Not Started) | `9` (In Progress) | `10` (Completed) | `11` (Issue / Blocked)",
      "nullable": true
    },
    "access_level_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        7,
        8,
        9
      ],
      "description": "Access Level. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (General Admission) | `2` (Exhibitor) | `3` (Speaker) | `4` (Sponsor) | `5` (VIP) | `7` (Other) | `8` (Staff) | `9` (Press / Media)",
      "nullable": true
    },
    "attendance_priority_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3
      ],
      "description": "Attendance Priority. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Optional) | `2` (Recommended) | `3` (Required)",
      "nullable": true
    },
    "internal_objective": {
      "type": "string",
      "description": "Internal Objective. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "invited_audience": {
      "type": "string",
      "description": "Invited Audience. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "dress_code_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6,
        7
      ],
      "description": "Dress Code. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Casual) | `2` (Business Casual) | `3` (Business Formal) | `4` (Cocktail) | `5` (Black Tie) | `6` (Company-Branded Apparel) | `7` (Other)",
      "nullable": true
    },
    "confirmation_number": {
      "type": "string",
      "description": "Confirmation Number. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "guest_allowance": {
      "type": "string",
      "description": "Guest Allowance. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "meeting_point": {
      "type": "string",
      "description": "Meeting Point. Optional text, up to 500 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "rsvp_registration_url": {
      "type": "string",
      "description": "RSVP Registration URL. Optional text, up to 1000 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "expected_attendance": {
      "type": "string",
      "description": "Expected Attendance. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "team_meet_up_time": {
      "type": "string",
      "description": "Team Meet Up Time. Use a time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_registration_required": {
      "type": "boolean",
      "description": "Admission Registration Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_ticket_required": {
      "type": "boolean",
      "description": "Admission Ticket Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_invitation_required": {
      "type": "boolean",
      "description": "Admission Invitation Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_credential_required": {
      "type": "boolean",
      "description": "Admission Credential Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "rsvp_registration_deadline": {
      "type": "string",
      "description": "Rsvp Registration Deadline. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
networking.rsvp_status_id integer or null No RSVP Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 8 (Not Started) | 9 (In Progress) | 10 (Completed) | 11 (Issue / Blocked)
networking.access_level_id integer or null No Access Level. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (General Admission) | 2 (Exhibitor) | 3 (Speaker) | 4 (Sponsor) | 5 (VIP) | 7 (Other) | 8 (Staff) | 9 (Press / Media)
networking.attendance_priority_id integer or null No Attendance Priority. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Optional) | 2 (Recommended) | 3 (Required)
networking.dress_code_id integer or null No Dress Code. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Casual) | 2 (Business Casual) | 3 (Business Formal) | 4 (Cocktail) | 5 (Black Tie) | 6 (Company-Branded Apparel) | 7 (Other)
meal_break JSON object/list No
The Meal Break fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "purpose_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        6,
        7,
        8,
        9,
        10
      ],
      "description": "Purpose. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Personal / Routine) | `2` (Team / Internal) | `3` (Customer / Prospect Engagement) | `4` (Partner / Vendor Engagement) | `6` (Other) | `7` (Networking / Relationship Building) | `8` (Working / Planning) | `9` (Hospitality / VIP) | `10` (Celebration / Recognition)",
      "nullable": true
    },
    "host_or_sponsor": {
      "type": "string",
      "description": "Host Or Sponsor. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "reservation_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "description": "Reservation Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Required) | `2` (Requested / Pending) | `3` (Confirmed) | `4` (Waitlisted) | `5` (Canceled) | `6` (Not Yet Reserved)",
      "nullable": true
    },
    "reservation_name": {
      "type": "string",
      "description": "Reservation Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "reservation_number": {
      "type": "string",
      "description": "Reservation Number. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "party_size": {
      "type": "string",
      "description": "Party Size. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "dietary_requirements": {
      "type": "string",
      "description": "Dietary Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "restaurant_contact_name": {
      "type": "string",
      "description": "Restaurant Contact Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "restaurant_contact_phone": {
      "type": "string",
      "description": "Restaurant Contact Phone. Optional text, up to 50 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "seating_arrangement_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5
      ],
      "description": "Seating Arrangement. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Private Room) | `2` (Reserved Table) | `3` (Assigned Seating) | `4` (Open Seating) | `5` (Other)",
      "nullable": true
    },
    "guests_attendees": {
      "type": "string",
      "description": "Guests Attendees. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "reservation_deadline": {
      "type": "string",
      "description": "Reservation Deadline. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
meal_break.purpose_id integer or null No Purpose. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Personal / Routine) | 2 (Team / Internal) | 3 (Customer / Prospect Engagement) | 4 (Partner / Vendor Engagement) | 6 (Other) | 7 (Networking / Relationship Building) | 8 (Working / Planning) | 9 (Hospitality / VIP) | 10 (Celebration / Recognition)
meal_break.reservation_status_id integer or null No Reservation Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Required) | 2 (Requested / Pending) | 3 (Confirmed) | 4 (Waitlisted) | 5 (Canceled) | 6 (Not Yet Reserved)
meal_break.seating_arrangement_id integer or null No Seating Arrangement. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Private Room) | 2 (Reserved Table) | 3 (Assigned Seating) | 4 (Open Seating) | 5 (Other)
registration JSON object/list No
The Registration fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "credential_details": {
      "type": "string",
      "description": "Credential Details. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "confirmation_number": {
      "type": "string",
      "description": "Confirmation Number. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "required_documents_items": {
      "type": "string",
      "description": "Required Documents Items. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "escalation_contact_name": {
      "type": "string",
      "description": "Escalation Contact Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "escalation_contact_phone": {
      "type": "string",
      "description": "Escalation Contact Phone. Optional text, up to 50 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "escalation_contact_email": {
      "type": "string",
      "description": "Escalation Contact Email. Optional text, up to 320 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "issue_notes": {
      "type": "string",
      "description": "Issue Notes. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        6,
        7,
        11,
        12
      ],
      "description": "Status. Check-in / Registration offers 6 Not Checked In, 7 Checked In and 12 Issue / Blocked. Other offers 1 Not Started, 2 In Progress, 11 Completed and 12 Issue / Blocked. Send a JSON integer from the current activity type's choices, or JSON null for no choice. Omit this member on PATCH to keep its value. Changing the activity type can clear a status that no longer applies.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `6` (Not Checked In) | `7` (Checked In) | `11` (Completed) | `12` (Issue / Blocked)",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
registration.status_id integer or null No Status. Check-in / Registration offers 6 Not Checked In, 7 Checked In and 12 Issue / Blocked. Other offers 1 Not Started, 2 In Progress, 11 Completed and 12 Issue / Blocked. Send a JSON integer from the current activity type's choices, or JSON null for no choice. Omit this member on PATCH to keep its value. Changing the activity type can clear a status that no longer applies. Allowed values: 1 (Not Started) | 2 (In Progress) | 6 (Not Checked In) | 7 (Checked In) | 11 (Completed) | 12 (Issue / Blocked)
special_event JSON object/list No
The Special Event fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "required_headcount": {
      "type": "string",
      "description": "Required Headcount. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "staffing_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `3` (Fully Staffed) | `4` (Issue / Blocked)",
      "nullable": true
    },
    "participant_registration_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        11,
        12
      ],
      "description": "Participant Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `11` (Completed) | `12` (Issue / Blocked)",
      "nullable": true
    },
    "participant_waiver_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        2,
        3,
        4,
        5
      ],
      "description": "Participant Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `2` (In Progress) | `3` (Completed) | `4` (Not Started) | `5` (Issue / Blocked)",
      "nullable": true
    },
    "organizer": {
      "type": "string",
      "description": "Organizer. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "ticket_confirmation_number": {
      "type": "string",
      "description": "Ticket Confirmation Number. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "participation_instructions": {
      "type": "string",
      "description": "Participation Instructions. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "attire_requirements": {
      "type": "string",
      "description": "Attire Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "capacity_group_size": {
      "type": "string",
      "description": "Capacity Group Size. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "waiver_required": {
      "type": "boolean",
      "description": "Waiver Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "waiver_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        2,
        3,
        4,
        5
      ],
      "description": "Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `2` (In Progress) | `3` (Completed) | `4` (Not Started) | `5` (Issue / Blocked)",
      "nullable": true
    },
    "eligibility_restrictions": {
      "type": "string",
      "description": "Eligibility Restrictions. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "weather_dependent": {
      "type": "boolean",
      "description": "Weather Dependent. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "contingency_plan": {
      "type": "string",
      "description": "Contingency Plan. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "safety_instructions": {
      "type": "string",
      "description": "Safety Instructions. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "emergency_contact_name": {
      "type": "string",
      "description": "Emergency Contact Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "emergency_contact_phone": {
      "type": "string",
      "description": "Emergency Contact Phone. Optional text, up to 50 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_name": {
      "type": "string",
      "description": "On Site Contact Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_phone": {
      "type": "string",
      "description": "On Site Contact Phone. Optional text, up to 50 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_email": {
      "type": "string",
      "description": "On Site Contact Email. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "report_checkin_time": {
      "type": "string",
      "description": "Report Checkin Time. Use a time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "meeting_checkin_point": {
      "type": "string",
      "description": "Meeting Checkin Point. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "participants_guests": {
      "type": "string",
      "description": "Participants Guests. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_registration_required": {
      "type": "boolean",
      "description": "Admission Registration Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_ticket_required": {
      "type": "boolean",
      "description": "Admission Ticket Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_invitation_required": {
      "type": "boolean",
      "description": "Admission Invitation Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_credential_required": {
      "type": "boolean",
      "description": "Admission Credential Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "registration_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        11,
        12
      ],
      "description": "Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `11` (Completed) | `12` (Issue / Blocked)",
      "nullable": true
    },
    "registration_deadline": {
      "type": "string",
      "description": "Registration Deadline. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    },
    "registration_url": {
      "type": "string",
      "description": "Registration URL. Optional text, up to 500 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "waiver_deadline": {
      "type": "string",
      "description": "Waiver Deadline. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    },
    "preparation_requirements": {
      "type": "string",
      "description": "Preparation Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "floor_walk_exhibitors_areas": {
      "type": "string",
      "description": "Floor Walk Exhibitors Areas. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "floor_walk_visit_focus": {
      "type": "string",
      "description": "Floor Walk Visit Focus. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
special_event.staffing_status_id integer or null No Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Fully Staffed) | 4 (Issue / Blocked)
special_event.participant_registration_status_id integer or null No Participant Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Started) | 2 (In Progress) | 11 (Completed) | 12 (Issue / Blocked)
special_event.participant_waiver_status_id integer or null No Participant Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 2 (In Progress) | 3 (Completed) | 4 (Not Started) | 5 (Issue / Blocked)
special_event.waiver_status_id integer or null No Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 2 (In Progress) | 3 (Completed) | 4 (Not Started) | 5 (Issue / Blocked)
special_event.registration_status_id integer or null No Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Started) | 2 (In Progress) | 11 (Completed) | 12 (Issue / Blocked)
planning JSON object/list No
The Planning fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. Planning contacts are free text; they do not tag users or send notifications. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "notes": {
      "type": "string",
      "description": "Planning Notes. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "contacts": {
      "type": "string",
      "description": "Planning Contacts. Optional text, up to 500 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
tagged_user_ids JSON object/list No
The full list of people tagged in this activity, as an array of unique user IDs from your workspace's active users and resources. Omit it to keep the current people; null or [] removes all tags. Existing tags keep their notification state. Newly tagged people receive the usual assignment notification only when notify_tagged_users is true and their account and email settings allow it. Existing tags keep their notification state.
View value format and limits

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

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "maxItems": 2147483647,
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": [
    "user-id"
  ]
}
notify_tagged_users Boolean No
Whether newly tagged people may receive the usual assignment email. Omit this option or leave it blank for true. Send false to suppress the new notifications from this request. Existing tags keep their notification state; this option does not resend or cancel earlier notifications. JSON null is refused, even with the ignore-empty option. Delivery still depends on each person's current account, access and email settings.
Default: true.
$result_format String No
By default, the response is a single object. Send array to get it inside a one-item array.
Allowed values: array | object

Good to know

Adds a scheduled activity to an Event's Playbook. The response includes the new activity and its ID.

Creating the activity

Send event_id, title, day_type_id and day_number. The field descriptions below explain the available days, default choices and optional times. Add costs and invoices with the Playbook Cost methods after the activity exists.

Access and locks

Your current API access and the Event's Playbook visibility and lock settings apply.

Sending the request

Use JSON, the query string or form data for values containing commas. Send comma-containing text, related-item lists and detail objects in JSON, query parameters or form fields.

To make a retry safe, send an Idempotency-Key. Resending the same request with the same key returns the saved response instead of adding a second activity.

After the add

Newly tagged people may receive the usual assignment email unless you send notify_tagged_users=false; delivery still depends on their account and email settings.

Confirmed changes appear in activity history; a history-writing failure does not undo the change.

If you can't confirm the result and didn't send an Idempotency-Key, check the Event's Playbook before trying again; the API does not repeat the action automatically.

Sending text

Send plain text for Notes and other rich-text fields. Characters such as &, < and quotes, along with line breaks, are encoded for storage.

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

Hidden or locked tab

If the Event's Playbook tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

Open in ExhibitDay

The created record includes exhibitday_url, the record's page in ExhibitDay. It is the same link that GET /v1/events/playbook_activities/info returns for this record and opens the record in view mode on its Event's tab. Sign in with an account that can view the record; ExhibitDay checks access when the link is opened.

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

Example response

{
  "id": 12345,
  "event_id": 23456,
  "event_name": "Sample Event",
  "title": "Team briefing",
  "description": null,
  "activity_type_id": 1,
  "activity_status_id": 1,
  "our_role_id": null,
  "day_type_id": 1,
  "day_number": 1,
  "is_all_day": true,
  "start_time": null,
  "end_time": null,
  "timezone": "",
  "location": null,
  "tagged_users": [],
  "created_by": {
    "id": null,
    "first_name": "ExhibitDay",
    "last_name": "API",
    "display_name": "ExhibitDay API",
    "email": null,
    "type": null,
    "workspace_role": null,
    "is_active": true
  },
  "booth_operations": null,
  "meeting": null,
  "presentation": null,
  "networking": null,
  "meal_break": null,
  "registration": null,
  "special_event": null,
  "planning": null,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=2&riSub=0&riId=12345"
}
Note: IDs are illustrative; use IDs from your workspace.

Update a Playbook Activity #

Method
PATCH
Endpoint

Updates an existing Playbook activity.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Playbook activity in that event. Use its ID from the activity list, Info or Create response.
title String No
A short title for the scheduled activity, up to 500 characters. This is required on create and cannot be cleared.
max length: 500
description String No
Accepts plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
location String No
The activity location, up to 200 characters.
max length: 200
timezone String No
The time-zone label displayed beside the activity's times, up to 20 characters. This does not convert the clock readings. All-day activities clear this label.
max length: 20
activity_type_id Number No
Use an id from GET /v1/references/playbook_activity_types. The default on create is General — Other (1).
activity_status_id Number No
Whether the activity is Confirmed (1), Tentative (2) or Canceled (3). The default on create is Confirmed. This is independent of proposal, registration and payment statuses.
our_role_id Number No
Your team's role in the activity. The available choices depend on the activity type. Omit or leave blank to keep it unless the activity type changes. A supplied role that does not apply, including null, becomes the type's default; types with no role store no role.
Allowed values: 1 (Attending; Attending / Participating for Special Event activities) | 2 (Hosting / Organizing) | 3 (Presenting / Participating)
day_type_id Number No
Where the scheduled day falls relative to the Event. Combine it with day_number and choose a day currently available in the Event's Playbook. Omit or leave blank to keep it; null cannot clear it. An unchanged older unresolved day may remain while editing other fields. All Pages is a display choice and cannot be saved.
Allowed values: 1 (Event Day) | 2 (Days Before the Event) | 3 (Days After the Event)
day_number Number No
The positive day number within the selected day type. New activities and day changes must use a day available in this event's Playbook. An existing activity may keep its own older unresolved day while you edit other fields.
is_all_day Boolean No
Use true for an all-day activity, or false for a specific start and end time. The default on create is true. All-day activities have no start time, end time or time zone.
Default: true.
start_time String No
A time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. A specific-time activity needs both times. An end before the start is swapped with the start; it does not create an overnight activity.
end_time String No
A time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. A specific-time activity needs both times. An end before the start is swapped with the start; it does not create an overnight activity.
booth_operations JSON object/list No
The Booth Operations fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "area_or_station": {
      "type": "string",
      "description": "Area Or Station. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "required_headcount": {
      "type": "string",
      "description": "Required Headcount. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "team_staffing_requirements": {
      "type": "string",
      "description": "Team Staffing Requirements. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_name": {
      "type": "string",
      "description": "On Site Contact Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_phone": {
      "type": "string",
      "description": "On Site Contact Phone. Optional text, up to 50 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_email": {
      "type": "string",
      "description": "On Site Contact Email. Optional text, up to 320 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "materials_equipment": {
      "type": "string",
      "description": "Materials Equipment. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "handoff_instructions": {
      "type": "string",
      "description": "Handoff Instructions. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "blocking_issue": {
      "type": "string",
      "description": "Blocking Issue. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "inspection_result_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Inspection Result. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Pending) | `2` (Passed) | `3` (Corrections Required) | `4` (Failed)",
      "nullable": true
    },
    "inspection_scope_type": {
      "type": "string",
      "description": "Inspection Scope Type. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "issues_deficiencies": {
      "type": "string",
      "description": "Issues Deficiencies. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "corrective_action_follow_up": {
      "type": "string",
      "description": "Corrective Action Followup. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "execution_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Execution Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `3` (Completed) | `4` (Blocked)",
      "nullable": true
    },
    "staffing_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `3` (Fully Staffed) | `4` (Issue / Blocked)",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
booth_operations.inspection_result_id integer or null No Inspection Result. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Pending) | 2 (Passed) | 3 (Corrections Required) | 4 (Failed)
booth_operations.execution_status_id integer or null No Execution Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Completed) | 4 (Blocked)
booth_operations.staffing_status_id integer or null No Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Fully Staffed) | 4 (Issue / Blocked)
meeting JSON object/list No
The Meeting fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "meeting_format_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Meeting Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (In-Person) | `2` (Virtual) | `3` (Phone) | `4` (Hybrid)",
      "nullable": true
    },
    "organization": {
      "type": "string",
      "description": "Organization. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "virtual_meeting_url": {
      "type": "string",
      "description": "Virtual Meeting URL. Optional text, up to 1000 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "purpose": {
      "type": "string",
      "description": "Purpose. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "agenda": {
      "type": "string",
      "description": "Agenda. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "preparation_requirements": {
      "type": "string",
      "description": "Preparation Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "desired_outcome": {
      "type": "string",
      "description": "Desired Outcome. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "actual_outcome": {
      "type": "string",
      "description": "Actual Outcome. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "next_steps": {
      "type": "string",
      "description": "Next Steps. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "follow_up_date": {
      "type": "string",
      "description": "Follow Up Date. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    },
    "external_attendees": {
      "type": "string",
      "description": "External Attendees. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
meeting.meeting_format_id integer or null No Meeting Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (In-Person) | 2 (Virtual) | 3 (Phone) | 4 (Hybrid)
presentation JSON object/list No
The Presentation fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "session_number": {
      "type": "string",
      "description": "Session Number. Optional text, up to 100 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "track": {
      "type": "string",
      "description": "Track. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "organizer": {
      "type": "string",
      "description": "Organizer. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "report_time": {
      "type": "string",
      "description": "Report Time. Use a time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "room_access_time": {
      "type": "string",
      "description": "Room Access Time. Use a time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "audience": {
      "type": "string",
      "description": "Audience. Optional text, up to 1000 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "expected_attendance": {
      "type": "string",
      "description": "Expected Attendance. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "room_setup_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "description": "Room Setup. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Theater) | `2` (Classroom) | `3` (Boardroom) | `4` (Panel Table) | `5` (U-Shape) | `6` (Demo Area) | `7` (Other) | `8` (Rounds / Banquet) | `9` (Poster Boards / Stations)",
      "nullable": true
    },
    "session_abstract": {
      "type": "string",
      "description": "Session Abstract. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "learning_objectives": {
      "type": "string",
      "description": "Learning Objectives. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "av_requirements": {
      "type": "string",
      "description": "A/V Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "material_requirements": {
      "type": "string",
      "description": "Material Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "submission_deadline": {
      "type": "string",
      "description": "Submission Deadline. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    },
    "rehearsal_required": {
      "type": "boolean",
      "description": "Rehearsal Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "speaker_preparation_notes": {
      "type": "string",
      "description": "Speaker Preparation Notes. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "speakers_participants": {
      "type": "string",
      "description": "Speakers Participants. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "submission_portal_url": {
      "type": "string",
      "description": "Submission Portal Link. Optional text, up to 500 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "report_location": {
      "type": "string",
      "description": "Report Location. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "recording_audio": {
      "type": "boolean",
      "description": "Recording Audio. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "recording_video": {
      "type": "boolean",
      "description": "Recording Video. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "recording_livestream": {
      "type": "boolean",
      "description": "Recording Livestream. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "recording_photography": {
      "type": "boolean",
      "description": "Recording Photography. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "qa_live_audience_questions": {
      "type": "boolean",
      "description": "Q&A Live Audience Questions. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "qa_moderated": {
      "type": "boolean",
      "description": "Q&A Moderated. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "qa_pre_submitted": {
      "type": "boolean",
      "description": "Q&A Pre Submitted. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "submission_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6,
        7
      ],
      "description": "Submission Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Draft) | `2` (Not Submitted) | `3` (Submitted) | `4` (Under Review) | `5` (Accepted) | `6` (Rejected) | `7` (Withdrawn)",
      "nullable": true
    },
    "rehearsal_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Rehearsal Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Scheduled) | `2` (Scheduled) | `3` (Completed) | `4` (Canceled)",
      "nullable": true
    },
    "materials_due_date": {
      "type": "string",
      "description": "Materials Due Date. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    },
    "session_format_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3
      ],
      "description": "Session Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (In-Person) | `2` (Virtual) | `3` (Hybrid)",
      "nullable": true
    },
    "session_join_url": {
      "type": "string",
      "description": "Session Join Link. Optional text, up to 1000 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
presentation.room_setup_id integer or null No Room Setup. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Theater) | 2 (Classroom) | 3 (Boardroom) | 4 (Panel Table) | 5 (U-Shape) | 6 (Demo Area) | 7 (Other) | 8 (Rounds / Banquet) | 9 (Poster Boards / Stations)
presentation.submission_status_id integer or null No Submission Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Draft) | 2 (Not Submitted) | 3 (Submitted) | 4 (Under Review) | 5 (Accepted) | 6 (Rejected) | 7 (Withdrawn)
presentation.rehearsal_status_id integer or null No Rehearsal Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Scheduled) | 2 (Scheduled) | 3 (Completed) | 4 (Canceled)
presentation.session_format_id integer or null No Session Format. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (In-Person) | 2 (Virtual) | 3 (Hybrid)
networking JSON object/list No
The Networking fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "host_or_sponsor": {
      "type": "string",
      "description": "Host Or Sponsor. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "preparation_requirements": {
      "type": "string",
      "description": "Preparation Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "rsvp_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        8,
        9,
        10,
        11
      ],
      "description": "RSVP Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `8` (Not Started) | `9` (In Progress) | `10` (Completed) | `11` (Issue / Blocked)",
      "nullable": true
    },
    "access_level_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        7,
        8,
        9
      ],
      "description": "Access Level. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (General Admission) | `2` (Exhibitor) | `3` (Speaker) | `4` (Sponsor) | `5` (VIP) | `7` (Other) | `8` (Staff) | `9` (Press / Media)",
      "nullable": true
    },
    "attendance_priority_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3
      ],
      "description": "Attendance Priority. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Optional) | `2` (Recommended) | `3` (Required)",
      "nullable": true
    },
    "internal_objective": {
      "type": "string",
      "description": "Internal Objective. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "invited_audience": {
      "type": "string",
      "description": "Invited Audience. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "dress_code_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6,
        7
      ],
      "description": "Dress Code. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Casual) | `2` (Business Casual) | `3` (Business Formal) | `4` (Cocktail) | `5` (Black Tie) | `6` (Company-Branded Apparel) | `7` (Other)",
      "nullable": true
    },
    "confirmation_number": {
      "type": "string",
      "description": "Confirmation Number. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "guest_allowance": {
      "type": "string",
      "description": "Guest Allowance. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "meeting_point": {
      "type": "string",
      "description": "Meeting Point. Optional text, up to 500 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "rsvp_registration_url": {
      "type": "string",
      "description": "RSVP Registration URL. Optional text, up to 1000 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "expected_attendance": {
      "type": "string",
      "description": "Expected Attendance. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "team_meet_up_time": {
      "type": "string",
      "description": "Team Meet Up Time. Use a time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_registration_required": {
      "type": "boolean",
      "description": "Admission Registration Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_ticket_required": {
      "type": "boolean",
      "description": "Admission Ticket Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_invitation_required": {
      "type": "boolean",
      "description": "Admission Invitation Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_credential_required": {
      "type": "boolean",
      "description": "Admission Credential Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "rsvp_registration_deadline": {
      "type": "string",
      "description": "Rsvp Registration Deadline. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
networking.rsvp_status_id integer or null No RSVP Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 8 (Not Started) | 9 (In Progress) | 10 (Completed) | 11 (Issue / Blocked)
networking.access_level_id integer or null No Access Level. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (General Admission) | 2 (Exhibitor) | 3 (Speaker) | 4 (Sponsor) | 5 (VIP) | 7 (Other) | 8 (Staff) | 9 (Press / Media)
networking.attendance_priority_id integer or null No Attendance Priority. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Optional) | 2 (Recommended) | 3 (Required)
networking.dress_code_id integer or null No Dress Code. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Casual) | 2 (Business Casual) | 3 (Business Formal) | 4 (Cocktail) | 5 (Black Tie) | 6 (Company-Branded Apparel) | 7 (Other)
meal_break JSON object/list No
The Meal Break fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "purpose_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        6,
        7,
        8,
        9,
        10
      ],
      "description": "Purpose. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Personal / Routine) | `2` (Team / Internal) | `3` (Customer / Prospect Engagement) | `4` (Partner / Vendor Engagement) | `6` (Other) | `7` (Networking / Relationship Building) | `8` (Working / Planning) | `9` (Hospitality / VIP) | `10` (Celebration / Recognition)",
      "nullable": true
    },
    "host_or_sponsor": {
      "type": "string",
      "description": "Host Or Sponsor. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "reservation_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5,
        6
      ],
      "description": "Reservation Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Required) | `2` (Requested / Pending) | `3` (Confirmed) | `4` (Waitlisted) | `5` (Canceled) | `6` (Not Yet Reserved)",
      "nullable": true
    },
    "reservation_name": {
      "type": "string",
      "description": "Reservation Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "reservation_number": {
      "type": "string",
      "description": "Reservation Number. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "party_size": {
      "type": "string",
      "description": "Party Size. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "dietary_requirements": {
      "type": "string",
      "description": "Dietary Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "restaurant_contact_name": {
      "type": "string",
      "description": "Restaurant Contact Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "restaurant_contact_phone": {
      "type": "string",
      "description": "Restaurant Contact Phone. Optional text, up to 50 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "seating_arrangement_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4,
        5
      ],
      "description": "Seating Arrangement. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Private Room) | `2` (Reserved Table) | `3` (Assigned Seating) | `4` (Open Seating) | `5` (Other)",
      "nullable": true
    },
    "guests_attendees": {
      "type": "string",
      "description": "Guests Attendees. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "reservation_deadline": {
      "type": "string",
      "description": "Reservation Deadline. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
meal_break.purpose_id integer or null No Purpose. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Personal / Routine) | 2 (Team / Internal) | 3 (Customer / Prospect Engagement) | 4 (Partner / Vendor Engagement) | 6 (Other) | 7 (Networking / Relationship Building) | 8 (Working / Planning) | 9 (Hospitality / VIP) | 10 (Celebration / Recognition)
meal_break.reservation_status_id integer or null No Reservation Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Required) | 2 (Requested / Pending) | 3 (Confirmed) | 4 (Waitlisted) | 5 (Canceled) | 6 (Not Yet Reserved)
meal_break.seating_arrangement_id integer or null No Seating Arrangement. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Private Room) | 2 (Reserved Table) | 3 (Assigned Seating) | 4 (Open Seating) | 5 (Other)
registration JSON object/list No
The Registration fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "credential_details": {
      "type": "string",
      "description": "Credential Details. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "confirmation_number": {
      "type": "string",
      "description": "Confirmation Number. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "required_documents_items": {
      "type": "string",
      "description": "Required Documents Items. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "escalation_contact_name": {
      "type": "string",
      "description": "Escalation Contact Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "escalation_contact_phone": {
      "type": "string",
      "description": "Escalation Contact Phone. Optional text, up to 50 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "escalation_contact_email": {
      "type": "string",
      "description": "Escalation Contact Email. Optional text, up to 320 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "issue_notes": {
      "type": "string",
      "description": "Issue Notes. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        6,
        7,
        11,
        12
      ],
      "description": "Status. Check-in / Registration offers 6 Not Checked In, 7 Checked In and 12 Issue / Blocked. Other offers 1 Not Started, 2 In Progress, 11 Completed and 12 Issue / Blocked. Send a JSON integer from the current activity type's choices, or JSON null for no choice. Omit this member on PATCH to keep its value. Changing the activity type can clear a status that no longer applies.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `6` (Not Checked In) | `7` (Checked In) | `11` (Completed) | `12` (Issue / Blocked)",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
registration.status_id integer or null No Status. Check-in / Registration offers 6 Not Checked In, 7 Checked In and 12 Issue / Blocked. Other offers 1 Not Started, 2 In Progress, 11 Completed and 12 Issue / Blocked. Send a JSON integer from the current activity type's choices, or JSON null for no choice. Omit this member on PATCH to keep its value. Changing the activity type can clear a status that no longer applies. Allowed values: 1 (Not Started) | 2 (In Progress) | 6 (Not Checked In) | 7 (Checked In) | 11 (Completed) | 12 (Issue / Blocked)
special_event JSON object/list No
The Special Event fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "required_headcount": {
      "type": "string",
      "description": "Required Headcount. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "staffing_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        3,
        4
      ],
      "description": "Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `3` (Fully Staffed) | `4` (Issue / Blocked)",
      "nullable": true
    },
    "participant_registration_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        11,
        12
      ],
      "description": "Participant Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `11` (Completed) | `12` (Issue / Blocked)",
      "nullable": true
    },
    "participant_waiver_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        2,
        3,
        4,
        5
      ],
      "description": "Participant Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `2` (In Progress) | `3` (Completed) | `4` (Not Started) | `5` (Issue / Blocked)",
      "nullable": true
    },
    "organizer": {
      "type": "string",
      "description": "Organizer. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "ticket_confirmation_number": {
      "type": "string",
      "description": "Ticket Confirmation Number. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "participation_instructions": {
      "type": "string",
      "description": "Participation Instructions. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "attire_requirements": {
      "type": "string",
      "description": "Attire Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "capacity_group_size": {
      "type": "string",
      "description": "Capacity Group Size. Optional text, up to 150 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "waiver_required": {
      "type": "boolean",
      "description": "Waiver Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "waiver_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        2,
        3,
        4,
        5
      ],
      "description": "Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `2` (In Progress) | `3` (Completed) | `4` (Not Started) | `5` (Issue / Blocked)",
      "nullable": true
    },
    "eligibility_restrictions": {
      "type": "string",
      "description": "Eligibility Restrictions. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "weather_dependent": {
      "type": "boolean",
      "description": "Weather Dependent. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "contingency_plan": {
      "type": "string",
      "description": "Contingency Plan. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "safety_instructions": {
      "type": "string",
      "description": "Safety Instructions. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "emergency_contact_name": {
      "type": "string",
      "description": "Emergency Contact Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "emergency_contact_phone": {
      "type": "string",
      "description": "Emergency Contact Phone. Optional text, up to 50 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_name": {
      "type": "string",
      "description": "On Site Contact Name. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_phone": {
      "type": "string",
      "description": "On Site Contact Phone. Optional text, up to 50 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "on_site_contact_email": {
      "type": "string",
      "description": "On Site Contact Email. Optional text, up to 200 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "report_checkin_time": {
      "type": "string",
      "description": "Report Checkin Time. Use a time of day, such as 09:30 or 2:30 PM, without a date or UTC offset. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "meeting_checkin_point": {
      "type": "string",
      "description": "Meeting Checkin Point. Optional text, up to 300 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "participants_guests": {
      "type": "string",
      "description": "Participants Guests. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_registration_required": {
      "type": "boolean",
      "description": "Admission Registration Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_ticket_required": {
      "type": "boolean",
      "description": "Admission Ticket Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_invitation_required": {
      "type": "boolean",
      "description": "Admission Invitation Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "admission_credential_required": {
      "type": "boolean",
      "description": "Admission Credential Required. Use true for Yes, false for No, or JSON null for unanswered. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "registration_status_id": {
      "type": "integer",
      "format": "int64",
      "enum": [
        1,
        2,
        11,
        12
      ],
      "description": "Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset.\n\nAllowed values: `1` (Not Started) | `2` (In Progress) | `11` (Completed) | `12` (Issue / Blocked)",
      "nullable": true
    },
    "registration_deadline": {
      "type": "string",
      "description": "Registration Deadline. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    },
    "registration_url": {
      "type": "string",
      "description": "Registration URL. Optional text, up to 500 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "waiver_deadline": {
      "type": "string",
      "description": "Waiver Deadline. Use YYYY-MM-DD, without a time or time zone. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "format": "date",
      "nullable": true
    },
    "preparation_requirements": {
      "type": "string",
      "description": "Preparation Requirements. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "floor_walk_exhibitors_areas": {
      "type": "string",
      "description": "Floor Walk Exhibitors Areas. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "floor_walk_visit_focus": {
      "type": "string",
      "description": "Floor Walk Visit Focus. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
special_event.staffing_status_id integer or null No Staffing Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Started) | 2 (In Progress) | 3 (Fully Staffed) | 4 (Issue / Blocked)
special_event.participant_registration_status_id integer or null No Participant Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Started) | 2 (In Progress) | 11 (Completed) | 12 (Issue / Blocked)
special_event.participant_waiver_status_id integer or null No Participant Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 2 (In Progress) | 3 (Completed) | 4 (Not Started) | 5 (Issue / Blocked)
special_event.waiver_status_id integer or null No Waiver Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 2 (In Progress) | 3 (Completed) | 4 (Not Started) | 5 (Issue / Blocked)
special_event.registration_status_id integer or null No Registration Status. Send a JSON integer, or JSON null for no choice. Omit this member on PATCH to keep its value. The activity type, your role and related choices determine whether it applies; a choice that no longer applies can be cleared or reset. Allowed values: 1 (Not Started) | 2 (In Progress) | 11 (Completed) | 12 (Issue / Blocked)
planning JSON object/list No
The Planning fields shown for this activity type. Send an object using the fields listed below. On PATCH, omitted members keep their current values; JSON null clears a member, and an empty text member clears its text. Within the object, the text "null" remains literal text. The current type, role and related choices decide which fields apply; values that no longer apply are cleared. A filled member that this type or role does not use is not saved, and the response warns about that member by name. Changing category removes the other category's details. Planning contacts are free text; they do not tag users or send notifications. A blank whole parameter keeps the section; null clears its fields. The ignore-empty option applies to a whole JSON-null parameter, not to members of a supplied object. Rich-text fields accept plain text; line breaks are retained. The saved text and its representation in the ExhibitDay editor must each fit within 30,000 characters, including formatting and encoded characters. Older text over the limit may be kept or shortened, but cannot grow. On PATCH, an omitted or blank whole parameter keeps its value; null clears it.
View value format and limits

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

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "notes": {
      "type": "string",
      "description": "Planning Notes. Optional plain text with line breaks. Saved text and the editor count must each fit 30,000 characters, including formatting. Older over-limit text may be kept or shortened, but cannot grow. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    },
    "contacts": {
      "type": "string",
      "description": "Planning Contacts. Optional text, up to 500 characters, excluding surrounding spaces. The activity type, role and other choices decide whether this field applies. Omit it to keep its value on PATCH; JSON null clears it.",
      "nullable": true
    }
  },
  "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": {}
}
tagged_user_ids JSON object/list No
The full list of people tagged in this activity, as an array of unique user IDs from your workspace's active users and resources. Omit it to keep the current people; null or [] removes all tags. Existing tags keep their notification state. Newly tagged people receive the usual assignment notification only when notify_tagged_users is true and their account and email settings allow it. Existing tags keep their notification state.
View value format and limits

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

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "maxItems": 2147483647,
  "nullable": true,
  "x-maximum-depth": 2,
  "x-empty-create-means-omitted": true,
  "example": [
    "user-id"
  ]
}
notify_tagged_users Boolean No
Whether newly tagged people may receive the usual assignment email. Omit this option or leave it blank for true. Send false to suppress the new notifications from this request. Existing tags keep their notification state; this option does not resend or cancel earlier notifications. JSON null is refused, even with the ignore-empty option. Delivery still depends on each person's current account, access and email settings.
Default: true.
expected_revision String No
The record_revision returned when you retrieved this record. Include it to avoid overwriting someone else's changes. Omit it to skip this check.

Good to know

Updates the fields you choose on an existing Playbook activity. Omitted fields keep their current values.

Choosing what to change

Send only what you want to change. Omitted or blank whole parameters keep their values; null clears only fields that allow it. With $ignore_params_with_empty_values=true, a whole JSON-null parameter is ignored, while the text "null" still requests clearing.

An activity cannot move to another Event. Its type and your team's role decide which details apply; see each field below for its rules.

Access and locks

Your current API access and the Event's Playbook visibility and lock settings apply.

Sending the request

Use JSON, the query string or form data for values containing commas. Send comma-containing text, related-item lists and detail objects in JSON, query parameters or form fields. This method ignores Idempotency-Key.

After the update

An unchanged PATCH writes no data, timestamp or history.

Newly tagged people may receive the usual assignment email unless you send notify_tagged_users=false; delivery still depends on their account and email settings.

Confirmed changes appear in activity history; a history-writing failure does not undo the change.

If a save result cannot be confirmed, review the record before trying again; the API does not repeat the action automatically.

Sending text

Send plain text for Notes and other rich-text fields. Characters such as &, < and quotes, along with line breaks, are encoded for storage.

Hidden or locked tab

If the Event's Playbook tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

Code Samples
curl -X PATCH "https://api.exhibitday.com/v1/events/playbook_activities" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":34567,\"description\":\"Updated description\"}"

Example response

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

Delete a Playbook Activity #

Method
DELETE
Endpoint

Deletes an existing Playbook activity.

Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Playbook activity in that event. Use its ID from the activity list, Info or Create response.

What is removed

Deleting the activity also removes its details, tagged people, costs, related-item links and attachment records. Only this activity's own files are scheduled for cleanup.

Access and locks

Your current API access and the Event's Playbook visibility and lock settings apply.

Sending the request

Use JSON, the query string or form data for values containing commas. This method ignores Idempotency-Key.

After the deletion

The deletion appears in the Event's Playbook history; a history-writing failure does not undo it.

If you can't confirm the deletion, retrieve the activity before trying again; the API does not repeat the action automatically.

Hidden or locked tab

If the Event's Playbook tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

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

Example response

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

Retrieve a Single Playbook Cost by ID #

Method
GET
Endpoint

Retrieves a single Playbook cost by its ID.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Playbook cost.
$result_format String No
By default, the response is a single object. Send array to get it inside a one-item array.
Allowed values: array | object
$include_record_revision Boolean No
Set to true to include record_revision in the response. Send that value as expected_revision when updating to check for conflicting changes.
Default: false.
$on_error_return_empty_result Boolean No
For missing or invalid IDs, or a record unavailable in this event, return HTTP 200 with {} (or [] in array format). Current-key failures, a record that changes while it is read and unexpected errors keep their normal error status.

Good to know

The response includes amounts, payment details and invoice metadata.

Invoice attachment

The response includes invoice_attachment immediately after payment_notes, without a hydration option. It contains the invoice attachment ID, original file name and added time, or null when no invoice is attached. Use the invoice download method for its contents.

An inconsistent saved invoice reference returns HTTP409 rather than being shown as an empty slot. Invoice attachments are separate from the parent record's edit revision.

Formatted text in the response

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

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

Example response

{
  "id": 34567,
  "event_id": 23456,
  "event_name": "Sample Event",
  "playbook_activity_id": 12345,
  "description": "Meeting room booking",
  "vendor_payee": null,
  "reference_number": null,
  "expense_date": null,
  "notes": null,
  "payment_status_id": 0,
  "payment_status": {
    "id": 0,
    "name": "N/A"
  },
  "payment_due_date": null,
  "next_payment_due_date": null,
  "payment_notes": null,
  "invoice_attachment": {
    "id": 1004567,
    "filename": "activity-cost-invoice.pdf",
    "attachment_created_timestamp": "2027-01-30T12:00:00Z"
  },
  "cost": {
    "amount": 125.50,
    "cost_center_breakdown": [
      {
        "cost_center_id": 34567,
        "cost_center": "Marketing",
        "charge": 75.50
      },
      {
        "cost_center_id": 34568,
        "cost_center": "Operations",
        "charge": 50.00
      }
    ]
  }
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Retrieve Playbook Costs #

Method
GET
Endpoint

Retrieves all costs for a Playbook activity.

Parameters
Name Type Required? Description Details
filter_by_event_id Number Yes
The ID of the Event whose Playbook costs to list. Every cost of every activity in that Event is returned unless filter_by_playbook_activity_id is also sent.
filter_by_playbook_activity_id Number No
Optional: only list the costs of this Playbook activity in that Event.
$limit Number No
The most records to return, as a positive whole number. Omit for all remaining records.
$offset Number No
How many records to skip: a whole number of 0 or more; 0 by default.
$result_format String No
By default, the response is an object containing list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
Allowed values: array | wrapped_in_array

Good to know

The response includes amounts, payment details and invoice metadata.

Invoice attachment

The response includes invoice_attachment immediately after payment_notes, without a hydration option. It contains the invoice attachment ID, original file name and added time, or null when no invoice is attached. Use the invoice download method for its contents.

An inconsistent saved invoice reference returns HTTP409 rather than being shown as an empty slot. Invoice attachments are separate from the parent record's edit revision.

Formatted text in the response

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

Code Samples
curl -X GET "https://api.exhibitday.com/v1/events/playbook_activity_costs?filter_by_event_id=23456" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "list_type": "playbook_activity_cost",
  "list_data": [
    {
      "id": 34567,
      "event_id": 23456,
      "event_name": "Sample Event",
      "playbook_activity_id": 12345,
      "description": "Meeting room booking",
      "vendor_payee": null,
      "reference_number": null,
      "expense_date": null,
      "notes": null,
      "payment_status_id": 0,
      "payment_status": {
        "id": 0,
        "name": "N/A"
      },
      "payment_due_date": null,
      "next_payment_due_date": null,
      "payment_notes": null,
      "invoice_attachment": {
        "id": 1004567,
        "filename": "activity-cost-invoice.pdf",
        "attachment_created_timestamp": "2027-01-30T12:00:00Z"
      },
      "cost": {
        "amount": 0.00,
        "cost_center_breakdown": []
      }
    }
  ],
  "records_found": 1,
  "total_records": 1,
  "has_more": false
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Add a Playbook Cost #

Method
POST
Endpoint

Adds a cost to a Playbook activity.

Parameters
Name Type Required? Description Details
playbook_activity_id Number Yes
The ID of the Playbook activity in that event. Use its ID from the activity list, Info or Create response.
description String Yes
A description for this cost, up to 400 characters. This is required on create and cannot be cleared.
max length: 400
vendor_payee String No
Vendor Payee, up to 200 characters.
max length: 200
reference_number String No
Reference Number, up to 200 characters.
max length: 200
expense_date String No
A calendar date in YYYY-MM-DD format, without a time or time zone.
notes String No
Plain-text Notes, up to 80,000 characters as saved, including formatting and encoded characters. Line breaks are retained. An over-limit value is refused, never shortened. On PATCH, an omitted or blank value keeps the current Notes; null clears them.
Max length: 80000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
payment_status_id Number No
The cost's payment status. Omit or send null for N/A. This does not change the recorded amount or attach an invoice.
Allowed values: 0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet)
payment_due_date String No
A calendar date in YYYY-MM-DD format, without a time or time zone.
next_payment_due_date Date No
A calendar date in YYYY-MM-DD format, without a time or time zone. Applies only when the payment status is Partially Paid. With any other status, supplying either this date or the payment status clears the date.
payment_notes String No
Payment Notes, up to 200 characters.
max length: 200
cost Number or cost object No
The full cost, as a number or an object with amount and/or cost_center_breakdown. Record Costs and Split Them Across Cost Centers.
View value format and limits

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

{
  "anyOf": [
    {
      "type": "number",
      "minimum": 0,
      "description": "Shorthand for an object with amount. The amount is rounded to cents before the supported storage range is checked.",
      "nullable": true
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "number",
          "minimum": 0.0,
          "maximum": 79228162514264337593543950335.0
        },
        "cost_center_breakdown": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "cost_center_id": {
                "type": "integer",
                "format": "int64",
                "nullable": true
              },
              "charge": {
                "type": "number",
                "minimum": 0.0,
                "maximum": 79228162514264337593543950335.0
              },
              "cost_center": {
                "type": "string",
                "description": "Optional and read-only: the cost center name a read returns, so a cost can be sent back unchanged. It is ignored; the line is saved by cost_center_id, and a name that doesn't match that cost center is explained in a warning.",
                "nullable": true
              }
            },
            "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
            "required": [
              "charge"
            ]
          },
          "maxItems": 2147483647
        }
      },
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
      "anyOf": [
        {
          "required": [
            "amount"
          ]
        },
        {
          "required": [
            "cost_center_breakdown"
          ]
        }
      ],
      "nullable": true
    }
  ],
  "x-numeric-shorthand": "A number is equivalent to {amount:number}.",
  "nullable": true,
  "x-maximum-depth": 3,
  "x-empty-create-means-omitted": true,
  "example": {
    "amount": 125.50
  }
}
Optional; defaults to zero.
$result_format String No
By default, the response is a single object. Send array to get it inside a one-item array.
Allowed values: array | object

Good to know

Adds a cost to a Playbook activity. The response includes the new cost and its ID.

Creating the cost

Send playbook_activity_id and description. An activity can contain up to 500 costs. Costs cannot move between activities.

Creating this record does not attach an invoice; its invoice attachment metadata is null. Add an invoice using the separate invoice attachment method.

Access and locks

Your current API access and the Event's Playbook visibility and lock settings apply, along with access to activity costs.

Sending the request

Use JSON, the query string or form data for values containing commas. Send comma-containing text and cost-center breakdowns in JSON, query parameters or form fields.

To make a retry safe, send an Idempotency-Key. Resending the same request with the same key returns the saved response instead of adding a second cost.

After the add

This action sends no business email.

Confirmed changes appear in activity history; a history-writing failure does not undo the change.

If you can't confirm the result and didn't send an Idempotency-Key, retrieve the activity's costs before trying again; the API does not repeat the action automatically.

Sending text

Send plain text for Notes and other rich-text fields. Characters such as &, < and quotes, along with line breaks, are encoded for storage.

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

Hidden or locked tab

If the Event's Playbook tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

Code Samples
curl -X POST "https://api.exhibitday.com/v1/events/playbook_activity_costs" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"playbook_activity_id\":12345,\"description\":\"Meeting room booking\"}"

Example response

{
  "id": 34567,
  "event_id": 23456,
  "event_name": "Sample Event",
  "playbook_activity_id": 12345,
  "description": "Meeting room booking",
  "vendor_payee": null,
  "reference_number": null,
  "expense_date": null,
  "notes": null,
  "payment_status_id": 0,
  "payment_status": {
    "id": 0,
    "name": "N/A"
  },
  "payment_due_date": null,
  "next_payment_due_date": null,
  "payment_notes": null,
  "invoice_attachment": null,
  "cost": {
    "amount": 0.00,
    "cost_center_breakdown": []
  }
}
Note: IDs are illustrative; use IDs from your workspace.

Update a Playbook Cost #

Method
PATCH
Endpoint

Updates an existing Playbook cost.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the cost in that activity. Use its ID from the cost list, Info or Create response; this is not an invoice or cost-allocation ID.
description String No
A description for this cost, up to 400 characters. This is required on create and cannot be cleared.
max length: 400
vendor_payee String No
Vendor Payee, up to 200 characters.
max length: 200
reference_number String No
Reference Number, up to 200 characters.
max length: 200
expense_date String No
A calendar date in YYYY-MM-DD format, without a time or time zone.
notes String No
Plain-text Notes, up to 80,000 characters as saved, including formatting and encoded characters. Line breaks are retained. An over-limit value is refused, never shortened. On PATCH, an omitted or blank value keeps the current Notes; null clears them.
Max length: 80000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
payment_status_id Number No
The cost's payment status. Omit or leave blank to keep it; null cannot clear it. This does not change the recorded amount or attach an invoice.
Allowed values: 0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet)
payment_due_date String No
A calendar date in YYYY-MM-DD format, without a time or time zone.
next_payment_due_date Date No
A calendar date in YYYY-MM-DD format, without a time or time zone. Applies only when the payment status is Partially Paid. With any other status, supplying either this date or the payment status clears the date.
payment_notes String No
Payment Notes, up to 200 characters.
max length: 200
cost Number or cost object No
The full cost, as a number or an object with amount and/or cost_center_breakdown. Record Costs and Split Them Across Cost Centers.
View value format and limits

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

{
  "anyOf": [
    {
      "type": "number",
      "minimum": 0,
      "description": "Shorthand for an object with amount. The amount is rounded to cents before the supported storage range is checked.",
      "nullable": true
    },
    {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "amount": {
          "type": "number",
          "minimum": 0.0,
          "maximum": 79228162514264337593543950335.0
        },
        "cost_center_breakdown": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "cost_center_id": {
                "type": "integer",
                "format": "int64",
                "nullable": true
              },
              "charge": {
                "type": "number",
                "minimum": 0.0,
                "maximum": 79228162514264337593543950335.0
              },
              "cost_center": {
                "type": "string",
                "description": "Optional and read-only: the cost center name a read returns, so a cost can be sent back unchanged. It is ignored; the line is saved by cost_center_id, and a name that doesn't match that cost center is explained in a warning.",
                "nullable": true
              }
            },
            "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
            "required": [
              "charge"
            ]
          },
          "maxItems": 2147483647
        }
      },
      "x-member-name-comparison": "ordinal-ignore-case; duplicate case variants are rejected",
      "anyOf": [
        {
          "required": [
            "amount"
          ]
        },
        {
          "required": [
            "cost_center_breakdown"
          ]
        }
      ],
      "nullable": true
    }
  ],
  "x-numeric-shorthand": "A number is equivalent to {amount:number}.",
  "nullable": true,
  "x-maximum-depth": 3,
  "x-empty-create-means-omitted": true,
  "example": {
    "amount": 125.50
  }
}
Omit to keep the saved cost. A supplied value replaces its full allocation.
expected_revision String No
The record_revision returned when you retrieved this record. Include it to avoid overwriting someone else's changes. Omit it to skip this check.

Good to know

Updates the fields you choose on an existing Playbook cost. Omitted fields keep their current values.

Choosing what to change

Send only what you want to change. Omitted or blank whole parameters keep their values; null clears only fields that allow it. With $ignore_params_with_empty_values=true, a whole JSON-null parameter is ignored, while the text "null" still requests clearing.

A cost cannot move to another activity. Use the cost fields below to change its description, payment details or amounts.

Access and locks

Your current API access and the Event's Playbook visibility and lock settings apply, along with access to activity costs.

Sending the request

Use JSON, the query string or form data for values containing commas. Send comma-containing text and cost-center breakdowns in JSON, query parameters or form fields. This method ignores Idempotency-Key.

After the update

This action sends no business email.

An unchanged PATCH writes no data, timestamp or history.

Confirmed changes appear in activity history; a history-writing failure does not undo the change.

If a save result cannot be confirmed, review the cost before trying again; the API does not repeat the action automatically.

Sending text

Send plain text for Notes and other rich-text fields. Characters such as &, < and quotes, along with line breaks, are encoded for storage.

Hidden or locked tab

If the Event's Playbook tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

Code Samples
curl -X PATCH "https://api.exhibitday.com/v1/events/playbook_activity_costs" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":34567,\"description\":\"Meeting room booking\"}"

Example response

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

Delete a Playbook Cost #

Method
DELETE
Endpoint

Deletes an existing Playbook cost.

Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the cost in that activity. Use its ID from the cost list, Info or Create response; this is not an invoice or cost-allocation ID.

Good to know

Permanently deletes one Playbook cost, its cost-center breakdown and its invoice. Other costs on the activity stay as they are.

Access and locks

Your current API access and the Event's Playbook visibility and lock settings apply, along with access to activity costs.

Sending the request

Use JSON, the query string or form data for values containing commas. This method ignores Idempotency-Key.

After the deletion

This action sends no business email.

The deletion appears in activity history; a history-writing failure does not undo it.

If you can't confirm the deletion, retrieve the activity's costs before trying again; the API does not repeat the action automatically.

Hidden or locked tab

If the Event's Playbook tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first. An Event that is not in your workspace returns HTTP 404.

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

Example response

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

Download Playbook Cost Invoice Attachment #

Method
GET
Endpoint

Downloads the Invoice Attachment for a Playbook Cost.

Parameters
Name Type Required? Description Details
playbook_activity_cost_id Number Yes
The ID of the Playbook cost entry.
Use the cost entry's id from Retrieve Playbook Costs (GET /v1/events/playbook_activity_costs), rather than a cost-center allocation ID. Each cost entry has its own Invoice Attachment. The API finds the cost's Playbook activity, so playbook_activity_id is not sent.

Good to know

Downloads the original Invoice Attachment for this Playbook Cost. Use this method to retrieve the file itself.

Finding the file

In the web app, this is the invoice control beside the selected Playbook activity's cost entry. Each cost has one Invoice Attachment even when its amount is split among cost centers.

For file metadata, retrieve the parent record with GET /v1/events/playbook_activity_costs/info and read invoice_attachment. Use this download method for the contents. No attachment ID or invoice flag is needed.

Download response

A successful response contains the original uploaded file, with a safe download filename. API errors use the usual JSON response. If no invoice is attached, this method returns HTTP 404.

Current record, financial and invoice permissions apply. A locked tab can still be read. Permitted downloads remain available on the Free plan.

Files still being copied

If this file is still being copied, the download returns HTTP 409 with file_copy_pending. Try the download again in a few minutes.

Hidden tab

If the Event's Playbook tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X GET "https://api.exhibitday.com/v1/events/playbook_activity_costs/invoice_attachment/download?playbook_activity_cost_id=12345" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
mv response-body.tmp 'invoice.pdf'

Example response

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

Add Playbook Cost Invoice Attachment #

Method
POST
Endpoint

Adds an Invoice Attachment to a Playbook Cost.

Parameters
Name Type Required? Description Details
playbook_activity_cost_id Number Yes
The ID of the Playbook cost entry.
Use the cost entry's id from Retrieve Playbook Costs (GET /v1/events/playbook_activity_costs), rather than a cost-center allocation ID. Each cost entry has its own Invoice Attachment. The API finds the cost's Playbook activity, so playbook_activity_id is not sent.
file File (multipart) Yes
The Invoice Attachment to upload.

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

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

Maximum files per request: 1.

View value format and limits

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

{
  "type": "string",
  "format": "binary",
  "x-maximum-bytes": 26214400,
  "x-allowed-extensions": [
    "png",
    "jpg",
    "jpeg",
    "bmp",
    "gif",
    "pdf",
    "msg",
    "eml",
    "doc",
    "docx",
    "ppt",
    "pptx",
    "xls",
    "xlsx",
    "csv",
    "rtf",
    "odp",
    "odt",
    "ods",
    "txt",
    "wks",
    "zip"
  ]
}
Send exactly one complete, nonempty multipart/form-data file part named file. The supported extensions and current per-file limit are shown below; the complete request limit also includes multipart overhead. A missing or null file is invalid and does not remove an existing invoice.
Idempotency-Key String No
A unique key for safely retrying this upload.
Optional HTTP header: 1 to 255 visible ASCII characters without spaces or commas. Retry the identical request with the same key to replay its first saved response. Use a new key for a different upload.

Good to know

Adds one Invoice Attachment to this Playbook Cost. You can attach an invoice, receipt or other payment document when no invoice file is currently attached.

Before you upload

POST requires an empty invoice slot. If an invoice is already attached, the API returns HTTP 409; use PATCH to replace it.

An Invoice Attachment is separate from the record's supporting File Attachments. Use the invoice control beside the selected Playbook activity's cost entry in the web app.

After the upload

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

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

Access and retries

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

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

Hidden or locked tab

If the Event's Playbook tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X POST "https://api.exhibitday.com/v1/events/playbook_activity_costs/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "playbook_activity_cost_id=12345" --form "file=@invoice.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp

Example response

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

Replace Playbook Cost Invoice Attachment #

Method
PATCH
Endpoint

Replaces a Playbook Cost's Invoice Attachment.

Parameters
Name Type Required? Description Details
playbook_activity_cost_id Number Yes
The ID of the Playbook cost entry.
Use the cost entry's id from Retrieve Playbook Costs (GET /v1/events/playbook_activity_costs), rather than a cost-center allocation ID. Each cost entry has its own Invoice Attachment. The API finds the cost's Playbook activity, so playbook_activity_id is not sent.
file File (multipart) Yes
The Invoice Attachment to upload.

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

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

Maximum files per request: 1.

View value format and limits

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

{
  "type": "string",
  "format": "binary",
  "x-maximum-bytes": 26214400,
  "x-allowed-extensions": [
    "png",
    "jpg",
    "jpeg",
    "bmp",
    "gif",
    "pdf",
    "msg",
    "eml",
    "doc",
    "docx",
    "ppt",
    "pptx",
    "xls",
    "xlsx",
    "csv",
    "rtf",
    "odp",
    "odt",
    "ods",
    "txt",
    "wks",
    "zip"
  ]
}
Send exactly one complete, nonempty multipart/form-data file part named file. The supported extensions and current per-file limit are shown below; the complete request limit also includes multipart overhead. A missing or null file is invalid and does not remove an existing invoice.

Good to know

Replaces this Playbook Cost's current Invoice Attachment with one uploaded file. Use this method when an invoice file is already attached.

Replacing the current file

PATCH requires a current invoice file. If none is attached, the API returns HTTP 404. Upload exactly one file; the previous attachment ID is not needed.

If another request changes the current invoice during your upload, the API refuses this request instead of replacing a different file. Even identical replacement contents receive a new attachment ID.

After the replacement

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

The previous file is scheduled for physical cleanup after a confirmed save; cleanup may finish later. The replacement is recorded in Event history.

Access and retries

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

expected_revision is not supported by this file method. PATCH does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/playbook_activity_costs/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Playbook tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X PATCH "https://api.exhibitday.com/v1/events/playbook_activity_costs/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "playbook_activity_cost_id=12345" --form "file=@invoice.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp

Example response

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

Remove Playbook Cost Invoice Attachment #

Method
DELETE
Endpoint

Deletes a Playbook Cost's Invoice Attachment.

Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.

Parameters
Name Type Required? Description Details
playbook_activity_cost_id Number Yes
The ID of the Playbook cost entry.
Use the cost entry's id from Retrieve Playbook Costs (GET /v1/events/playbook_activity_costs), rather than a cost-center allocation ID. Each cost entry has its own Invoice Attachment. The API finds the cost's Playbook activity, so playbook_activity_id is not sent.

Good to know

Removes this Playbook Cost's Invoice Attachment. The cost, payment details and other File Attachments stay in place.

After the removal

The Invoice Attachment is cleared and the removal is recorded in Event history. Its physical file is scheduled for cleanup after a confirmed save; cleanup may finish later. Costs, payment fields, cost-center allocations and supporting files stay unchanged.

If no invoice is attached, DELETE returns HTTP 404 Not Found with the message "This Playbook Cost has no invoice to remove." No saved data or history is changed. Current access and the record's binding are still checked. Do not send file parts with this request.

Access and retries

Current record, financial and invoice permissions and applicable tab-edit access are required. Permitted removals remain available on the Free plan.

expected_revision is not supported, and DELETE does not use Idempotency-Key replay. If the save outcome cannot be confirmed, retrieve the current parent record with GET /v1/events/playbook_activity_costs/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Playbook tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

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

Example response

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

Retrieve Playbook Activity General File Attachments #

Method
GET
Endpoint

Retrieves the General File Attachments on a Playbook Activity.

Parameters
Name Type Required? Description Details
playbook_activity_id Number Yes
The ID of the Playbook activity, from Retrieve Playbook Activities (GET /v1/events/playbook_activities) or its add response.
$limit Number No
The most File Attachments to return.
A positive whole number. Omit for all remaining matching files.
$offset Number No
The number of matching File Attachments to skip.
A whole number of 0 or more. Default: 0.
$result_format String No
By default, the response is an object containing list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records.
Allowed values: array
If-None-Match String No
An ETag from an earlier response to this GET.
Optional HTTP header. If the successful response is unchanged, the API returns HTTP 304 with no body.

Good to know

Retrieves the General File Attachments on this Playbook Activity. Each result includes the file's ID, name and added time; use the download method for its contents.

Reading the file list

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

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

Supporting files and invoices

A Playbook activity can have several cost entries, each with its own Invoice Attachment. Those files use the cost-invoice methods; this list contains the activity's General File Attachments.

Access

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

Hidden tab

If the Event's Playbook tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.

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

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "attachment",
  "list_data": [
    {
      "id": 12345,
      "filename": "attachment.pdf",
      "attachment_created_timestamp": "2027-01-30T12:00:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Add Playbook Activity General File Attachments #

Method
POST
Endpoint

Adds General File Attachments to a Playbook Activity.

Parameters
Name Type Required? Description Details
playbook_activity_id Number Yes
The ID of the Playbook activity, from Retrieve Playbook Activities (GET /v1/events/playbook_activities) or its add response.
file File (multipart) Yes
The File Attachments to upload.

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

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

View value format and limits

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

{
  "type": "array",
  "items": {
    "type": "string",
    "format": "binary",
    "x-maximum-bytes": 26214400,
    "x-allowed-extensions": [
      "png",
      "jpg",
      "jpeg",
      "bmp",
      "gif",
      "pdf",
      "msg",
      "eml",
      "doc",
      "docx",
      "ppt",
      "pptx",
      "xls",
      "xlsx",
      "csv",
      "rtf",
      "odp",
      "odt",
      "ods",
      "txt",
      "wks",
      "zip"
    ]
  }
}
Send one or more complete, nonempty multipart/form-data parts, each named file. Supported types and the current per-file limit are shown below. The complete request limit includes all files and multipart overhead; split larger batches. A missing or null upload is not a removal request.
Idempotency-Key String No
A unique key for safely retrying this upload.
Optional HTTP header: 1 to 255 visible ASCII characters without spaces or commas. Retry the identical request with the same key to replay its first saved response. Use a new key for a different upload.

Good to know

Adds one or more General File Attachments to this Playbook Activity. Send each file as a multipart upload part named file.

After the upload

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

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

Choosing the right file method

These uploads add supporting files to the activity. Use the Playbook Cost Invoice Attachment methods with the cost entry's ID to attach an invoice or receipt to a specific cost. Adding supporting files does not change the activity's costs or payments.

Access

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

History and retries

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

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

Hidden or locked tab

If the Event's Playbook tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X POST "https://api.exhibitday.com/v1/events/playbook_activities/attachments" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "playbook_activity_id=12345" --form "file=@attachment.pdf;type=application/octet-stream")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
cat response-body.tmp

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "attachment",
  "list_data": [
    {
      "id": 12345,
      "filename": "attachment.pdf",
      "attachment_created_timestamp": "2027-01-30T12:00:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Remove a Playbook Activity General File Attachment #

Method
DELETE
Endpoint

Deletes a General File Attachment from a Playbook Activity.

Note: Inputs that do not apply to this operation, including the ignore-empty option, are ignored and reported in the X-API-Warnings response header.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the File Attachment.
Use the id from the attachment list. The API finds the record the file belongs to, so no record ID is sent. An Invoice Attachment is not selected by this method.

Good to know

Removes one General File Attachment from this Playbook Activity. Other attached files and the record's details stay in place.

After the removal

Only the selected file association is removed. Its physical file is scheduled for cleanup after a confirmed save; cleanup may finish later. Other attached files stay in place.

Send only the file's id; the API finds the record it belongs to. A missing, already removed or unavailable attachment returns HTTP 404 Not Found. Do not send file parts with DELETE.

Access

Current record and file-removal permissions and applicable Event/tab locks must allow this change. Permitted removals remain available on the Free plan.

History and retries

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

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

Hidden or locked tab

If the Event's Playbook tab is hidden or locked, this request returns HTTP 400 (not_allowed), and the message names the tab. Show or unlock the tab in ExhibitDay first.

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

Example response

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

Download a Playbook Activity General File Attachment #

Method
GET
Endpoint

Downloads a General File Attachment from a Playbook Activity.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the File Attachment.
Use the id from the attachment list. The API finds the record the file belongs to, so no record ID is sent. An Invoice Attachment is not selected by this method.

Good to know

Downloads one original General File Attachment from this Playbook Activity. Select the file using its ID from the attachment list.

Download response

A successful response contains the original uploaded file with a safe download filename. API errors use the usual JSON response. A missing or unavailable file returns HTTP 404.

Send only the file's id from the attachment list to download that one file; the API finds the record it belongs to. The download leaves the record unchanged.

Access

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

Files still being copied

If this file is still being copied, the download returns HTTP 409 with file_copy_pending. Try the download again in a few minutes.

Hidden tab

If the Event's Playbook tab is hidden, this request returns HTTP 400 (not_allowed), and the message says the tab is hidden. Show the tab in ExhibitDay first. A locked tab can still be read.

Code Samples
# bash; inspect an error body instead of saving it as the requested file.
status=$(curl --silent --show-error -X GET "https://api.exhibitday.com/v1/events/playbook_activities/attachments/download?id=12345" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}")
if [ "$status" != 200 ]; then cat response-body.tmp; exit 1; fi
mv response-body.tmp 'attachment.pdf'

Example response

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