Read and Review Automation Anywhere Documentation

Automation 360

Close Contents


Open Contents

Add queue consumer API

  • Updated: 2020/09/09
    • Automation 360 v.x
    • Explore
    • RPA Workspace
    • API docs

Add queue consumer API

Add queue consumers from different roles defined in the Control Room.


You must have the following:

  • Create queues or AAE_Queue Admin permission
  • The endpoint URLs:
    • <your_control_room_url>/v3/wlm/queues/{queueId}/consumers
    • <your_control_room_url>/v3/wlm/queues/list


  1. Use the POST method and endpoint URL: <your_control_room_url>/v3/wlm/queues/{queueId}/consumers.
    Enter the queueId to which you want to add the consumers. This queueId is the same ID that was returned when you created the queue.
    Note: If you want to search or get a list of all the available queueId, use the endpoint URL <your_control_room_url>/v3/wlm/queues/list.

    List WLM queues

    For example, use queueId as 17.

    Enter one or more role id in the request body that you want to add as queue consumers. In this example, one role id as 21 is added as queue consumer.

    Request body:
        "id": 21
  2. Send the request.
    When the request is successful, the consumers are added to the queue.
    In this example, the consumer with role id as 21 is added to the queue.
    Response body:
        "id": 21,
        "createdBy": null,
        "createdOn": null,
        "updatedBy": null,
        "updatedOn": null,
        "tenantId": null,
        "version": 0,
        "tenantUuid": null,
        "description": null,
        "name": null,
        "accessRestriction": null,
        "permissions": [
        "countPrincipals": 0,
        "principals": [
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.

Next steps

Add Work Items to the queue

Send Feedback