Events

Add an Event

If successful, the response will contain an object representing the newly added event.

Documentation: https://api.exhibitday.com/Help/V1?epf=1#post-v1-events

post/v1/events

Request

  • Base URL: https://api.exhibitday.com
  • URL: https://api.exhibitday.com/v1/events
  • Auth: one of:
    • API key in header api_key
    • API key in query parameter api_key

Headers

Idempotency-Keystring

A unique value (e.g. a UUID) for this create. If you retry with the same key within 24 hours, you get the first response again instead of a second record. A 409 idempotency_key_in_use means the first request is still running (retry shortly with the same key); 409 idempotency_key_indeterminate means it never finished (check whether the record exists, then use a new key). The same key with a different request is refused with 400 idempotency_key_reused. A key is 1 to 255 visible ASCII characters, without spaces.

Request body

namestring required

The name of the event.

start_datestring date required

Event Start Date (format: YYYY-MM-DD). If the start date is after the end date, the API swaps the dates before creating the event.

end_datestring date required

Event End Date (format: YYYY-MM-DD). If the start date is after the end date, the API swaps the dates before creating the event.

format_idinteger

Integer representing the format_id for the event (1 for In-Person, 2 for Virtual, 3 for Hybrid)

participation_type_idinteger

Integer representing the participation type of the event (1: Committed, 2: Considering, 3: Not Going). Note: you can use the following endpoint to retrieve a list of available participation_type_id's: /v1/references/event_participation_types

integration_metadata_field_1string

This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.

integration_metadata_field_2string

This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.

integration_metadata_field_3string

This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.

integration_metadata_field_4string

This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.

integration_metadata_field_5string

This is an integration-specific text field only accessible via the ExhibitDay API. This field can be used to store whatever metadata or information you'd like about a particular event. For example, you can use it to store the "external id" of the event (from another system you're integrating with). Or, you can use it to store the last sync timestamp. Note: when you retrieve a list of events (using the /v1/events endpoint), you can filter down the results by the value of this field.

Response

OK

idinteger
exhibitday_urlstring nullable
namestring nullable
start_datestring nullable
end_datestring nullable
participation_type_idinteger
participation_typestring nullable
format_idinteger
formatstring nullable
star_ratinginteger
tagsstring[] nullable
website_urlstring nullable
venue_namestring nullable
venue_addressstring nullable
venue_location_display_namestring nullable
venue_address_latitudestring nullable
venue_address_longitudestring nullable
booth_sizestring nullable
booth_numberstring nullable
booth_reservation_status_idinteger
booth_reservation_statusstring nullable
booth_reserve_by_datestring nullable
booth_date_reservedstring nullable
budget_booth_reservationnumber
budget_booth_servicesnumber
budget_attendee_registrationsnumber
budget_travelnumber
budget_giveawaysnumber
budget_shipmentsnumber
budget_event_activitiesnumber
budget_misc_expensesnumber
budget_sponsorshipsnumber
total_sum_event_budgetsnumber
cost_booth_reservationnumber
cost_booth_servicesnumber
cost_attendee_registrationsnumber
cost_travel_reservationsnumber
cost_giveawaysnumber
cost_shipmentsnumber
cost_event_activitiesnumber
cost_misc_expensesnumber
cost_sponsorshipsnumber
total_sum_event_costsnumber
event_notesstring nullable
booth_notesstring nullable
budget_notesstring nullable
roi_notesstring nullable
roi_num_leadsinteger
roi_num_impressions_boothinteger
roi_num_impressions_sponsorshipsinteger
roi_num_impressions_mediainteger
roi_num_meetings_existing_customersinteger
roi_num_meetings_new_customersinteger
roi_amount_actual_salesnumber
roi_amount_potential_salesnumber
event_created_timestampstring date-time nullable
event_last_update_timestampstring date-time
integration_metadata_field_1string nullable
integration_metadata_field_2string nullable
integration_metadata_field_3string nullable
integration_metadata_field_4string nullable
integration_metadata_field_5string nullable

Changes

No recorded changes to this operation across all 1 revision of this API.