Update Pause Marker

Update pause marker with specified id.

patch
Update Pause Marker

https://environment.lvis.io/api/v2/pause_markers/:pause_marker_id
Request
Response
Request
Path Parameters
pause_marker_id
optional
string
Pause Marker ID.
Headers
Authorization
required
string
Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb
Content-Type
required
string
application/vnd.api+json
Body Parameters
auto_resume
optional
boolean
Auto-resume mode.
offset
optional
integer
Offset in seconds from event start.
duration
optional
integer
Duration in seconds.
state
optional
string
Pause marker state. One of: "upcoming", "active", "resumed".
Response
200: OK
{
"data": {
"id": "88164def-e8d0-42a1-a5e1-567da63a023a",
"type": "pause_markers",
"attributes": {
"auto_resume": true,
"duration": 120,
"offset": 550,
"state": "resumed"
},
"links": {
"self": "https://example.lvis.io/api/v2/pause_markers/88164def-e8d0-42a1-a5e1-567da63a023a"
}
}
}
400: Bad Request
{}

Only "active" -> "resumed" transition can be performed

Example

Request
Response
cURL
Request
// PATCH /api/v2/pause_markers/88164def-e8d0-42a1-a5e1-567da63a023a
// Host: environment.lvis.io
// Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb
// Content-Type: application/vnd.api+json
{
"data": {
"type": "pause_markers",
"id": "88164def-e8d0-42a1-a5e1-567da63a023a",
"attributes": {
"state": "resumed"
}
}
}
Response
// Status: 200 OK
{
"data": {
"id": "88164def-e8d0-42a1-a5e1-567da63a023a",
"type": "pause_markers",
"attributes": {
"auto_resume": true,
"duration": 120,
"offset": 550,
"state": "resumed"
},
"links": {
"self": "https://environment.lvis.io/api/v2/pause_markers/88164def-e8d0-42a1-a5e1-567da63a023a"
}
}
}
cURL
curl --request PATCH \
--url https://environment.lvis.io/api/v2/pause_markers/88164def-e8d0-42a1-a5e1-567da63a023a \
--header 'Authorization: Bearer JmsmU5gZb6xNVUgQGoKcQLvQjRhKAUSb' \
--header 'Content-Type: application/vnd.api+json' \
--data '{
"data": {
"type": "pause_markers",
"id": "88164def-e8d0-42a1-a5e1-567da63a023a",
"attributes": {
"state": "resumed"
}
}
}'