Sign in

v1

latestOpenAPI 3.1.02026-07-2676188241.3 KB
Customers

Update a customer

Update specific fields of a customer. Only provided fields will be updated.

patch/projects/{projectId}/customers/{customerId}

Path parameters

projectIdstring required
Example:consoleproject

Unique identifier of your project in the Corti API Console.

To find it, open your project at console.corti.app, go to Settings, and copy the value from the Project ID field.

customerIdstring required
Example:contosohospital

The unique identifier for a Customer

Request body

displayNamestring

Human-readable display name for the customer

customerIdstring

Unique identifier for the customer

isNfrboolean

Flag indicating if this is a Not-For-Resale (NFR) customer account

Example request

{
  "displayName": "admin",
  "customerId": "contosohospital"
}

Response

Customer updated successfully

displayNamestring required

Human-readable display name for the customer

tenantNamestring required

The tenant identifier used for multi-tenancy and resource isolation.

region'eu' | 'us' required

Region for the customer's resources

customerIdstring required

Unique identifier for the customer

isNfrboolean

Flag indicating if this is a Not-For-Resale (NFR) customer account

createdAtstring date-time

Timestamp when the customer was created

Example response

{
  "displayName": "admin",
  "tenantName": "base",
  "customerId": "contosohospital",
  "createdAt": "2023-10-01T12:00:00Z"
}