Update account domain

PATCH /api/v2/accounts/{customerId}/domain Sets the registered domain on an account. The domain gates domain auto-join and, for seller accounts, ties the account to its storefront. Requires the ADMIN role on the target account (direct membership, organization 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

Field	Type	Required	Notes
`customerId`	string	Yes	Path parameter. ID of the account to update
`customerDomain`	string	Yes	Registered domain to set (max 255). Lowercase host form, e.g. `acme.com`

Response

{
  "id": 200,
  "customerDomain": "retail.northwind.example",
  "customerDomainApproved": true
}

Field	Type	Notes
`id`	integer	Account ID
`customerDomain`	string \| null	The domain now registered on the account
`customerDomainApproved`	boolean	Whether 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 account.

See Errors for the full error contract.

Account tasks

All account operations

Update membership

Enable domain auto-join

Account overview

Domain and hierarchy concepts

List accounts Update membership

⌘I

Getting Started

Operating Your Storefront

Inventory Sources

Real-Time Targeting (TMP)

Approvals & Reviews

Buyer Onboarding

Demand & Signals

Proposals & Agents

Buyer Routing

Analytics & Activity

Billing

Account

Request

Parameters

Response

Errors

Account tasks

Update membership

Account overview

​Request

​Parameters

​Response

​Errors

​Related

Account tasks

Update membership

Account overview

Request

Parameters

Response

Errors

Related