Update an organisation
curl --request PUT \
--url http://localhost:3001/portal-api/organisations/{organisation_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"Name": "Default Organisation"
}
'import requests
url = "http://localhost:3001/portal-api/organisations/{organisation_id}"
payload = { "Name": "Default Organisation" }
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'})
};
fetch('http://localhost:3001/portal-api/organisations/{organisation_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}",
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'
]),
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}"
payload := strings.NewReader("{\n \"Name\": \"Default Organisation\"\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}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Name\": \"Default Organisation\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/organisations/{organisation_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\"\n}"
response = http.request(request)
puts response.read_body{
"CreatedAt": "2023-06-23 21:02",
"UpdatedAt": "2023-06-23 21:02",
"ID": 1,
"Name": "Default Organisation",
"Teams": [
{
"Default": true,
"ID": 1,
"Name": "Default Organisation All users"
}
],
"Users": [
{
"Active": true,
"Email": "admin@acme.com",
"First": "John",
"Last": "Doe",
"OrganisationID": 1,
"Role": "consumer-team-member",
"Provider": "password",
"ID": 1
}
]
}Organisations
Update an organisation
Update an organisation’s data. At this point, you can change only the name of an organisation
PUT
/
organisations
/
{organisation_id}
Update an organisation
curl --request PUT \
--url http://localhost:3001/portal-api/organisations/{organisation_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"Name": "Default Organisation"
}
'import requests
url = "http://localhost:3001/portal-api/organisations/{organisation_id}"
payload = { "Name": "Default Organisation" }
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'})
};
fetch('http://localhost:3001/portal-api/organisations/{organisation_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}",
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'
]),
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}"
payload := strings.NewReader("{\n \"Name\": \"Default Organisation\"\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}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Name\": \"Default Organisation\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/organisations/{organisation_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\"\n}"
response = http.request(request)
puts response.read_body{
"CreatedAt": "2023-06-23 21:02",
"UpdatedAt": "2023-06-23 21:02",
"ID": 1,
"Name": "Default Organisation",
"Teams": [
{
"Default": true,
"ID": 1,
"Name": "Default Organisation All users"
}
],
"Users": [
{
"Active": true,
"Email": "admin@acme.com",
"First": "John",
"Last": "Doe",
"OrganisationID": 1,
"Role": "consumer-team-member",
"Provider": "password",
"ID": 1
}
]
}Authorizations
Path Parameters
UID of an organisation
Example:
2
Body
application/json
Name of an organisation
Example:
"Default Organisation"
Response
200 - application/json
OK
Date-time when a user is created
Pattern:
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$Example:
"2023-06-23 21:02"
Date-time when a user is updated the last time
Pattern:
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$Example:
"2023-06-23 21:02"
UID of an organisation
Example:
1
Name of an organisation
Example:
"Default Organisation"
Teams included in this organisation
Show child attributes
Show child attributes
Users that are included in this organisation. For newly created organisation this field will be an empty array
Show child attributes
Show child attributes
Was this page helpful?
⌘I