Update a customer.

put

https://api.replicated.com/vendor/v3/customer/{customer_id}

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.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customer_id

string

required

Customer identifier

Body Params

Update customer parameters.

app_id

string

required

App to which the channel is associated.

channel_id

string

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

custom_id

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

expires_at

string

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

is_airgap_enabled

boolean

is_dev_mode_enabled

boolean

is_disaster_recovery_supported

boolean

is_embedded_cluster_download_enabled

boolean

is_embedded_cluster_multinode_enabled

boolean

is_enterprise_portal_enabled

boolean

is_geoaxis_supported

boolean

is_gitops_supported

boolean

is_helm_airgap_enabled

boolean

is_helm_install_enabled

boolean

is_identity_service_supported

boolean

is_kots_install_enabled

boolean

is_kurl_install_enabled

boolean

is_snapshot_supported

boolean

is_support_bundle_upload_enabled

boolean

name

string

required

Name of the customer that is to be updated.

saml_allowed

boolean

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

type

string

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200GetCustomerResponse represents a customer.

400Returned on bad input

401Return if the caller is not authorized

403Returned if the caller does not have the needed permission

404Returned on resource not found