v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB
Consumers

Add consumer to a specific consumer group

Add a consumer to a consumer group

post/v2/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}/consumer_groups

Path parameters

ConsumerIdstring required

ID of the Consumer to lookup

Request body

groupstring

Example request

{
  "group": "fedee695-2ae2-4e45-877a-776d9b2fc793"
}

Response

Consumer added to a specific group

Example response

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