---
title: "UpdateConsumerPayload"
url: "https://nov18-dev.movespot.fyi/apis/konnect-centrally-managed-consumers-admin-api-0/versions/84f5e371-6d0e-45b1-b943-fe4dc428c317/schemas/UpdateConsumerPayload"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-centrally-managed-consumers-admin-api-0/versions/84f5e371-6d0e-45b1-b943-fe4dc428c317.md

# UpdateConsumerPayload

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Centrally Managed Consumers admin api
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    ConsumerUsername:
      description: The unique username of the Consumer.
      type: string
      minLength: 1
    ConsumerType:
      description: |
        Type of the consumer.
      type: string
      default: proxy
      enum:
        - proxy
        - developer
        - admin
        - application
    Tags:
      type: array
      items:
        type: string
      uniqueItems: true
    UpdateConsumerPayload:
      type: object
      properties:
        username:
          $ref: "#/components/schemas/ConsumerUsername"
        custom_id:
          description: Field for storing an existing unique ID for the Consumer - useful
            for mapping Kong with users in your existing database.
          type: string
          minLength: 1
          nullable: true
        consumer_groups:
          description: >
            A list of consumer groups that the Consumer is in.

            If `consumer_groups` are provided on the Consumer object _and_ on
            the Realm, the Consumer will be placed in all defined consumer
            groups.
          type: array
          items:
            type: string
            uniqueItems: true
          nullable: true
          title: ConsumerGroups
        type:
          $ref: "#/components/schemas/ConsumerType"
        tags:
          $ref: "#/components/schemas/Tags"
      additionalProperties: false
```
