/events/{eventId}

Changed on

Changes the status of an Event. Note: only the status property may be patched.

If the specified Event does not exist, this endpoint will return an error with HTTP Status Code 404 Not Found.

If isActive is true but specified Event is not editable, this endpoint will return an error with HTTP Status Code 403 Forbidden.

If successful, the endpoint responds with HTTP Status Code 204 No Content and an empty response body.

patch/events/{eventId}

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/events/{eventId}
  • Auth
    HTTP basic

Path parameters

eventIdinteger required

Required; Unique identifier of the Event to be updated

recurrenceTypestring required

Optional; the Events in a recurring series to update. Must be one of ThisEvent, ThisAndFutureEvents, or AllEvents. Default, if not supplied, is ThisEvent.

Request body

eventIdinteger

Required; Unique identifier of the event to be updated

isActiveboolean

Required; If true, will restore a previously deleted Event; If false, the result will effectively be the same as if the Events Delete API method had been called.

Response

204

Changes