Connect · Team roles
Create team role
Creates a team role for an organization using organizationId, name, description, and permissions. Returns the new role’s _id.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access.
- The caller needs the
team.insertpermission.
Request
Path parameters
-
organizationIdidrequired
Body
Content-Type: application/json
-
namestringrequired1–32 characters
-
descriptionstringrequiredat most 256 characters
-
permissionsobjectrequired5 properties
-
contactobject10 properties
-
readobject of booleanKeys: one of 7 values
memberaddresscustomersponsorcontributoremployeesupplier -
communicationboolean -
personalboolean -
departmentsboolean -
groupsboolean -
billingboolean -
contractsboolean -
notesboolean -
proofsCertificatesboolean -
tagsboolean
-
-
userobject of booleanKeys: one of 3 values
listreadchat -
chatobject22 properties
-
createActivityboolean -
createPollboolean -
createAvailabilityboolean -
createSignupboolean -
createChecklistboolean -
createFormboolean -
createChallengeboolean -
participatePollboolean -
participateAvailabilityboolean -
participateSignupboolean -
participateChecklistboolean -
participateFormboolean -
participateChallengeboolean -
manageActivitiesboolean -
replyboolean -
reactboolean -
mentionboolean -
mentionEveryoneboolean -
manageboolean -
changeAppearanceboolean -
pinboolean -
viewContactNameboolean
-
-
todoobject of booleanKeys: one of 2 values
readmanage -
fileobject of booleanKeys: one of 4 values
viewmanageFoldersmanageOwnFilesmanageAllFiles
-
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/team-roles' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/team-roles", {
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/team-roles', 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
Content-Type: application/json
-
_idid
Response200
{
"_id": "000000000000000000000001"
}
What else happens
- Creates a record in
teamRoles.
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.