Connect · Teams
Update team access
Updates automatic membership criteria and the default member role, rejects stale settings, and retries unfinished synchronization when saved unchanged
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
team.edit
Request
Path parameters
-
organizationIdidrequired -
teamIdidrequired
Body
Content-Type: application/json
-
membershipobjectrequired4 properties
-
contactTypesstring[]requiredmemberaddresscustomersponsorcontributoremployeesupplier -
segmentsstring[]requiredeach 1–30 characters
-
departmentsid[]required -
tagsstring[]requiredat most 20 items · each 1–40 characters
-
-
memberRoleidrequired -
expectedobjectrequired2 properties
-
membershipobjectrequired4 properties
-
contactTypesstring[]requiredmemberaddresscustomersponsorcontributoremployeesupplier -
segmentsstring[]requiredeach 1–30 characters
-
departmentsid[]required -
tagsstring[]requiredat most 20 items · each 1–40 characters
-
-
memberRoleidrequired
-
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/teams/YOUR_TEAM_ID/access' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/teams/YOUR_TEAM_ID/access", {
method: "POST",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'POST',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/teams/YOUR_TEAM_ID/access', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
No response body is specified.
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.