Add users to a team
curl --request POST \
--url https://{subdomain}.conveyour.com/api/teams/users \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"team_id": "<string>",
"users.add": [
"<string>"
],
"users.remove": [
"<string>"
],
"users": {
"add": [
123
],
"remove": [
123
]
}
}
'const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
team_id: '<string>',
'users.add': ['<string>'],
'users.remove': ['<string>'],
users: {add: [123], remove: [123]}
})
};
fetch('https://{subdomain}.conveyour.com/api/teams/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
team_id: '<string>',
'users.add': ['<string>'],
'users.remove': ['<string>'],
users: {add: [123], remove: [123]}
})
};
fetch('https://{subdomain}.conveyour.com/api/teams/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/teams/users"
payload = {
"team_id": "<string>",
"users.add": ["<string>"],
"users.remove": ["<string>"],
"users": {
"add": [123],
"remove": [123]
}
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/teams/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'team_id' => '<string>',
'users.add' => [
'<string>'
],
'users.remove' => [
'<string>'
],
'users' => [
'add' => [
123
],
'remove' => [
123
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "Team record users updated",
"data": {
"id": "64a1b2c3d4e5f6a7b8c9d0e1",
"label": "West Region",
"name": "west_region",
"users": [
1024
]
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Teams
Add users to a team
Adds or removes users from a team. Add and remove one user at a time. The caller must have permission to update the affected user.
Add or remove users from a team
POST
/
api
/
teams
/
users
Add users to a team
curl --request POST \
--url https://{subdomain}.conveyour.com/api/teams/users \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"team_id": "<string>",
"users.add": [
"<string>"
],
"users.remove": [
"<string>"
],
"users": {
"add": [
123
],
"remove": [
123
]
}
}
'const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
team_id: '<string>',
'users.add': ['<string>'],
'users.remove': ['<string>'],
users: {add: [123], remove: [123]}
})
};
fetch('https://{subdomain}.conveyour.com/api/teams/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'POST',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
team_id: '<string>',
'users.add': ['<string>'],
'users.remove': ['<string>'],
users: {add: [123], remove: [123]}
})
};
fetch('https://{subdomain}.conveyour.com/api/teams/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/teams/users"
payload = {
"team_id": "<string>",
"users.add": ["<string>"],
"users.remove": ["<string>"],
"users": {
"add": [123],
"remove": [123]
}
}
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/teams/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'team_id' => '<string>',
'users.add' => [
'<string>'
],
'users.remove' => [
'<string>'
],
'users' => [
'add' => [
123
],
'remove' => [
123
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "Team record users updated",
"data": {
"id": "64a1b2c3d4e5f6a7b8c9d0e1",
"label": "West Region",
"name": "west_region",
"users": [
1024
]
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Authorizations
Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.
Query Parameters
Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.
Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.
Body
application/json