Connect · Teams
Update membership role
Assigns, changes, or removes a contact’s role in a team without changing the membership. Supply the organization, team, and contact IDs and a role ID, or null to remove the assigned role. An assigned role replaces the team’s default member role for that team. The endpoint returns no response body.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Requires organization access.
- Requires
team.edit. - Requires
mandate.read. - The contact must have at least one type for which the caller has read access. Permitted mandate restrictions also apply.
Request
Path parameters
-
organizationIdidrequired -
teamIdidrequired -
contactIdidrequired
Body
Content-Type: application/json
-
roleIdidrequirednullable
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/YOUR_CONTACT_ID/role' \
--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/YOUR_CONTACT_ID/role", {
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/YOUR_CONTACT_ID/role', 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.
What else happens
- Updates the contact’s role and role name for the team, or clears both when
roleIdis null. - When an existing role is assigned, increments its
referenceRevision. - Increments the team’s
membershipRevisionas part of the update. - Clears the contact’s Connect user organizations cache after updating the membership.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | The team was not found | If the team is not found, 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 membership is not found or the contact is not accessible, returns HTTP 404 NOT_FOUND with key routes.connect.teams.membershipNotFound. |
| 404 | The team role was not found | If a non-null role ID is supplied and the role is not found, returns HTTP 404 NOT_FOUND with key routes.connect.teams.roles.notFound. |
Errors nearly every request can meet are listed under Errors.