Connect · Teams
Remove manual team membership
Removes a contact’s manual assignment to a team in an organization. Membership remains if automatic rules or a subteam still require it. The endpoint returns no content.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller needs organization access and
team.edit. - The caller must also have
mandate.read. The contact must pass the permitted mandate restrictions. - The contact must have at least one type the caller can read:
contact:member.read,contact:address.read,contact:customer.read,contact:sponsor.read,contact:contributor.read,contact:employee.read, orcontact:supplier.read, according to its type.
Request
Path parameters
-
organizationIdidrequired -
teamIdidrequired -
contactIdidrequired
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/memberships/manual/YOUR_CONTACT_ID/remove' \
--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/memberships/manual/YOUR_CONTACT_ID/remove", {
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/memberships/manual/YOUR_CONTACT_ID/remove', 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;
Response
200 Successful response
No response body is specified.
What else happens
- The contact’s manual membership flag is cleared.
- For a subteam, the contact’s team link is removed if the contact does not match the team’s membership rules.
- Parent team membership may be added or removed to reflect manual assignments, subteams, and membership rules.
- Team membership counts are updated when membership changes require it.
- The team’s membership revision is incremented.
- When a user loses access to an affected team and has no other qualifying membership, their team chat activity states are deleted.
- The contact’s Connect user-organization cache is cleared.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | The team was not found | If the team is not found in the organization, the endpoint returns HTTP 404 NOT_FOUND with key routes.connect.teams.notFound. |
| 404 | The membership was not found or you do not have access to the contact | If the manual membership is not found or the caller cannot access the contact, the endpoint returns HTTP 404 NOT_FOUND with key routes.connect.teams.membershipNotFound. |
| 404 | The membership was not found or you do not have access to the contact | If the membership update matches no contact, the endpoint returns HTTP 404 NOT_FOUND with key routes.connect.teams.membershipNotFound. |
Errors nearly every request can meet are listed under Errors.