Update a team for an organisation
curl --request PUT \
--url http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"Name": "Default Organisation All users",
"Users": [
1
]
}
'import requests
url = "http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}"
payload = {
"Name": "Default Organisation All users",
"Users": [1]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({Name: 'Default Organisation All users', Users: [1]})
};
fetch('http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'Name' => 'Default Organisation All users',
'Users' => [
1
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}"
payload := strings.NewReader("{\n \"Name\": \"Default Organisation All users\",\n \"Users\": [\n 1\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Name\": \"Default Organisation All users\",\n \"Users\": [\n 1\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Name\": \"Default Organisation All users\",\n \"Users\": [\n 1\n ]\n}"
response = http.request(request)
puts response.read_body{
"Name": "Default Organisation All users",
"ID": 11,
"CreatedAt": "2023-06-23 21:02",
"UpdatedAt": "2023-06-23 21:02",
"Users": [
"User#6"
]
}Teams
Update a team for an organisation
Update a team for an organisation by adding or removing users, or changing the name of the team
PUT
/
organisations
/
{organisation_id}
/
teams
/
{team_id}
Update a team for an organisation
curl --request PUT \
--url http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"Name": "Default Organisation All users",
"Users": [
1
]
}
'import requests
url = "http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}"
payload = {
"Name": "Default Organisation All users",
"Users": [1]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({Name: 'Default Organisation All users', Users: [1]})
};
fetch('http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'Name' => 'Default Organisation All users',
'Users' => [
1
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}"
payload := strings.NewReader("{\n \"Name\": \"Default Organisation All users\",\n \"Users\": [\n 1\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Name\": \"Default Organisation All users\",\n \"Users\": [\n 1\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/organisations/{organisation_id}/teams/{team_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Name\": \"Default Organisation All users\",\n \"Users\": [\n 1\n ]\n}"
response = http.request(request)
puts response.read_body{
"Name": "Default Organisation All users",
"ID": 11,
"CreatedAt": "2023-06-23 21:02",
"UpdatedAt": "2023-06-23 21:02",
"Users": [
"User#6"
]
}Authorizations
Path Parameters
UID of a team
Example:
2
UID of an organisation
Example:
2
Body
application/json
Response
200 - application/json
OK
Name of this team
Example:
"Default Organisation All users"
UID of this team
Example:
11
Date-time when a team is created
Pattern:
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$Example:
"2023-06-23 21:02"
Date-time when a team was updated the last time
Pattern:
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$Example:
"2023-06-23 21:02"
Users included in this organisation. For newly created organisation will an empty array
User ID
Was this page helpful?
⌘I