---
title: "Add a consumer to a group"
url: "https://nov18-dev.movespot.fyi/apis/konnect-runtime-groups-configuration-0/versions/af18902c-58f1-49d7-8ec2-9987b4e0d1bd/operations/post-runtimeGroupId-core-entities-consumer_groups-group_id-consumers"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-runtime-groups-configuration-0/versions/af18902c-58f1-49d7-8ec2-9987b4e0d1bd.md

# Add a consumer to a group

`POST` `/runtime-groups/{runtimeGroupId}/core-entities/consumer_groups/{group_id}/consumers`

Operation ID: `post-runtimeGroupId-core-entities-consumer_groups-group_id-consumers`

Add a consumer to a group

## Path parameters

- `runtimeGroupId` (string, required) - The ID of your runtime group. This variable is available in the Konnect manager
- `group_id` (string, required) - The UUID of the consumer group.

## Request body

Content types: `application/json`

## Responses

- `201` - The response body returns a consumer group and the associated consumers.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Runtime Groups Configuration
  version: 0.0.1
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:
  /runtime-groups/{runtimeGroupId}/core-entities/consumer_groups/{group_id}/consumers:
    parameters:
      - $ref: "#/components/parameters/runtimeGroupId"
      - $ref: "#/components/parameters/group_id"
    post:
      operationId: post-runtimeGroupId-core-entities-consumer_groups-group_id-consumers
      summary: Add a consumer to a group
      description: Add a consumer to a group
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                consumer:
                  description: The consumer ID for the consumer that you want to add to a group.
                  type: string
                  example: 288f2bfc-04e2-4ec3-b6f3-40408dff5417
      responses:
        "201":
          $ref: "#/components/responses/return-consumer-group"
      tags:
        - consumer-groups
security:
  - konnectAccessToken: []
  - personalAccessToken: []
components:
  parameters:
    runtimeGroupId:
      name: runtimeGroupId
      in: path
      required: true
      schema:
        type: string
        example: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      description: The ID of your runtime group. This variable is available in the
        Konnect manager
    group_id:
      name: group_id
      in: path
      required: true
      schema:
        type: string
        example: be4bcfca-b1df-4fac-83cc-5cf6774bf48e
      description: The UUID of the consumer group.
  responses:
    return-consumer-group:
      description: The response body returns a consumer group and the associated consumers.
      content:
        application/json:
          schema:
            type: object
            properties:
              consumer_group:
                type: object
                properties:
                  created_at:
                    description: Unix epoch when the resource was created.
                    type: integer
                    example: 1685551597
                  id:
                    type: string
                    format: uuid
                    example: 04fbeacf-a9f1-4a5d-ae4a-b0407445db3f
                  name:
                    description: The name of the consumer group
                    type: string
                    example: example
                  tags:
                    description: >
                      An optional set of strings associated with the Consumer
                      for grouping and filtering.
                    type: array
                    items:
                      type: string
                  updated_at:
                    description: The unix epoc representation of when the consumer group was
                      updated.
                    type: integer
                    example: 1685551597
              consumers:
                type: array
                items:
                  type: object
                  properties:
                    created_at:
                      description: Unix epoch when the resource was created.
                      type: integer
                      example: 1685551597
                    custom_id:
                      description: A custom ID for the resource
                      type: string
                      example: null
                      nullable: true
                    id:
                      description: The UUID of the consumer
                      type: string
                      example: 0cf03a37-8987-4c3b-a792-5b1db3eeedc6
                    tags:
                      type: array
                      items:
                        type: string
                    updated_at:
                      description: Unix epoch when the resource was updated.
                      type: integer
                      example: 1685551597
                    username:
                      description: the username for the consumer
                      type: string
                      example: example-username
            x-examples:
              Example 1:
                consumer_group:
                  created_at: 1685551597
                  id: 0cf03a37-8987-4c3b-a792-5b1db3eeedc6
                  name: test
                  tags:
                    - tag1
                  updated_at: 1685551597
                consumers:
                  - created_at: 1685023220
                    custom_id: Example-custom-id
                    id: 28384076-31e3-4c27-bd76-7edc57434382
                    tags:
                      - string
                    updated_at: 1685023220
                    username: ExampleUsername
  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.
```
