EventsGiveaways

Giveaways

Retrieve a Single Giveaway by ID #

Method
GET
Endpoint
Sample Object

Retrieves a single Giveaway by its ID.

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

Good to know

The response includes item details, acquisition plans, distribution rules, costs and payment information.

What $include_record_revision covers

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

record_revision covers saved Giveaway details, payment fields, cost allocations, related-item links and Event binding. File Attachment and Invoice Attachment metadata/contents are not included.

Files and access

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

The Event's Giveaways tab must be visible. A locked tab can still be read. Inconsistent invoice information returns HTTP 409 instead of exposing another record's file.

Formatted text in the response

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

Open in ExhibitDay

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

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

Example response

{
  "id": 12345,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=6&riSub=0&riId=12345",
  "event_id": 23456,
  "event_name": "Sample Event",
  "name": "Welcome kits",
  "item_source_id": 1,
  "acquisition_status_id": 10,
  "acquire_by_date": null,
  "supplier_source": null,
  "contact_name": null,
  "contact_email": null,
  "contact_phone": null,
  "product_order_url": null,
  "acquired_date": null,
  "order_reference_number": null,
  "planned_quantity": null,
  "entry_method_id": null,
  "entry_rules_url": null,
  "selection_distribution_method_id": null,
  "number_of_winners_recipients": null,
  "must_be_present_to_win": null,
  "payment_status_id": 0,
  "payment_due_date": null,
  "next_payment_due_date": null,
  "payment_notes": null,
  "invoice_attachment": {
    "id": 582345,
    "filename": "giveaway-invoice.pdf",
    "attachment_created_timestamp": "2027-01-30T12:00:00Z"
  },
  "notes": "",
  "item_package_details": "",
  "branding_customization": "",
  "preparation_requirements": "",
  "handling_storage_requirements": "",
  "intended_use_recipients": "",
  "eligibility_restrictions": "",
  "fulfillment_instructions": "",
  "results_follow_up": "",
  "item_source": "From a Supplier / Vendor",
  "acquisition_status": "Need to Acquire",
  "entry_method": "Not Specified",
  "selection_distribution_method": "Not Specified",
  "payment_status": {
    "id": 0,
    "name": "N/A"
  },
  "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 Giveaways #

Method
GET
Endpoint

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

Good to know

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

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.

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 Giveaways tab

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

Example response

{
  "list_type": "giveaway",
  "list_data": [
    {
      "id": 12345,
      "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=6&riSub=0&riId=12345",
      "event_id": 23456,
      "event_name": "Sample Event",
      "name": "Welcome kits",
      "item_source_id": 1,
      "acquisition_status_id": 10,
      "acquire_by_date": null,
      "supplier_source": null,
      "contact_name": null,
      "contact_email": null,
      "contact_phone": null,
      "product_order_url": null,
      "acquired_date": null,
      "order_reference_number": null,
      "planned_quantity": null,
      "entry_method_id": null,
      "entry_rules_url": null,
      "selection_distribution_method_id": null,
      "number_of_winners_recipients": null,
      "must_be_present_to_win": null,
      "payment_status_id": 0,
      "payment_due_date": null,
      "next_payment_due_date": null,
      "payment_notes": null,
      "invoice_attachment": {
        "id": 582345,
        "filename": "giveaway-invoice.pdf",
        "attachment_created_timestamp": "2027-01-30T12:00:00Z"
      },
      "notes": "",
      "item_package_details": "",
      "branding_customization": "",
      "preparation_requirements": "",
      "handling_storage_requirements": "",
      "intended_use_recipients": "",
      "eligibility_restrictions": "",
      "fulfillment_instructions": "",
      "results_follow_up": "",
      "item_source": "From a Supplier / Vendor",
      "acquisition_status": "Need to Acquire",
      "entry_method": "Not Specified",
      "selection_distribution_method": "Not Specified",
      "payment_status": {
        "id": 0,
        "name": "N/A"
      },
      "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 Giveaway #

Method
POST
Endpoint

Adds a Giveaway to an Event.

Parameters
Name Type Required? Description Details
event_id Number Yes
The ID of the Event.
The Giveaway will be added to this Event.
name String Yes
A name for the Giveaway, such as Welcome kits.
Up to 200 characters, excluding surrounding spaces. Required; enter a nonblank name.
item_source_id Number No
Where the giveaway items will come from. Omit to use From a Supplier / Vendor. See Choosing a source below for supplier fields and linked inventory.
Allowed values: 1 (From a Supplier / Vendor) | 2 (Existing Inventory) | 3 (From a Supplier + Existing Inventory)
acquisition_status_id Number No
Whether the supplier items have been acquired. This applies only when Source includes a supplier. Omit for Need to Acquire. Null resets supplier items to Need to Acquire. Existing Inventory clears this status.
Allowed values: 10 (Need to Acquire) | 20 (Already Acquired)
acquire_by_date String No
The deadline to purchase or secure the supplier items.
Use a calendar date in YYYY-MM-DD format. Omit for no value. Applies when the Source includes a supplier.
supplier_source String No
The supplier or source of purchased items.
Up to 200 characters, excluding surrounding spaces. Omit for no value. Applies when the Source includes a supplier.
contact_name String No
The supplier contact's name.
Up to 200 characters, excluding surrounding spaces. Omit for no value. Applies when the Source includes a supplier.
contact_email String No
The supplier contact's email address.
Up to 200 characters, excluding surrounding spaces. Omit for no value. Applies when the Source includes a supplier.
contact_phone String No
The supplier contact's phone number.
Up to 200 characters, excluding surrounding spaces. Omit for no value. Applies when the Source includes a supplier.
product_order_url String No
A link to order the items or manage the purchase.
Up to 2,000 characters, excluding surrounding spaces. Omit for no value. Applies when the Source includes a supplier.
acquired_date String No
The date the supplier purchase or arrangement was confirmed.
Use a calendar date in YYYY-MM-DD format. Omit for no value. Applies only to supplier items marked Already Acquired. Choosing another acquisition status clears this date and the order/reference number.
order_reference_number String No
The supplier's order or reference number.
Up to 200 characters, excluding surrounding spaces. Omit for no value. Applies only to supplier items marked Already Acquired.
planned_quantity String No
How many items or packages you plan to use.
Up to 150 characters, excluding surrounding spaces. Omit for no value. This is text, for example 200 pens, 50-75 kits, or One per team.
entry_method_id Number No
What someone needs to do to enter or qualify. Omit or send null for Not Specified.
Allowed values: 9 (No Entry Required) | 1 (Badge Scan) | 2 (Business Card) | 3 (Form Submission) | 4 (Purchase) | 5 (Event / Session Attendance) | 6 (Game / Contest Participation) | 8 (Social Media / Online Engagement) | 7 (Other)
entry_rules_url String No
A link to the giveaway's entry rules.
Up to 2,000 characters, excluding surrounding spaces. Omit for no value.
selection_distribution_method_id Number No
How winners are chosen or the items are distributed. Omit or send null for Not Specified. See Distribution rules below.
Allowed values: 1 (Random Drawing) | 2 (Judged Contest) | 5 (Instant Win / Game Outcome) | 3 (First Come / While Supplies Last) | 6 (All Eligible Participants) | 4 (Other)
number_of_winners_recipients String No
How many people will win or receive the giveaway.
Up to 150 characters, excluding surrounding spaces. Omit for no value. This is text rather than a numeric-only count.
must_be_present_to_win Boolean No
Whether a winner must be present when selected.
Use true or false. Send null to clear the answer. False remains an explicit No. Applies to Random Drawing (1), Judged Contest (2), Other (4), and Instant Win / Game Outcome (5). Choosing another method clears the answer.
payment_status_id Number No
The Giveaway's payment status. Omit for N/A. Choosing a status other than Partially Paid clears the next partial payment due date.
Allowed values: 0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet)
payment_due_date String No
The Giveaway payment due date.
Use a calendar date in YYYY-MM-DD format. Omit for no value.
next_payment_due_date Date No
The next partial payment due date.
Use a calendar date in YYYY-MM-DD format. Applies only to Partially Paid (2). Supplying it with another payment status clears the date; choosing another status also clears it. Omit for no value.
payment_notes String No
Notes about the giveaway payment.
Up to 200 characters, excluding surrounding spaces. Omit for no value.
notes String No
General notes about this Giveaway.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
item_package_details String No
What is included in each item or package.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
branding_customization String No
How the items should be branded or customized.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
preparation_requirements String No
What needs to be prepared before the giveaway.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
handling_storage_requirements String No
How the items should be handled or stored.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
intended_use_recipients String No
Who the giveaway is intended for and how they will use it.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
eligibility_restrictions String No
Who is eligible to enter or receive the giveaway.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
fulfillment_instructions String No
How the items should be delivered or handed out.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
results_follow_up String No
Results to record and follow-up work after the giveaway.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit for no value. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
cost Number or cost object No
The full cost, as a number or an object with amount and/or cost_center_breakdown. Record Costs and Split Them Across Cost Centers.
View value format and limits

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

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

Good to know

Adds a Giveaway to an Event. Name the items or package, choose where they will come from, and record how people can receive them.

Choosing a source

Use From a Supplier / Vendor for items obtained for this Event, Existing Inventory for items represented by existing asset reservations, or From a Supplier + Existing Inventory for both.

Existing Inventory clears supplier/acquisition details when that group is saved. Supplier items start at Need to Acquire; Already Acquired enables the date acquired and order/reference number. Choosing another acquisition status clears those two fields. Costs, payment fields, notes, files and inventory links remain independent.

To use inventory, link existing asset reservations from this same Event with POST /v1/related_items; that call refuses inventory links while the Source is Supplier-only. Changing Source does not create a reservation or book stock. If linked inventory remains visible to this request, choosing Supplier-only is refused; use Source 2 or 3.

Distribution rules

Entry Method says how someone enters or qualifies. Selection / Distribution Method says how winners are chosen or items are handed out. No Entry Required is a valid choice for items anyone can take.

Must Be Present to Win applies only when a winner is selected: Random Drawing, Judged Contest, Instant Win / Game Outcome or Other. First Come / While Supplies Last, All Eligible Participants or an unspecified method clears that answer. Planned Quantity and Number of Winners / Recipients accept text, including units or a range.

After the add

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

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

Access

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

Sending values

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

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 Giveaways 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/giveaways/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/giveaways" -H "Authorization: Bearer YOUR_API_KEY" -H "Content-Type: application/json" -d "{\"event_id\":23456,\"name\":\"Welcome kits\"}"

Example response

{
  "id": 12345,
  "exhibitday_url": "https://www.exhibitday.com/Workspace/Event/98765?eid=23456&riType=6&riSub=0&riId=12345",
  "event_id": 23456,
  "event_name": "Sample Event",
  "name": "Welcome kits",
  "item_source_id": 1,
  "acquisition_status_id": 10,
  "acquire_by_date": null,
  "supplier_source": null,
  "contact_name": null,
  "contact_email": null,
  "contact_phone": null,
  "product_order_url": null,
  "acquired_date": null,
  "order_reference_number": null,
  "planned_quantity": null,
  "entry_method_id": null,
  "entry_rules_url": null,
  "selection_distribution_method_id": null,
  "number_of_winners_recipients": null,
  "must_be_present_to_win": null,
  "payment_status_id": 0,
  "payment_due_date": null,
  "next_payment_due_date": null,
  "payment_notes": null,
  "invoice_attachment": null,
  "notes": "",
  "item_package_details": "",
  "branding_customization": "",
  "preparation_requirements": "",
  "handling_storage_requirements": "",
  "intended_use_recipients": "",
  "eligibility_restrictions": "",
  "fulfillment_instructions": "",
  "results_follow_up": "",
  "item_source": "From a Supplier / Vendor",
  "acquisition_status": "Need to Acquire",
  "entry_method": "Not Specified",
  "selection_distribution_method": "Not Specified",
  "payment_status": {
    "id": 0,
    "name": "N/A"
  },
  "cost": {
    "amount": 0.00,
    "cost_center_breakdown": []
  }
}
Note: IDs are illustrative; use IDs from your workspace.

Update a Giveaway #

Method
PATCH
Endpoint

Updates an existing Giveaway.

Parameters
Name Type Required? Description Details
id Number Yes
The ID of the Giveaway.
Use its id from the list, single-record read or add response.
name String No
A name for the Giveaway, such as Welcome kits.
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null cannot clear it. Renaming also updates an existing valid Invoice Attachment's label.
item_source_id Number No
Where the giveaway items will come from. Omit or leave blank to keep it; null cannot clear it. Older unspecified Sources can remain unchanged. See Choosing a source below for supplier fields and linked inventory.
Allowed values: 1 (From a Supplier / Vendor) | 2 (Existing Inventory) | 3 (From a Supplier + Existing Inventory)
acquisition_status_id Number No
Whether the supplier items have been acquired. This applies only when Source includes a supplier. Omit or leave blank to keep it unless its source group changes. Null resets supplier items to Need to Acquire. Existing Inventory clears this status.
Allowed values: 10 (Need to Acquire) | 20 (Already Acquired)
acquire_by_date String No
The deadline to purchase or secure the supplier items.
Use a calendar date in YYYY-MM-DD format. Omit or leave blank to keep it; null clears it. Applies when the Source includes a supplier.
supplier_source String No
The supplier or source of purchased items.
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies when the Source includes a supplier.
contact_name String No
The supplier contact's name.
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies when the Source includes a supplier.
contact_email String No
The supplier contact's email address.
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies when the Source includes a supplier.
contact_phone String No
The supplier contact's phone number.
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies when the Source includes a supplier.
product_order_url String No
A link to order the items or manage the purchase.
Up to 2,000 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies when the Source includes a supplier.
acquired_date String No
The date the supplier purchase or arrangement was confirmed.
Use a calendar date in YYYY-MM-DD format. Omit or leave blank to keep it; null clears it. Applies only to supplier items marked Already Acquired. Choosing another acquisition status clears this date and the order/reference number.
order_reference_number String No
The supplier's order or reference number.
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. Applies only to supplier items marked Already Acquired.
planned_quantity String No
How many items or packages you plan to use.
Up to 150 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. This is text, for example 200 pens, 50-75 kits, or One per team.
entry_method_id Number No
What someone needs to do to enter or qualify. Null means Not Specified. Omit or leave blank to keep it.
Allowed values: 9 (No Entry Required) | 1 (Badge Scan) | 2 (Business Card) | 3 (Form Submission) | 4 (Purchase) | 5 (Event / Session Attendance) | 6 (Game / Contest Participation) | 8 (Social Media / Online Engagement) | 7 (Other)
entry_rules_url String No
A link to the giveaway's entry rules.
Up to 2,000 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
selection_distribution_method_id Number No
How winners are chosen or the items are distributed. Null means Not Specified. Omit or leave blank to keep it. See Distribution rules below.
Allowed values: 1 (Random Drawing) | 2 (Judged Contest) | 5 (Instant Win / Game Outcome) | 3 (First Come / While Supplies Last) | 6 (All Eligible Participants) | 4 (Other)
number_of_winners_recipients String No
How many people will win or receive the giveaway.
Up to 150 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it. This is text rather than a numeric-only count.
must_be_present_to_win Boolean No
Whether a winner must be present when selected.
Use true or false. Send null to clear the answer. False remains an explicit No. Applies to Random Drawing (1), Judged Contest (2), Other (4), and Instant Win / Game Outcome (5). Choosing another method clears the answer. Omit or leave blank to keep it.
payment_status_id Number No
The Giveaway's payment status. Omit or leave blank to keep it; null resets it to N/A. Choosing a status other than Partially Paid clears the next partial payment due date.
Allowed values: 0 (N/A) | 1 (Paid in Full) | 2 (Partially Paid) | 3 (Not Paid Yet)
payment_due_date String No
The Giveaway payment due date.
Use a calendar date in YYYY-MM-DD format. Omit or leave blank to keep it; null clears it.
next_payment_due_date Date No
The next partial payment due date.
Use a calendar date in YYYY-MM-DD format. Applies only to Partially Paid (2). Supplying it with another payment status clears the date; choosing another status also clears it. Omit or leave blank to keep it; null clears it.
payment_notes String No
Notes about the giveaway payment.
Up to 200 characters, excluding surrounding spaces. Omit or leave blank to keep it; null clears it.
notes String No
General notes about this Giveaway.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
item_package_details String No
What is included in each item or package.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
branding_customization String No
How the items should be branded or customized.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
preparation_requirements String No
What needs to be prepared before the giveaway.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
handling_storage_requirements String No
How the items should be handled or stored.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
intended_use_recipients String No
Who the giveaway is intended for and how they will use it.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
eligibility_restrictions String No
Who is eligible to enter or receive the giveaway.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
fulfillment_instructions String No
How the items should be delivered or handed out.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
results_follow_up String No
Results to record and follow-up work after the giveaway.
Send plain text; line breaks are kept. If you send HTML, only its text is saved. Both the saved text and the ExhibitDay editor's character count must fit within 30,000 characters; line breaks and characters such as & and < take extra space when saved. Omit or leave blank to keep it; null clears it. Existing over-limit content can stay unchanged or be shortened, but neither count may grow. HTML tags are removed, characters are HTML-encoded and line breaks become <br/>. Responses therefore contain HTML.
cost Number or cost object No
The full cost, as a number or an object with amount and/or cost_center_breakdown. Record Costs and Split Them Across Cost Centers.
View value format and limits

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

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

Good to know

Updates a Giveaway's item details, acquisition plans, distribution rules or payment information. Send only the fields you want to change.

Choosing a source

Use From a Supplier / Vendor for items obtained for this Event, Existing Inventory for items represented by existing asset reservations, or From a Supplier + Existing Inventory for both.

Existing Inventory clears supplier/acquisition details when that group is saved. Supplier items start at Need to Acquire; Already Acquired enables the date acquired and order/reference number. Choosing another acquisition status clears those two fields. Costs, payment fields, notes, files and inventory links remain independent.

To use inventory, link existing asset reservations from this same Event with POST /v1/related_items; that call refuses inventory links while the Source is Supplier-only. Changing Source does not create a reservation or book stock. If linked inventory remains visible to this request, choosing Supplier-only is refused; use Source 2 or 3.

Distribution rules

Entry Method says how someone enters or qualifies. Selection / Distribution Method says how winners are chosen or items are handed out. No Entry Required is a valid choice for items anyone can take.

Must Be Present to Win applies only when a winner is selected: Random Drawing, Judged Contest, Instant Win / Game Outcome or Other. First Come / While Supplies Last, All Eligible Participants or an unspecified method clears that answer. Planned Quantity and Number of Winners / Recipients accept text, including units or a range.

Choosing what to change

Omitted or blank fields keep their values. Null clears or resets supported fields; name and item_source_id cannot be cleared. Clearing payment_status_id resets it to N/A. With ignore-empty true, actual JSON null is omitted instead.

A controlling field can clear dependent details as described above. An unrelated update preserves omitted older details. An unchanged request saves no business data or history and keeps its revision. File Attachments and the Invoice Attachment are managed separately.

Using expected_revision

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

After the update

A real change is recorded in Event history. Renaming also updates an existing valid Invoice Attachment's label without replacing its contents.

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

Access

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

Sending values

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

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

Example response

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

Delete a Giveaway #

Method
DELETE
Endpoint

Deletes an existing Giveaway.

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 Giveaway.
Use its id from the list, single-record read or add response.

Good to know

Deletes a Giveaway and its saved costs, related-item links, File Attachments and Invoice Attachment. Linked asset reservations, Tasks and other records remain in place.

After the deletion

The Giveaway, its costs, related-item links and attachment records are removed together. Only its files are scheduled for physical cleanup after the save. Linked asset reservations, Tasks and other records remain.

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

Access

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

Hidden or locked tab

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

Example response

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

Download Giveaway Invoice Attachment #

Method
GET
Endpoint

Downloads the Invoice Attachment for a Giveaway.

Parameters
Name Type Required? Description Details
giveaway_id Number Yes
The ID of the Giveaway, from Retrieve Giveaways (GET /v1/events/giveaways) or its add response.

Good to know

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

Finding the file

In the web app, this is the invoice control beside the Giveaway'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/giveaways/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 Giveaways 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/giveaways/invoice_attachment/download?giveaway_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 Giveaway Invoice Attachment #

Method
POST
Endpoint

Adds an Invoice Attachment to a Giveaway.

Parameters
Name Type Required? Description Details
giveaway_id Number Yes
The ID of the Giveaway, from Retrieve Giveaways (GET /v1/events/giveaways) 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 Giveaway. 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 Giveaway'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/giveaways/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

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

Method
PATCH
Endpoint

Replaces a Giveaway's Invoice Attachment.

Parameters
Name Type Required? Description Details
giveaway_id Number Yes
The ID of the Giveaway, from Retrieve Giveaways (GET /v1/events/giveaways) 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 Giveaway'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/giveaways/info and inspect invoice_attachment before deciding whether to retry.

Hidden or locked tab

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

Method
DELETE
Endpoint

Deletes a Giveaway'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
giveaway_id Number Yes
The ID of the Giveaway, from Retrieve Giveaways (GET /v1/events/giveaways) or its add response.

Good to know

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

Hidden or locked tab

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

Example response

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

Retrieve Giveaway General File Attachments #

Method
GET
Endpoint

Retrieves the General File Attachments on a Giveaway.

Parameters
Name Type Required? Description Details
giveaway_id Number Yes
The ID of the Giveaway, from Retrieve Giveaways (GET /v1/events/giveaways) 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 Giveaway. 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 Giveaways 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/giveaways/attachments?giveaway_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 Giveaway General File Attachments #

Method
POST
Endpoint

Adds General File Attachments to a Giveaway.

Parameters
Name Type Required? Description Details
giveaway_id Number Yes
The ID of the Giveaway, from Retrieve Giveaways (GET /v1/events/giveaways) 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 Giveaway. 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 Giveaways 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/giveaways/attachments" -H "Authorization: Bearer YOUR_API_KEY" --output response-body.tmp --write-out "%{http_code}" --form-string "giveaway_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 Giveaway General File Attachment #

Method
DELETE
Endpoint

Deletes a General File Attachment from a Giveaway.

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 Giveaway. 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 Giveaways 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/giveaways/attachments?id=12345" -H "Authorization: Bearer YOUR_API_KEY"

Example response

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

Download a Giveaway General File Attachment #

Method
GET
Endpoint

Downloads a General File Attachment from a Giveaway.

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 Giveaway. 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 Giveaways 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/giveaways/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.