curl --request PATCH \
--url https://api.interchange.io/api/v2/accounts/{customerId}/membership \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"allowDomainAutoJoin": true
}
'import requests
url = "https://api.interchange.io/api/v2/accounts/{customerId}/membership"
payload = { "allowDomainAutoJoin": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({allowDomainAutoJoin: true})
};
fetch('https://api.interchange.io/api/v2/accounts/{customerId}/membership', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"customerId": 200,
"allowDomainAutoJoin": false,
"customerDomain": "nike.com"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Update membership settings
Update membership settings for a customer org. Requires ADMIN role and a registered customer domain to enable domain auto-join.
curl --request PATCH \
--url https://api.interchange.io/api/v2/accounts/{customerId}/membership \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"allowDomainAutoJoin": true
}
'import requests
url = "https://api.interchange.io/api/v2/accounts/{customerId}/membership"
payload = { "allowDomainAutoJoin": True }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({allowDomainAutoJoin: true})
};
fetch('https://api.interchange.io/api/v2/accounts/{customerId}/membership', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"customerId": 200,
"allowDomainAutoJoin": false,
"customerDomain": "nike.com"
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Path Parameters
Customer ID
1"200"
Body
Request body for updating customer membership settings
When true, users with a verified matching domain email join immediately as members without admin approval. Set false to override the top-level organization default.
true
Response
Update membership settings
Customer membership access settings
Customer ID
-9007199254740991 <= x <= 9007199254740991200
When true, users with a verified matching domain email join immediately as members without admin approval. Defaults to true for top-level organizations and false for child accounts; an explicit setting overrides the default. Requires customerDomain to be set.
false
Customer domain used to determine auto-join eligibility.
"nike.com"