REresearchanddesire
Lock Sessions

Lock or unlock

Changed on

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. When starting a partner's lock, the authenticated user is automatically assigned as a keyholder, including when keyholderIds is omitted or empty. OAuth partner starts require lkbx:keyholders. A definitive Chaster creation rejection cancels the local session before returning an error. If Chaster's outcome is uncertain, the response is 201 with the created lockSessionId and a warning; inspect the current session and do not retry creation blindly.

post/lkbx/session/current

Request

  • Base URL
    https://dashboard.researchanddesire.com/api/v1
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code/oauth/authorize
      Token URL/oauth/token
      Scopeslkbx:control

Request body

action'lock' | 'unlock' required

Action to perform

lockSettingsIdinteger

Lock template ID (for lock action). Fixed templates use duration in seconds. Only templates with isRandomDuration=true use minDuration/maxDuration; equal bounds select that exact duration.

keyholderIdsinteger[]

User IDs to assign as keyholders (for lock action). All IDs must be users you have access to. The initiating user is always included for partner locks. Assignments require lkbx:keyholders for OAuth clients.

targetUserIdinteger

User to lock/unlock (defaults to authenticated user). Must be a user you have access to.

isTestLockboolean

Override test lock setting from template. When true, the lock owner can unlock without a keyholder. Only used with lock action.

Response

Lock session completed

oktrue required

Changes

  • 4d10cc21b424Revision changes
    • info

      added the optional property / to the response with the status

  • 2411203b3c10Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security oauth2 was added to the API