v11

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-065662751.8 MB
Consumer Groups

Add consumer to consumer group

Add a consumer to a consumer group

post/{workspace}/consumer_groups/{ConsumerGroupId}/consumers

Path parameters

workspacestring required
Example:team-payments

The name of the workspace

Request body

consumerstring

Example request

{
  "consumer": "cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b"
}

Response

Consumer added to group

Example response

{
  "consumers": [
    {
      "custom_id": "4200",
      "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
      "tags": [
        "silver-tier"
      ],
      "username": "bob-the-builder"
    }
  ]
}