Skip to main content
PATCH /api/v2/accounts/{customerId}/membership Updates the membership access settings for a customer org. Requires the 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

FieldTypeRequiredNotes
customerIdstringYesPath parameter. ID of the customer to update
allowDomainAutoJoinbooleanYesWhen true, users with a verified matching-domain email join as members without admin approval. Requires customerDomain to be set

​
Response

{
  "customerId": 200,
  "allowDomainAutoJoin": true
}
FieldTypeNotes
customerIdintegerCustomer ID
allowDomainAutoJoinbooleanThe setting now in effect

​
Errors

  • 400 VALIDATION_ERROR — enabling auto-join without a registered customerDomain.
  • 401 UNAUTHORIZED — caller is not an ADMIN.
See Errors for the full error contract.

Account tasks

All account operations

Get membership

Read the current setting

Update customer domain

Register a domain first