Patch a customer.

Apply partial updates to a customer's details, license, channels, and entitlements. Only the fields provided in the request body will be updated.

Required RBAC Policy: kots/app/[:appid]/license/[:licenseid]/update

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Customer identifier

Body Params

Patch customer parameters.

add_channels
array of objects

Channels this customer will be assigned to.

add_channels
add_entitlements
array of objects

List of entitlements to add for the customer.

add_entitlements
string

Custom ID that can be used in external systems.

string

Email of the customer that is to be updated

string

Format is YYYY-MM-DD, e.g. 2021-02-24

boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
string

Name of the customer that is to be updated.

remove_channels
array of strings

Channels this customer will be removed from.

remove_channels
remove_entitlements
array of strings

List of entitlement names to remove from the customer. Default values will be used.

remove_entitlements
boolean
boolean

SAML configuration - vendors can enable/disable SAML for customers

string
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json