Skip to main content

Update request

PUT 
/v2/request-queues/:queueId/requests/:requestId

Updates a request in a queue. Mark request as handled by setting request.handledAt = new Date(). If handledAt is set, the request will be removed from head of the queue (and unlocked, if applicable).

Request

Path Parameters

    queueId string required

    Queue ID or username~queue-name.


    Example: WkzbQMuFYuamGv3YF
    requestId string required

    Request ID.


    Example: xpsmkDlspokDSmklS

Query Parameters

    forefront string

    Determines if request should be added to the head of the queue or to the end. Default value is false (end of queue).


    Example: false
    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

Bodyrequired

  • id string required

    A unique identifier assigned to the request.


    Example: dnjkDMKLmdlkmlkmld
  • uniqueKey string required

    A unique key used for request de-duplication. Requests with the same unique key are considered identical.


    Example: GET|60d83e70|e3b0c442|https://apify.com/career
  • url string<uri> required

    The URL of the request.


    Example: https://apify.com/career
  • method string

    The HTTP method of the request.


    Example: GET
  • retryCount integer

    The number of times this request has been retried.


    Example: 0
  • loadedUrl string,null<uri> nullable

    The final URL that was loaded, after redirects (if any).


    Example: https://apify.com/jobs
  • payload object | null nullable

    The request payload, typically used with POST or PUT requests.

  • headers object | null nullable

    HTTP headers sent with the request.

  • userData object

    Custom user data attached to the request. Can contain arbitrary fields.

    • label string | null nullable

      Optional label for categorizing the request.


      Example: DETAIL
    • image string,null<uri> nullable

      Optional image URL associated with the request.


      Example: https://picserver1.eu
    • property name* any

      Custom user data attached to the request. Can contain arbitrary fields.

  • noRetry boolean | null nullable

    Indicates whether the request should not be retried if processing fails.


    Example: false
  • errorMessages string[] nullable

    Error messages recorded from failed processing attempts.

  • handledAt string,null<date-time> nullable

    The timestamp when the request was marked as handled, if applicable.


    Example: 2019-06-16T10:23:31.607Z

Status 200

Response Headers
    {
      "data": {
        "requestId": "YiKoxjkaS9gjGTqhF",
        "wasAlreadyPresent": true,
        "wasAlreadyHandled": false
      }
    }