Skip to main content
PATCH /api/v2/accounts/{customerId}/membership Updates the membership settings for a customer org. 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
customerIdpathstringYesCustomer ID to update
allowDomainAutoJoinbodybooleanYesWhen true, users with a verified matching-domain email join immediately as members without admin approval

​
Response

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

​
Errors

  • 400 VALIDATION_ERROR — allowDomainAutoJoin is true but the customer has no registered customerDomain.
  • 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

Get membership

Read access settings

Update customer domain

Set the org domain