Update request queue

PUT 
https://api.apify.com/v2/request-queues/:queueId

ClientsUpdates a request queue's name using a value specified by a JSON object passed in the PUT payload.

The response is the updated request queue object, as returned by the Get request queue API endpoint.

Request

Path Parameters

queueId stringrequired

Queue ID or username~queue-name.

application/json

Bodyrequired

namestringrequired

Responses

200

Response Headers

application/json

Schema

Schema

data objectrequired
idstringrequired
Example: WkzbQMuFYuamGv3YF
namestring
Example: some-name
userIdstringrequired
Example: wRsJZtadYvn4mBZmm
createdAtstringrequired
Example: 2019-12-12T07:34:14.202Z
modifiedAtstringrequired
The modifiedAt is updated whenever the queue is modified. Modifications include adding, updating, or removing requests, as well as locking or unlocking requests in the queue.
Example: 2030-12-13T08:36:13.202Z
accessedAtstringrequired
Example: 2019-12-14T08:36:13.202Z
totalRequestCountnumberrequired
Example: 870
handledRequestCountnumberrequired
Example: 100
pendingRequestCountnumberrequired
Example: 670
hadMultipleClientsbooleanrequired
Example: true
consoleUrlstringrequired
Example: https://api.apify.com/v2/request-queues/27TmTznX9YPeAYhkC

Example (auto)

{
  "data": {
    "id": "WkzbQMuFYuamGv3YF",
    "name": "some-name",
    "userId": "wRsJZtadYvn4mBZmm",
    "createdAt": "2019-12-12T07:34:14.202Z",
    "modifiedAt": "2019-12-13T08:36:13.202Z",
    "accessedAt": "2019-12-14T08:36:13.202Z",
    "totalRequestCount": 870,
    "handledRequestCount": 100,
    "pendingRequestCount": 670,
    "hadMultipleClients": true
  }
}

Example

{
  "data": {
    "id": "WkzbQMuFYuamGv3YF",
    "name": "some-name",
    "userId": "wRsJZtadYvn4mBZmm",
    "createdAt": "2019-12-12T07:34:14.202Z",
    "modifiedAt": "2019-12-13T08:36:13.202Z",
    "accessedAt": "2019-12-14T08:36:13.202Z",
    "totalRequestCount": 870,
    "handledRequestCount": 100,
    "pendingRequestCount": 670,
    "hadMultipleClients": true
  }
}

Authorization: http

name: httpBearertype: httpscheme: bearerdescription: API authentication token.

• CLI
• JavaScript
• Python
• PHP
• Java
• C
• C#
• Go
• Rust
• Node.js
• Ruby
• PowerShell
• Dart
• Objective-C
• OCaml
• R
• Swift
• Kotlin

• CURL

curl -L -X PUT 'https://api.apify.com/v2/request-queues/:queueId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "name": "new-request-queue-name"
}'

Request Collapse all

Base URL

https://api.apify.com

Auth

Security Scheme

httpBearerapiKey

Bearer Token

Parameters

queueId — pathrequired

Body required

• Example (from schema)
• Example

{
  "name": "new-request-queue-name"
}

ResponseClear

Click the Send API Request button above and see the response here!