Skip to main content
PATCH
Update customer domain

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

customerId
string
required

Customer ID

Minimum string length: 1
Example:

"200"

Body

application/json

Request body for updating a customer's organization domain

customerDomain
string
required

Registered organization domain to set on the customer.

Maximum string length: 255
Pattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?(\.[a-z0-9]([a-z0-9-]*[a-z0-9])?)+$
Example:

"nike.com"

Response

Update customer domain

Updated customer domain

id
integer
required

Customer ID

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

200

customerDomain
string | null
required

Registered organization domain on the customer

Example:

"nike.com"

customerDomainApproved
boolean
required

Whether the current domain is verified by an active member email or Scope3 administrator attestation.