Events

Update Event

Update an event's details.

Only provided fields are updated. The event must belong to your host.

A null means three different things depending on the field. externalRegistrationUrl treats it as "clear this field". title rejects it, because an event cannot be untitled. Every other field ignores it, so omit a field to leave it unchanged.

patch/v1/events/{event_slug}

Request

Base URL: https://developer.eventship.com (the document declares no server; this is the origin it was published from)
URL: https://developer.eventship.com/v1/events/{event_slug}
Auth: API key in header X-API-Key

Path parameters

event_slugstring required

Request body

titlestring nullable

descriptionstring nullable

startDatestring date-time nullable

endDatestring date-time nullable

timezonestring nullable

locationType'in_person' | 'virtual' | 'hybrid' | 'global'

How guests attend an event.

venuestring nullable

addressstring nullable

virtualLinkstring nullable

externalRegistrationUrlstring nullable

isPublicboolean nullable

showGuestListboolean nullable

imagestring nullable

introductionsEnabledboolean nullable

feedbackEnabledboolean nullable

notifyAttendeesboolean nullable

Response

Successful Response

successboolean

messagestring nullable

Changes

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