Skip to main content
The account endpoints expose the organization behind your storefront. Use them to read your current account context, list the accounts you can switch into, provision and remove accounts under your organization, set the registered account domain, control domain auto-join, and manage your notification opt-ins. All examples use the storefront base URL:
Authenticate every request with Authorization: Bearer $SCOPE3_API_KEY. Your account context is resolved from the API key. Account-management, domain, and membership operations require the ADMIN role on the target account.

​
Key concepts

  • Organization/account hierarchy. A standalone account becomes an organization the first time you create an account under it; the new account inherits the organization’s contract. Only CHILD-type accounts can be deleted, and only when they have no linked resources.
  • Registered domain. An account can carry one customerDomain. It gates domain auto-join and, for SELLER accounts, seeds the auto-created storefront’s publisher and operator domain when supplied.
  • Storefront operator domain. A storefront has its own operatorDomain, which is the canonical domain the storefront operates as for AAO and buyer-facing identity. It may differ from the account’s customerDomain. Updating customerDomain syncs the storefront only while the storefront operator domain is missing or still mirrors the account’s previous registered domain.
  • Domain auto-join. When allowDomainAutoJoin is true, users with a verified matching-domain email join as members without admin approval. It requires a customerDomain to be set.
  • Notification opt-ins. Preferences are a full set of { notificationType, channel } pairs. The update call replaces all existing opt-ins.

​
Task reference

Get current account

Authenticated account context

List accounts

Accounts you can switch into

Create account

Provision a buyer or seller account

Delete account

Hard-delete an empty account

Update account domain

Set the account’s registered domain

Get membership

Read domain auto-join setting

Update membership

Toggle domain auto-join

Get notification preferences

Read your opt-ins

Update notification preferences

Replace your opt-ins

All account tasks

Every operation in one place

Activity & reporting

Audit feed and reporting metrics

Errors

Shared error contract