---
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-consumers-consumer_id-consumer_groups"
---

> 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/consumers/{consumer_id}/consumer_groups`

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

Add a consumer to a specific consumer group. If you add a consumer to multiple groups: If all groups are allowed by the Rate Limiting Advanced plugin, only the first group’s settings will apply. Otherwise, whichever group is specified in the Rate Limiting Advanced plugin will be active.

## Path parameters

- `runtimeGroupId` (string, required) - The ID of your runtime group. This variable is available in the Konnect manager
- `consumer_id` (string, required) - The unique identifier or the username of the Consumer to retrieve.

## Request body

Content types: `application/json`

## Responses

- `200` - Example response

## 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/consumers/{consumer_id}/consumer_groups:
    parameters:
      - $ref: "#/components/parameters/runtimeGroupId"
      - $ref: "#/components/parameters/consumer_id"
    post:
      operationId: post-runtimeGroupId-core-entities-consumers-consumer_id-consumer_groups
      summary: Add a consumer to a group
      description: >
        Add a consumer to a specific consumer group.


        If you add a consumer to multiple groups:


        If all groups are allowed by the Rate Limiting Advanced plugin, only the
        first group’s settings will apply.

        Otherwise, whichever group is specified in the Rate Limiting Advanced
        plugin will be active.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                group:
                  description: The consumer group UUID.
                  type: string
                  example: 1e965e47-d185-4e9e-8bc7-94ea6ae75b2e
      responses:
        "200":
          $ref: "#/components/responses/consumer-groups-response"
      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
    consumer_id:
      name: consumer_id
      in: path
      schema:
        type: string
        example: e94215b0-9198-42ce-bf0b-98afff31b2a7
      description: The unique identifier or the username of the Consumer to retrieve.
      required: true
  responses:
    consumer-groups-response:
      description: Example response
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  type: object
                  properties:
                    created_at:
                      description: Unix epoch when the resource was created.
                      type: integer
                      example: 1685551597
                    id:
                      description: Consumer group ID
                      type: string
                      example: 0cf03a37-8987-4c3b-a792-5b1db3eeedc6
                    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
            x-examples:
              Example 1:
                data:
                  - created_at: 1685551597
                    id: 0cf03a37-8987-4c3b-a792-5b1db3eeedc6
                    name: test
                    tags:
                      - tag1
                    updated_at: 1685551597
          examples:
            Example consumer group response:
              value:
                data:
                  - created_at: 1685551597
                    id: 0cf03a37-8987-4c3b-a792-5b1db3eeedc6
                    name: test
                    tags:
                      - tag1
                    updated_at: 1685551597
        application/xml:
          schema:
            type: object
            properties: {}
  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.
```
