Skip to main content
PATCH
/
projects
/
{projectId}
/
customers
/
{customerId}
Update a customer
curl --request PATCH \
  --url https://api.console.corti.app/functions/v1/public/projects/{projectId}/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "displayName": "admin",
  "customerId": "contosohospital",
  "isNfr": false
}'
{
  "displayName": "admin",
  "tenantName": "base",
  "region": "eu",
  "customerId": "contosohospital",
  "isNfr": false,
  "createdAt": "2023-10-01T12:00:00Z"
}

Authorizations

​
Authorization
string
header
required

JWT access token obtained from the /auth/token endpoint

Path Parameters

​
projectId
string
required

The unique identifier for a console project

Example:

"consoleproject"

​
customerId
string
required

The unique identifier for a Customer

Example:

"contosohospital"

Body

application/json
​
displayName
string

Human-readable display name for the customer

Example:

"admin"

​
customerId
string

Unique identifier for the customer

Maximum length: 64
Example:

"contosohospital"

​
isNfr
boolean

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

Example:

false

Response

Customer updated successfully

​
displayName
string
required

Human-readable display name for the customer

Example:

"admin"

​
tenantName
string
default:base
required

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

Maximum length: 14
Example:

"base"

​
region
enum<string>
default:eu
required

Region for the customer's resources

Available options:
eu,
us
​
customerId
string
required

Unique identifier for the customer

Maximum length: 64
Example:

"contosohospital"

​
isNfr
boolean
default:false

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

Example:

false

​
createdAt
string<date-time>

Timestamp when the customer was created

Example:

"2023-10-01T12:00:00Z"

⌘I