---
title: "Add consumer to consumer group"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-3/versions/4a9ee72f-47ac-4061-9b08-3290c8d0ce93/operations/add-consumer-to-group"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-3/versions/4a9ee72f-47ac-4061-9b08-3290c8d0ce93.md

# Add consumer to consumer group

`POST` `/control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers`

Operation ID: `add-consumer-to-group`

Add a consumer to a consumer group

## Path parameters

- `ConsumerGroupId` (string, required) - The UUID or name of the consumer group
- `controlPlaneId` (string, uuid, required) - The UUID of your control plane. This variable is available in the Konnect manager.

## Request body

Content types: `application/json`

## Responses

- `201` - Consumer added to group

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Konnect Control Planes Configuration
  version: 3.14.0
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
paths:
  /control-planes/{controlPlaneId}/core-entities/consumer_groups/{ConsumerGroupId}/consumers:
    parameters:
      - $ref: "#/components/parameters/ConsumerGroupIdManageConsumers"
      - $ref: "#/components/parameters/controlPlaneId"
    post:
      operationId: add-consumer-to-group
      summary: Add consumer to consumer group
      description: Add a consumer to a consumer group
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                consumer:
                  type: string
                  example: cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b
      responses:
        "201":
          description: Consumer added to group
          content:
            application/json:
              schema:
                type: object
                properties:
                  consumer_group:
                    $ref: "#/components/schemas/ConsumerGroup"
                  consumers:
                    type: array
                    items:
                      $ref: "#/components/schemas/Consumer"
      tags:
        - Consumer Groups
security:
  - konnectAccessToken: []
  - personalAccessToken: []
components:
  parameters:
    ConsumerGroupIdManageConsumers:
      description: The UUID or name of the consumer group
      in: path
      name: ConsumerGroupId
      required: true
      schema:
        type: string
        example: cf4c7e60-11db-49dd-b300-7c7e5f0f7e6b
    controlPlaneId:
      name: controlPlaneId
      in: path
      required: true
      schema:
        type: string
        format: uuid
        example: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      description: The UUID of your control plane. This variable is available in the
        Konnect manager.
  schemas:
    ConsumerGroup:
      type: object
      properties:
        created_at:
          description: Unix epoch when the resource was created.
          type: integer
          nullable: true
        id:
          description: A string representing a UUID (universally unique identifier).
          type: string
          nullable: true
        name:
          description: The name of the consumer group.
          type: string
        tags:
          description: A set of strings representing tags.
          type: array
          items:
            description: A string representing a tag.
            type: string
          nullable: true
        updated_at:
          description: Unix epoch when the resource was last updated.
          type: integer
          nullable: true
      additionalProperties: false
      required:
        - name
    Consumer:
      description: The Consumer object represents a consumer - or a user - of a
        Service. You can either rely on Kong as the primary datastore, or you
        can map the consumer list with your database to keep consistency between
        Kong and your existing primary datastore.
      type: object
      properties:
        created_at:
          description: Unix epoch when the resource was created.
          type: integer
          nullable: true
        custom_id:
          description: Field for storing an existing unique ID for the Consumer - useful
            for mapping Kong with users in your existing database. You must send
            either this field or `username` with the request.
          type: string
          nullable: true
        id:
          description: A string representing a UUID (universally unique identifier).
          type: string
          nullable: true
        tags:
          description: An optional set of strings associated with the Consumer for
            grouping and filtering.
          type: array
          items:
            description: A string representing a tag.
            type: string
          nullable: true
        updated_at:
          description: Unix epoch when the resource was last updated.
          type: integer
          nullable: true
        username:
          description: The unique username of the Consumer. You must send either this
            field or `custom_id` with the request.
          type: string
          nullable: true
      example:
        custom_id: "4200"
        id: 8a388226-80e8-4027-a486-25e4f7db5d21
        tags:
          - silver-tier
        username: bob-the-builder
      additionalProperties: false
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      description: The Konnect access token is meant to be used by the Konnect
        dashboard and the decK CLI to authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      description: The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs. You can generate a Personal
        Access Token (PAT) from the personal access token page in the Konnect
        dashboard.
```
