Skip to main content
PATCH /api/v2/accounts/{customerId}/membership Updates the membership settings for an account. Requires ADMIN role and a registered customerDomain to enable domain auto-join.

​
Request

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

​
Parameters

FieldInTypeRequiredNotes
customerIdpathstringYesID of the account to update
allowDomainAutoJoinbodybooleanYesWhen true, users with a verified matching-domain email join immediately as members without admin approval

​
Response

{
  "customerId": 200,
  "allowDomainAutoJoin": true
}
FieldTypeNotes
customerIdintegerAccount ID
allowDomainAutoJoinbooleanEffective auto-join setting after the update

​
Errors

  • 400 VALIDATION_ERROR — allowDomainAutoJoin is true but the account has no registered customerDomain.
  • 401 UNAUTHORIZED — missing or invalid bearer token.
  • 403 FORBIDDEN — caller is not an ADMIN on the target account.
See Errors for the full error contract.

Account tasks

All account operations

Get membership

Read access settings

Update account domain

Set the registered domain