EventsSponsorships

Sponsorships

Retrieve a Single Sponsorship by ID #

Method
GET
Endpoint
Sample Object

Retrieves a single Sponsorship by its ID.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Sponsorship. Use the id from Retrieve Sponsorships (GET /v1/events/sponsorships) or from the add response; you don't send the Event ID.
$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 Sponsorship not available in this Event, return HTTP 200 with {} (or [] in array format). API key errors, conflicts with a change in progress and unexpected errors keep their normal error status.

Good to know

The response includes details, notes, costs and payment information.

Current Event and access

The Sponsorship's current Event is determined automatically. The request must have access to that Event and its Sponsorships tab.

Record revision

Set $include_record_revision=true to get record_revision, which covers this Sponsorship's editable fields, costs, related-item links and Event binding. Send it as expected_revision with a later update. File Attachment and Invoice Attachment metadata and contents are not covered.

File Attachments

The response includes the Invoice Attachment metadata as invoice_attachment, or null when no invoice is attached. Use the separate File Attachment collection to retrieve ordinary attachment metadata.

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/sponsorships/info?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "id": 12345,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345&riType=7&riSub=0&riId=12345",
  "event_id": 12345,
  "event_name": "Sample Event",
  "name": "Welcome reception",
  "acquisition_status_id": 1,
  "acquisition_status": "Need to Acquire",
  "acquire_by_date": null,
  "acquired_date": null,
  "agreement_confirmation_number": null,
  "organizer_provider": null,
  "contact_name": null,
  "contact_email": null,
  "contact_phone": null,
  "portal_url": null,
  "benefits_inclusions": "",
  "coverage_placement_details": "",
  "conditions_restrictions": "",
  "materials_contributions_required": "",
  "submission_delivery_instructions": "",
  "key_dates_deadlines": "",
  "benefits_received_outstanding": "",
  "notes": "",
  "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": 382345,
    "filename": "sponsorship-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
      }
    ]
  },
  "related_items": [
    {
      "id": 5551,
      "related_item_id": 67890,
      "related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/TaskView/98765?tid=67890",
      "related_item_type_id": 1,
      "related_item_type": "Task",
      "related_item_asset_type_id": null,
      "related_item_name": "Confirm booth graphics with the printer",
      "related_item_created_timestamp": "2030-01-10T14:03:00Z"
    },
    {
      "id": 5552,
      "related_item_id": 45678,
      "related_item_exhibitday_url": "https://www.exhibitday.com/Workspace/RelatedItemView/98765?typeId=4&subTypeId=0&rid=45678",
      "related_item_type_id": 4,
      "related_item_type": "Shipment",
      "related_item_asset_type_id": null,
      "related_item_name": "Booth crates to convention center",
      "related_item_created_timestamp": "2030-01-10T14:03:00Z"
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Retrieve Sponsorships #

Method
GET
Endpoint

Retrieves Sponsorships 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.
$limit Number No
The most Sponsorships to return (a whole number of 1 or more). Leave it out to return all remaining matching records.
$offset Number No
How many matching Sponsorships to skip (a whole number of 0 or more; 0 by default). Use this with $limit to read the next page.
$result_format String No
By default, the response is an object containing list_data and the paging totals (records_found, total_records, has_more). Send array to get just a JSON array of the records, or wrapped_in_array to get the default object inside a one-item array.
Allowed values: array | wrapped_in_array
hydrate_related_items Boolean No
Set to true to include each record's related_items: the Tasks and items linked to it, with the key to use when adding or removing a link. Omit it or send false to leave related_items out of list results. Single-record GETs always include related_items.
Default: false.

Good to know

Retrieves records across your workspace's readable Event tabs. Use filter_by_event_id to narrow the results to one Event, or omit it for the workspace list. Each record includes its event_id and Event name.

Choosing Events

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

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

Reading pages

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

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

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

Handling input and changes

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

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

Related items

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

Events with a hidden Sponsorships tab

Records on Events whose Sponsorships 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/sponsorships" -H "Authorization: Bearer YOUR_API_KEY"

Example response

{
  "records_found": 1,
  "total_records": 1,
  "has_more": false,
  "list_type": "sponsorship",
  "list_data": [
    {
      "id": 12345,
      "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345&riType=7&riSub=0&riId=12345",
      "event_id": 12345,
      "event_name": "Sample Event",
      "name": "Welcome reception",
      "acquisition_status_id": 1,
      "acquisition_status": "Need to Acquire",
      "acquire_by_date": null,
      "acquired_date": null,
      "agreement_confirmation_number": null,
      "organizer_provider": null,
      "contact_name": null,
      "contact_email": null,
      "contact_phone": null,
      "portal_url": null,
      "benefits_inclusions": "",
      "coverage_placement_details": "",
      "conditions_restrictions": "",
      "materials_contributions_required": "",
      "submission_delivery_instructions": "",
      "key_dates_deadlines": "",
      "benefits_received_outstanding": "",
      "notes": "",
      "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": 382345,
        "filename": "sponsorship-invoice.pdf",
        "attachment_created_timestamp": "2027-01-30T12:00:00Z"
      },
      "cost": {
        "amount": 0.00,
        "cost_center_breakdown": []
      }
    }
  ]
}
Note: IDs are illustrative; use IDs from your workspace. The filename is an example.

Add a Sponsorship #

Method
POST
Endpoint

Adds a Sponsorship to an Event.

Parameters
Name Type Required? Description Details
event_id Number Yes
The id of the Event in your workspace to add the Sponsorship to.
name String Yes
The Sponsorship name, up to 300 characters. It can't be blank.
max length: 300
acquisition_status_id Number No
Whether the Sponsorship still needs to be acquired. Optional when adding a Sponsorship: omitted, blank or null means Need to Acquire. Choosing Need to Acquire clears the acquisition date and agreement or confirmation number, while keeping financial details.
Allowed values: 1 (Need to Acquire) | 2 (Already Acquired)
notes String No
Send plain text for notes; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
acquire_by_date String No
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and null clears it. This date applies regardless of acquisition or payment status.
payment_status_id Number No
The Sponsorship's payment status. Omit for N/A; null resets it to N/A. A status other than Partially Paid clears the next partial payment due date. Payment status can be recorded for either acquisition status.
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. On PATCH, an omitted or blank value keeps the current date, and null clears it. This date applies regardless of acquisition or payment status.
next_payment_due_date Date No
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and null clears it. Applies only when the payment status is Partially Paid (payment_status_id=2). With any other status, supplying either this date or the payment status clears the date.
payment_notes String No
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 200
acquired_date String No
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and null clears it. Applies only when the acquisition status is Already Acquired (acquisition_status_id=2). With any other status, supplying this date, the acquisition status or the agreement or confirmation number clears the date.
agreement_confirmation_number String No
The agreement or confirmation number, up to 200 characters. This applies only to Already Acquired (acquisition_status_id=2); otherwise it is cleared when the acquisition status, date or agreement information is supplied. On PATCH, an omitted or blank value keeps it; null clears it.
max length: 200
organizer_provider String No
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 200
contact_name String No
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 200
contact_email String No
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 200
contact_phone String No
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 200
portal_url String No
Up to 2000 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 2000
benefits_inclusions String No
Send plain text for benefits inclusions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
coverage_placement_details String No
Send plain text for coverage placement details; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
conditions_restrictions String No
Send plain text for conditions restrictions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
materials_contributions_required String No
Send plain text for materials contributions required; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
submission_delivery_instructions String No
Send plain text for submission delivery instructions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
key_dates_deadlines String No
Send plain text for key dates deadlines; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
benefits_received_outstanding String No
Send plain text for benefits received outstanding; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
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

These methods manage Sponsorships for an existing Event in your workspace. Supply the Event id and, for an existing Sponsorship, its id; a Sponsorship cannot be moved to another Event. Your current permissions and the Event's hidden or locked tab settings apply. A Sponsorship records what you plan to acquire and whether it has been acquired. Its costs, payment details and Cost Invoice / Receipt are separate: recording a cost does not attach an invoice or mark a payment complete. Deleting a Sponsorship removes its own costs, related-item links and attachment records together, then schedules only its files for physical cleanup. No contact or assignee email is sent. A POST Idempotency-Key must be one value without commas. Send text containing commas and cost lists through JSON, the query string or form fields. A URL may retain its own %2C encoding; other text is not percent-decoded. Optional Idempotency-Key replay applies to POST; PATCH and DELETE retain their existing behavior of ignoring that header. A confirmed change is then added to history; failure to write history does not undo the saved change. An unchanged PATCH writes no data, timestamp or history. Creating this record does not attach an invoice; its invoice attachment metadata is null. Add an invoice using the separate invoice attachment method.

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

Acquisition status

When adding, acquisition_status_id is optional and defaults to Need to Acquire. The same statuses use different IDs in each family: Sponsorships use 1 for Need to Acquire and 2 for Already Acquired; Giveaways use 10 and 20.

Open in ExhibitDay

The created record includes exhibitday_url, the record's page in ExhibitDay. It is the same link that GET /v1/events/sponsorships/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/sponsorships" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"event_id\":12345,\"name\":\"Welcome reception\",\"acquisition_status_id\":1}"

Example response

{
  "id": 23456,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=12345&riType=7&riSub=0&riId=23456",
  "event_id": 12345,
  "event_name": "Sample Event",
  "name": "Welcome reception",
  "acquisition_status_id": 1,
  "acquisition_status": "Need to Acquire",
  "acquire_by_date": null,
  "acquired_date": null,
  "agreement_confirmation_number": null,
  "organizer_provider": null,
  "contact_name": null,
  "contact_email": null,
  "contact_phone": null,
  "portal_url": null,
  "benefits_inclusions": "",
  "coverage_placement_details": "",
  "conditions_restrictions": "",
  "materials_contributions_required": "",
  "submission_delivery_instructions": "",
  "key_dates_deadlines": "",
  "benefits_received_outstanding": "",
  "notes": "",
  "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 Sponsorship #

Method
PATCH
Endpoint

Updates an existing Sponsorship.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Sponsorship to update. Use the id from Retrieve Sponsorships (GET /v1/events/sponsorships) or from the add response.
name String No
The Sponsorship name, up to 300 characters. Omit or leave blank to keep the current name. The name can't be cleared.
max length: 300
acquisition_status_id Number No
Whether the Sponsorship still needs to be acquired. Omit or leave blank to keep it; null is refused. Choosing Need to Acquire clears the acquisition date and agreement or confirmation number, while keeping financial details.
Allowed values: 1 (Need to Acquire) | 2 (Already Acquired)
notes String No
Send plain text for notes; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
acquire_by_date String No
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and null clears it. This date applies regardless of acquisition or payment status.
payment_status_id Number No
The Sponsorship's payment status. Omit or leave blank to keep it; null resets it to N/A. A status other than Partially Paid clears the next partial payment due date. Payment status can be recorded for either acquisition status.
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. On PATCH, an omitted or blank value keeps the current date, and null clears it. This date applies regardless of acquisition or payment status.
next_payment_due_date Date No
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and null clears it. Applies only when the payment status is Partially Paid (payment_status_id=2). With any other status, supplying either this date or the payment status clears the date.
payment_notes String No
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 200
acquired_date String No
A calendar date in YYYY-MM-DD format, without a time or time zone. On PATCH, an omitted or blank value keeps the current date, and null clears it. Applies only when the acquisition status is Already Acquired (acquisition_status_id=2). With any other status, supplying this date, the acquisition status or the agreement or confirmation number clears the date.
agreement_confirmation_number String No
The agreement or confirmation number, up to 200 characters. This applies only to Already Acquired (acquisition_status_id=2); otherwise it is cleared when the acquisition status, date or agreement information is supplied. On PATCH, an omitted or blank value keeps it; null clears it.
max length: 200
organizer_provider String No
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 200
contact_name String No
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 200
contact_email String No
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 200
contact_phone String No
Up to 200 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 200
portal_url String No
Up to 2000 characters. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
max length: 2000
benefits_inclusions String No
Send plain text for benefits inclusions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
coverage_placement_details String No
Send plain text for coverage placement details; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
conditions_restrictions String No
Send plain text for conditions restrictions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
materials_contributions_required String No
Send plain text for materials contributions required; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
submission_delivery_instructions String No
Send plain text for submission delivery instructions; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
key_dates_deadlines String No
Send plain text for key dates deadlines; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
benefits_received_outstanding String No
Send plain text for benefits received outstanding; line breaks are kept. If you send HTML, only its text is saved. The text must fit within 30,000 characters both when saved and when counted by the Sponsorship editor in ExhibitDay; formatting and encoded characters count toward those limits. Existing text over a limit can be kept or shortened, but cannot grow under either count. On PATCH, an omitted or blank value keeps it; null clears it. This applies to either acquisition status.
Max length: 30000. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
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

These methods manage Sponsorships for an existing Event in your workspace. Supply the Event id and, for an existing Sponsorship, its id; a Sponsorship cannot be moved to another Event. Your current permissions and the Event's hidden or locked tab settings apply. A Sponsorship records what you plan to acquire and whether it has been acquired. Its costs, payment details and Cost Invoice / Receipt are separate: recording a cost does not attach an invoice or mark a payment complete. Deleting a Sponsorship removes its own costs, related-item links and attachment records together, then schedules only its files for physical cleanup. No contact or assignee email is sent. On PATCH, send only fields you want to change; omitted or blank values keep their current values. null clears a field only when that field supports clearing. If you use $ignore_params_with_empty_values=true, JSON null is ignored, while the text "null" still requests clearing. A POST Idempotency-Key must be one value without commas. Send text containing commas and cost lists through JSON, the query string or form fields. A URL may retain its own %2C encoding; other text is not percent-decoded. Optional Idempotency-Key replay applies to POST; PATCH and DELETE retain their existing behavior of ignoring that header. A confirmed change is then added to history; failure to write history does not undo the saved change. An unchanged PATCH writes no data, timestamp or history.

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 Sponsorships 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/sponsorships" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"id\":12345,\"name\":\"Welcome reception\"}"

Example response

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

Delete a Sponsorship #

Method
DELETE
Endpoint

Deletes an existing Sponsorship.

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 Sponsorship to delete. Use the id from Retrieve Sponsorships (GET /v1/events/sponsorships) or from the add response.

Good to know

These methods manage Sponsorships for an existing Event in your workspace. Supply the Event id and, for an existing Sponsorship, its id; a Sponsorship cannot be moved to another Event. Your current permissions and the Event's hidden or locked tab settings apply. A Sponsorship records what you plan to acquire and whether it has been acquired. Its costs, payment details and Cost Invoice / Receipt are separate: recording a cost does not attach an invoice or mark a payment complete. Deleting a Sponsorship removes its own costs, related-item links and attachment records together, then schedules only its files for physical cleanup. No contact or assignee email is sent. A POST Idempotency-Key must be one value without commas. Send text containing commas and cost lists through JSON, the query string or form fields. A URL may retain its own %2C encoding; other text is not percent-decoded. Optional Idempotency-Key replay applies to POST; PATCH and DELETE retain their existing behavior of ignoring that header. A confirmed change is then added to history; failure to write history does not undo the saved change. An unchanged PATCH writes no data, timestamp or history.

Hidden or locked tab

If the Event's Sponsorships 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/sponsorships?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

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

Download Sponsorship Invoice Attachment #

Method
GET
Endpoint

Downloads the Invoice Attachment for a Sponsorship.

Parameters
Name Type Required? Description Details
sponsorship_id Number Yes
The ID of the Sponsorship, from Retrieve Sponsorships (GET /v1/events/sponsorships) or its add response.

Good to know

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

Finding the file

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

For file metadata, retrieve the parent record with GET /v1/events/sponsorships/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 Sponsorships 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/sponsorships/invoice_attachment/download?sponsorship_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 Sponsorship Invoice Attachment #

Method
POST
Endpoint

Adds an Invoice Attachment to a Sponsorship.

Parameters
Name Type Required? Description Details
sponsorship_id Number Yes
The ID of the Sponsorship, from Retrieve Sponsorships (GET /v1/events/sponsorships) or its add response.
file File (multipart) Yes
The Invoice Attachment to upload.

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

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

Maximum files per request: 1.

View value format and limits

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

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

Good to know

Adds one Invoice Attachment to this Sponsorship. 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 Sponsorship's cost and payment details in the web app.

After the upload

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

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

Access and retries

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

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

Hidden or locked tab

If the Event's Sponsorships 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/sponsorships/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "sponsorship_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 Sponsorship Invoice Attachment #

Method
PATCH
Endpoint

Replaces a Sponsorship's Invoice Attachment.

Parameters
Name Type Required? Description Details
sponsorship_id Number Yes
The ID of the Sponsorship, from Retrieve Sponsorships (GET /v1/events/sponsorships) or its add response.
file File (multipart) Yes
The Invoice Attachment to upload.

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

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

Maximum files per request: 1.

View value format and limits

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

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

Good to know

Replaces this Sponsorship'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/sponsorships/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

If the Event's Sponsorships 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/sponsorships/invoice_attachment" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "sponsorship_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 Sponsorship Invoice Attachment #

Method
DELETE
Endpoint

Deletes a Sponsorship'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
sponsorship_id Number Yes
The ID of the Sponsorship, from Retrieve Sponsorships (GET /v1/events/sponsorships) or its add response.

Good to know

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

Hidden or locked tab

If the Event's Sponsorships 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/sponsorships/invoice_attachment?sponsorship_id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

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

Retrieve Sponsorship General File Attachments #

Method
GET
Endpoint

Retrieves the General File Attachments on a Sponsorship.

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

Reading the file list

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

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

Supporting files and invoices

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

Access

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

Hidden tab

If the Event's Sponsorships 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/sponsorships/attachments?sponsorship_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 Sponsorship General File Attachments #

Method
POST
Endpoint

Adds General File Attachments to a Sponsorship.

Parameters
Name Type Required? Description Details
sponsorship_id Number Yes
The ID of the Sponsorship, from Retrieve Sponsorships (GET /v1/events/sponsorships) 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 Sponsorship. Send each file as a multipart upload part named file.

After the upload

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

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

Choosing the right file method

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

Access

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

History and retries

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

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

Hidden or locked tab

If the Event's Sponsorships 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/sponsorships/attachments" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "sponsorship_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 Sponsorship General File Attachment #

Method
DELETE
Endpoint

Deletes a General File Attachment from a Sponsorship.

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 Sponsorship. 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 Sponsorships 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/sponsorships/attachments?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

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

Download a Sponsorship General File Attachment #

Method
GET
Endpoint

Downloads a General File Attachment from a Sponsorship.

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 Sponsorship. 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 Sponsorships 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/sponsorships/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.