Update a customer.

Update the details, license, and channel assignments for an existing customer.
Supports changing metadata, license type, expiration, entitlements, and feature flags.
Parameters that are not provided are reset to default values, except for
type, is_enterprise_portal_enabled, is_dev_mode_enabled, and saml_allowed, which
preserve their currently stored value instead of resetting it when omitted.
is_embedded_cluster_multinode_enabled is also preserved when omitted, but
only while is_embedded_cluster_download_enabled is true; otherwise it is
reset like any other omitted parameter.
Changing type away from "dev" while a customer has dev mode enabled requires
explicitly sending is_dev_mode_enabled=false in the same request; otherwise
the preserved stored dev-mode value conflicts with the new type and the
request is rejected with a 400.

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

Update customer parameters.

string
required

App to which the channel is associated.

string

The channel id to which the customer is associated. This is the default channel for the customer.

string

Custom ID that can be used in external systems.

string

Email of the customer that is to be updated

entitlementValues
array of objects

Applies only to the currently selected app

entitlementValues
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
string
required

Name of the customer that is to be updated.

boolean

SAML configuration - vendors can enable/disable SAML for customers
Customers configure their IdP details via market-api

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