PUT /accounts/{account_id}/queues/{queue_id}

Updates a Queue. Note that this endpoint does not support partial updates. If successful, the Queue's configuration is overwritten with the supplied configuration.

Servers

Path parameters

Name Type Required Description
queue_id String Yes
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
consumers[] Array No
queue_name String No
created_on String No
producers[] Array No
producers_total_count Number No
consumers_total_count Number No
queue_id String No
settings Object No
settings.message_retention_period Number No

Number of seconds after which an unconsumed message will be delayed.

settings.delivery_delay Number No

Number of seconds to delay delivery of all messages to consumers.

settings.delivery_paused Boolean No

Indicates if message delivery to consumers is currently paused.

modified_on String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.