booth_lock.md

booth/lock Endpoint

The booth/lock endpoint enables you to decide whether the waitlist should be locked or not.

Note: You need to have sufficient permissions in the room to access this resource.

Endpoint

booth/lock

Method

PUT

Parameters

isLocked: Should the waitlist be locked?

removeAllDJs: Should all DJs be removed from the waitlist?

{
    "isLocked": false,
    "removeAllDJs": false
}

Possible error messages

Insufficient permissions

{
    "data": [
        "You are not authorized to access this resource."
    ],
    "status": "notAuthorized",
}

isLocked or removeAllDJs is missing

{
    "data": [
        "xxxxx is required"
    ],
    "status": "requestError",
}

Data returned

{
    'data': [],
    'meta': {},
    'status': 'ok',
    'time': 'xx.xxxxxxxxxxx'
}