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. This identifier is used to determine whether the queue was accessed by multiple clients. If clientKey is not provided, the system considers this API call to come from a new client. For details, see the hadMultipleClients field returned by the Get head operation.

Example: client-abc

Status 200

Number of requests that were unlocked

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

Schema

• data object required

  Result of unlocking requests in the request queue.

  • unlockedCount integer required

    Number of requests that were successfully unlocked.

    
    Example: 10

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 404

Not found - the requested resource was not found.

{
  "error": {
    "type": "record-not-found",
    "message": "Request Queue was not found"
  }
}

Schema

• error object

  • type string

    Possible values: [record-not-found]

  • message string
    Example: Request Queue was not found