API Reference

/events/{eventId}

patch
https://api.securevan.com/v4/events/

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
Defaults to 1631

Required; Unique identifier of the Event to be updated

string
required
Defaults to AllEvents

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

Body Params
int32
Defaults to 1631

Required; Unique identifier of the event to be updated

boolean
Defaults to true

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.

Responses

Updated about 1 year ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago