Update Consumer
PATCH {{gateway}}/consumers/:consumerUsernameOrId
Update Consumer konghq
| Attributes | Mandatory | Type | Description |
|---|
| consumer username or id | required | path | The unique identifier or the username of the Consumer to retrieve. |
Request Body
| Attributes | Mandatory | Description |
|---|
| username | semi-optional | The unique username of the consumer. You must send either this field or custom_id with the request. |
| custom_id | semi-optional | 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. |
| tags | optional | An optional set of strings associated with the Consumer, for grouping and filtering. |
Request Body
{"username"=>"my-username", "custom_id"=>"my-custom-id", "tags"=>["user-level", "low-priority"]}
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
RESPONSES
status: OK
{"custom_id":"my-custom-id","created_at":1583991173,"id":"626169e4-6cd7-4952-85b1-3fda70fd5333","tags":["user-level","low-priority"],"username":"my-username"}