8kitInstall

Summary

Release a lock by its unique identifier.

Inputs

• key (required) — Unique identifier for the lock. Must contain only letters, numbers, hyphens, and underscores. Maximum 255 characters.
• getLockData — Whether to include lock details in the output.
• lockDataFieldName — The field name where lock data will be stored in the output JSON. Only applicable when getLockData is true.

Output shape

object

Returns the lock release status. When getLockData is true, lock data is stored in the field specified by lockDataFieldName in the output JSON.

Examples

Example 1: Release a lock with identifier 'my-lock-123' and include lock data.

Set key to 'my-lock-123', getLockData to true, and lockDataFieldName to 'myLock'.