APapify
Storage/Request queues/Requests

Update request in request queue

Changed on

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).

put/v2/request-queues/{queueId}/requests/{requestId}

Request

  • Base URL
    https://api.apify.com
  • Auth
    • HTTP bearer
    • or API key in query parameter token

Path parameters

queueIdstring required
Example:WkzbQMuFYuamGv3YF

Queue ID or username~queue-name.

requestIdstring required
Example:xpsmkDlspokDSmklS

Request ID.

Query parameters

forefrontstring
Example:false

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

clientKeystring
Example:client-abc

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 request queue head endpoint.

Request body

uniqueKeystring required

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

urlstring required

The URL of the request.

method'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH'
retryCountinteger

The number of times this request has been retried.

loadedUrlstring nullable

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

headersobject nullable

HTTP headers sent with the request.

userDataRequestUserData

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

noRetryboolean nullable

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

errorMessagesstring[] nullable

Error messages recorded from failed processing attempts.

handledAtstring date-time nullable

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

Example request

{
  "uniqueKey": "GET|60d83e70|e3b0c442|https://apify.com",
  "url": "https://apify.com",
  "method": "GET",
  "loadedUrl": "https://apify.com/jobs",
  "userData": {
    "label": "DETAIL",
    "customField": "custom-value"
  },
  "handledAt": "2019-06-16T10:23:31.607Z"
}

Response

Example response

{
  "data": {
    "requestId": "sbJ7klsdf7ujN9l"
  }
}

Changes

  • ec76185eb934Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 16b486b0397aRevision changes
    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new full-permissions-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new input-validation-timed-out enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new mcp-connector-actor-not-allowed enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new more-public-actors-require-verified-owner enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new readme-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new schemas-required enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new standby-deployment-invalid enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-account enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status

    • warning

      added the new too-many-public-actor-tasks-per-actor enum value to the / response property for the response status