Lock or unlock
Start a new lock session or complete (unlock) the active session. User IDs (target and keyholders) are validated against your accessible users before the action is performed.
Authorizations
AuthorizationstringheaderrequiredAPI tokens can be created in the Dashboard settings. Requires an Ultra subscription.
Body
actionenumrequiredAction to perform
Allowed values: lockunlock
lockSettingsIdintegerLock template ID (for lock action)
keyholderIdsinteger[]User IDs to assign as keyholders (for lock action). All IDs must be users you have access to.
targetUserIdintegerUser to lock/unlock (defaults to authenticated user). Must be a user you have access to.
isTestLockbooleanOverride test lock setting from template. When true, the lock owner can unlock without a keyholder. Only used with lock action.
Response
200application/jsonLock session completed
Lock session completed
okbooleanrequireddataobjectrequiredShow child attributes
messagestringrequired201application/jsonLock session created
Lock session created
okbooleanrequireddataobjectrequiredShow child attributes
lockSessionIdintegerrequiredID of the created lock session
400application/jsonInvalid request or operation failed
Invalid request or operation failed
okbooleanrequirederrorstringrequired401application/jsonAuthentication required or token invalid
Authentication required or token invalid
okbooleanrequirederrorstringrequired403application/jsonInaccessible user ID
Inaccessible user ID
okbooleanrequirederrorstringrequired404application/jsonUser not found
User not found
okbooleanrequirederrorstringrequired