Update Event

Update event with specified id.

patch
Update Event

https://environment.lvis.io/api/v2/events/:event_id
Request
Response
Request
Path Parameters
event_id
required
string
Event ID.
Headers
Authorization
required
string
Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb
Content-Type
required
string
application/vnd.api+json
Body Parameters
name
optional
string
Event name.
duration
optional
integer
Event duration in seconds.
start_at
optional
integer
Planned event start time (timestamp).
start_mode
optional
string
Start mode. Possible values: "manual", "clock".
repeat
optional
boolean
Repeat mode.
repeat_in
optional
integer
When to start repeat event after previous event end, in minutes.
settings
optional
array
List of fields of event settings. Each field is updated separately and if present its content is rewritten completely.
action
optional
string
Set to perform action on event. Possible actions: start - start manual event; stop - stop event.
Response
204: No Content
// no content

Example

Request
Response
cURL
Request
// PATCH /api/v2/events/2e9ddb8b-1ed0-4887-840a-9b37197a26e7
// Host: environment.lvis.io
// Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb
// Content-Type: application/vnd.api+json
{
"data": {
"type": "events",
"id": "126cd46d-02db-4369-84af-922cd0a8846b",
"attributes": {
"name": "Upcoming Event",
"duration": 1800,
"start_at": 1458927300,
"start_at_iso": "2016-03-25T17:35:00Z",
"start_mode": "clock",
"repeat": true,
"repeat_in": 60,
"settings": [
{
"key": "hold_prompt",
"values": {
"en": "On hold..."
}
},
{
"key": "number_of_users",
"values": {
"all" : 6
}
}
]
}
}
}
Response
// Status: 204 No Content
cURL
curl --request PATCH \
--url https://environment.lvis.io/api/v2/events/2e9ddb8b-1ed0-4887-840a-9b37197a26e7 \
--header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "events",
"id": "126cd46d-02db-4369-84af-922cd0a8846b",
"attributes": {
"name": "Upcoming Event",
"duration": 1800,
"start_at": 1458927300,
"start_at_iso": "2016-03-25T17:35:00Z",
"start_mode": "clock",
"repeat": true,
"repeat_in": 60,
"settings": [
{
"key": "hold_prompt",
"values": {
"en": "On hold..."
}
},
{
"key": "number_of_users",
"values": {
"all" : 6
}
}
]
}
}
}'

Actions on an event

An example how to start a manual event.

Request
Response
Request
// PATCH /api/v2/events/2e9ddb8b-1ed0-4887-840a-9b37197a26e7
// Host: environment.lvis.io
// Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb
// Content-Type: application/vnd.api+json
{
"data": {
"id": "2e9ddb8b-1ed0-4887-840a-9b37197a26e7",
"type": "events",
"attributes": {
"action": "start"
}
}
}
Response
// Status: 204 No Content

Validation error message that can't stop already finished event

Request
Response
Request
// PATCH /api/v2/events/7540ec1e-49b0-4283-9e37-e11624644fc1
// Host: environment.lvis.io
// Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb
// Content-Type: application/vnd.api+json
{
"data": {
"id": "7540ec1e-49b0-4283-9e37-e11624644fc1",
"type": "events",
"attributes": {
"action": "stop"
}
}
}
Response
// Status: 422 Unprocessable Entity
{
"errors": [
{
"source": {
"pointer": "/data/attributes/action"
},
"detail": "cannot stop event"
}
]
}