Skip to main content

Unlock requests

POST 
/v2/request-queues/:queueId/requests/unlock

Unlocks requests in the queue that are currently locked by the client.

  • If the client is within an Actor run, it unlocks all requests locked by that specific run plus all requests locked by the same clientKey.
  • If the client is outside of an Actor run, it unlocks all requests locked using the same clientKey.

Request

Path Parameters

    queueId string required

    Queue ID or username~queue-name.


    Example: WkzbQMuFYuamGv3YF

Query Parameters

    clientKey string

    A unique identifier of the client accessing the request queue. It must be a string between 1 and 32 characters long


    Example: client-abc

Status 200

Number of requests that were unlocked

{
  "data": {
    "unlockedCount": 10
  }
}