Skip to main content
PATCH /api/v2/accounts/{customerId}/domain Sets the registered organization domain on a customer. The domain gates domain auto-join and, for seller accounts, ties the org to its storefront. Requires the 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": "retail.northwind.example"
  }'

​
Parameters

FieldTypeRequiredNotes
customerIdstringYesPath parameter. ID of the customer to update
customerDomainstringYesRegistered organization domain to set (max 255). Lowercase host form, e.g. acme.com

​
Response

{
  "id": 200,
  "customerDomain": "retail.northwind.example",
  "customerDomainApproved": true
}
FieldTypeNotes
idintegerCustomer ID
customerDomainstring | nullThe domain now registered on the customer
customerDomainApprovedbooleanWhether the domain was automatically verified (true when an active member’s email matches the new domain)

​
Errors

  • 400 VALIDATION_ERROR — malformed customerDomain.
  • 401 UNAUTHORIZED — caller is not an ADMIN on the target customer.
See Errors for the full error contract.

Account tasks

All account operations

Update membership

Enable domain auto-join

Account overview

Domain and hierarchy concepts