Skip to main content
PATCH /api/v2/accounts/{customerId}/domain Updates a customer’s registered organization domain. The domain gates domain auto-join membership. Requires ADMIN role on the target customer (direct membership, parent admin via the hierarchy, or SuperAdmin).

​
Request

curl
curl -X PATCH https://api.interchange.io/api/v2/accounts/200/domain \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customerDomain": "acmeretail.com"
  }'

​
Parameters

FieldInTypeRequiredNotes
customerIdpathstringYesCustomer ID to update
customerDomainbodystringYesRegistered organization domain (max 255, valid hostname pattern)

​
Response

{
  "id": 200,
  "customerDomain": "acmeretail.com",
  "customerDomainApproved": true
}
FieldTypeNotes
idintegerCustomer ID
customerDomainstring | nullRegistered organization domain on the customer
customerDomainApprovedbooleanWhether the domain was automatically verified (true when an active member’s email matches the new domain)

​
Errors

  • 400 VALIDATION_ERROR — customerDomain fails the hostname pattern.
  • 401 UNAUTHORIZED — missing or invalid bearer token.
  • 403 FORBIDDEN — caller is not an ADMIN on the target customer.
See Errors for the full error contract.

Account tasks

All account operations

Update membership

Toggle domain auto-join

Get current account

Your current context