---
title: "Upsert a Consumer"
url: "https://nov18-dev.movespot.fyi/apis/konnect-control-planes-configuration-3/versions/4a9ee72f-47ac-4061-9b08-3290c8d0ce93/operations/upsert-consumer"
---

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

# Upsert a Consumer

`PUT` `/control-planes/{controlPlaneId}/core-entities/consumers/{ConsumerId}`

Operation ID: `upsert-consumer`

Create or Update Consumer using ID or username.

## Path parameters

- `ConsumerId` (string, required) - ID of the Consumer to lookup
- `controlPlaneId` (string, uuid, required) - The UUID of your control plane. This variable is available in the Konnect manager.

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Successfully upserted Consumer
- `401` - Unauthorized

## 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/consumers/{ConsumerId}:
    parameters:
      - $ref: "#/components/parameters/ConsumerId"
      - $ref: "#/components/parameters/controlPlaneId"
    put:
      operationId: upsert-consumer
      summary: Upsert a Consumer
      description: Create or Update Consumer using ID or username.
      requestBody:
        description: Description of the Consumer
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Consumer"
      responses:
        "200":
          description: Successfully upserted Consumer
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Consumer"
        "401":
          $ref: "#/components/responses/HTTP401Error"
      tags:
        - Consumers
security:
  - konnectAccessToken: []
  - personalAccessToken: []
components:
  parameters:
    ConsumerId:
      description: ID of the Consumer to lookup
      example: c1059869-6fa7-4329-a5f5-5946d14ca2c5
      in: path
      name: ConsumerId
      required: true
      schema:
        type: string
    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:
    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
    GatewayUnauthorizedError:
      type: object
      properties:
        message:
          type: string
        status:
          type: integer
      required:
        - message
        - status
  responses:
    HTTP401Error:
      description: Unauthorized
      content:
        application/json:
          examples:
            DuplicateApiKey:
              summary: Duplicate API key found
              value:
                message: Duplicate API key found
                status: 401
            InvalidAuthCred:
              summary: Invalid authentication credentials
              value:
                message: Unauthorized
                status: 401
            NoAPIKey:
              summary: No API key found
              value:
                message: No API key found in request
                status: 401
          schema:
            $ref: "#/components/schemas/GatewayUnauthorizedError"
  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.
```
