POST /events/by-slug/{slug}

Request

  • Base URL
    https://docs.theeventscalendar.com/index.php?rest_route=/tribe/events/v1
  • Auth
    none declared

Path parameters

slugstring required

the event post name

Request body application/x-www-form-urlencoded

authorinteger

The event author ID

datestring

The event publication date

date_utcstring

The event publication date (UTC time zone)

titlestring

The event title

descriptionstring

The event description

slugstring

The event slug

excerptstring

The event excerpt

statusstring

The event post status

timezonestring

The event time zone

all_dayboolean

Whether the event lasts the whole day or not

start_datestring

The event start date and time

end_datestring

The event end date and time

imagestring

The event featured image ID or URL

coststring

The event cost

websitestring

The event website URL

show_mapboolean

Whether the event should show a map or not

show_map_linkboolean

Whether the event should show a map link or not

hide_from_listingsboolean

Whether events should be hidden in the calendar view or not

stickyboolean

Whether the event should be sticky in the calendar view or not

featuredboolean

Whether the event should be featured on the site or not

categoriesinteger[]

The event category ID or name

tagsinteger[]

The event tag ID or name

venueinteger[]

The event venue IDs or data

organizerinteger[]

The event organizer IDs or data

Response

Returns the data of the updated event

idinteger

The event WordPress post ID

global_idstring

The event ID used to globally identify in Event Aggregator

global_id_lineagestring[]

An Array containing the lineage of where this event comes from, this should not change after the event is created.

authorinteger

The event author WordPress post ID

datestring

The event creation date in the site time zone

date_utcstring

The event creation date in UTC time

modifiedstring

The event last modification date in the site time zone

modified_utcstring

The event last modification date in UTC time

statusstring

The event status

urlstring

The URL to the event page

rest_urlstring

The TEC REST API link to fetch this event

titlestring

The event name

descriptionstring

The event long description

excerptstring

The event short description

slugstring

The event slug

all_dayboolean

Whether or not this event is an all day Event

start_datestring

The event start date in the event or site time zone

end_datestring

The event end date in the event or site time zone

utc_start_datestring

The event start date in UTC time

utc_end_datestring

The event end date in UTC time

timezonestring

The event time zone string

timezone_abbrstring

The abbreviated event time zone string

coststring

The event cost including the currency symbol

websitestring

The event website URL

show_mapboolean

Whether the map should be shown for the event or not

show_map_linkboolean

Whether the map link should be shown for the event or not

hide_from_listingsboolean

Whether an event should be hidden from the calendar view or not

stickyboolean

Whether an event is sticky in the calendar view or not

featuredboolean

Whether the event is featured in the calendar or not

Changes

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