Update a User
curl --request PUT \
--url https://api.ctrl-hub.com/v3/users/{user_id} \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": {
"profile": {
"address": {
"area": "Central London",
"country_code": "GB",
"county": "Greater London",
"name": "The Shard",
"number": "32A",
"postcode": "SE1 9SG",
"street": "London Bridge Street",
"town": "London",
"what3words": "spark.dizzy.ramp"
},
"contact": {
"landline": "020 3728 5000",
"mobile": "07700 900456"
},
"personal": {
"dob": "1985-06-15T00:00:00.000Z",
"first_name": "Charlotte",
"last_name": "Thompson"
},
"settings": {
"preferred_language": "en-GB",
"timezone": "Europe/London"
},
"work": {
"cscs": "GBCSCS789",
"eusr": "GBEUSR012",
"occupation": "Senior Software Engineer",
"start_date": "2018-03-15T00:00:00.000Z"
}
}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/users/{user_id}"
payload = { "data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": { "profile": {
"address": {
"area": "Central London",
"country_code": "GB",
"county": "Greater London",
"name": "The Shard",
"number": "32A",
"postcode": "SE1 9SG",
"street": "London Bridge Street",
"town": "London",
"what3words": "spark.dizzy.ramp"
},
"contact": {
"landline": "020 3728 5000",
"mobile": "07700 900456"
},
"personal": {
"dob": "1985-06-15T00:00:00.000Z",
"first_name": "Charlotte",
"last_name": "Thompson"
},
"settings": {
"preferred_language": "en-GB",
"timezone": "Europe/London"
},
"work": {
"cscs": "GBCSCS789",
"eusr": "GBEUSR012",
"occupation": "Senior Software Engineer",
"start_date": "2018-03-15T00:00:00.000Z"
}
} }
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
type: '<string>',
attributes: {
profile: {
address: {
area: 'Central London',
country_code: 'GB',
county: 'Greater London',
name: 'The Shard',
number: '32A',
postcode: 'SE1 9SG',
street: 'London Bridge Street',
town: 'London',
what3words: 'spark.dizzy.ramp'
},
contact: {landline: '020 3728 5000', mobile: '07700 900456'},
personal: {
dob: '1985-06-15T00:00:00.000Z',
first_name: 'Charlotte',
last_name: 'Thompson'
},
settings: {preferred_language: 'en-GB', timezone: 'Europe/London'},
work: {
cscs: 'GBCSCS789',
eusr: 'GBEUSR012',
occupation: 'Senior Software Engineer',
start_date: '2018-03-15T00:00:00.000Z'
}
}
}
}
})
};
fetch('https://api.ctrl-hub.com/v3/users/{user_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_URL => "https://api.ctrl-hub.com/v3/users/{user_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([
'data' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => '<string>',
'attributes' => [
'profile' => [
'address' => [
'area' => 'Central London',
'country_code' => 'GB',
'county' => 'Greater London',
'name' => 'The Shard',
'number' => '32A',
'postcode' => 'SE1 9SG',
'street' => 'London Bridge Street',
'town' => 'London',
'what3words' => 'spark.dizzy.ramp'
],
'contact' => [
'landline' => '020 3728 5000',
'mobile' => '07700 900456'
],
'personal' => [
'dob' => '1985-06-15T00:00:00.000Z',
'first_name' => 'Charlotte',
'last_name' => 'Thompson'
],
'settings' => [
'preferred_language' => 'en-GB',
'timezone' => 'Europe/London'
],
'work' => [
'cscs' => 'GBCSCS789',
'eusr' => 'GBEUSR012',
'occupation' => 'Senior Software Engineer',
'start_date' => '2018-03-15T00:00:00.000Z'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <api-key>"
],
]);
$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 := "https://api.ctrl-hub.com/v3/users/{user_id}"
payload := strings.NewReader("{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"attributes\": {\n \"profile\": {\n \"address\": {\n \"area\": \"Central London\",\n \"country_code\": \"GB\",\n \"county\": \"Greater London\",\n \"name\": \"The Shard\",\n \"number\": \"32A\",\n \"postcode\": \"SE1 9SG\",\n \"street\": \"London Bridge Street\",\n \"town\": \"London\",\n \"what3words\": \"spark.dizzy.ramp\"\n },\n \"contact\": {\n \"landline\": \"020 3728 5000\",\n \"mobile\": \"07700 900456\"\n },\n \"personal\": {\n \"dob\": \"1985-06-15T00:00:00.000Z\",\n \"first_name\": \"Charlotte\",\n \"last_name\": \"Thompson\"\n },\n \"settings\": {\n \"preferred_language\": \"en-GB\",\n \"timezone\": \"Europe/London\"\n },\n \"work\": {\n \"cscs\": \"GBCSCS789\",\n \"eusr\": \"GBEUSR012\",\n \"occupation\": \"Senior Software Engineer\",\n \"start_date\": \"2018-03-15T00:00:00.000Z\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.ctrl-hub.com/v3/users/{user_id}")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"attributes\": {\n \"profile\": {\n \"address\": {\n \"area\": \"Central London\",\n \"country_code\": \"GB\",\n \"county\": \"Greater London\",\n \"name\": \"The Shard\",\n \"number\": \"32A\",\n \"postcode\": \"SE1 9SG\",\n \"street\": \"London Bridge Street\",\n \"town\": \"London\",\n \"what3words\": \"spark.dizzy.ramp\"\n },\n \"contact\": {\n \"landline\": \"020 3728 5000\",\n \"mobile\": \"07700 900456\"\n },\n \"personal\": {\n \"dob\": \"1985-06-15T00:00:00.000Z\",\n \"first_name\": \"Charlotte\",\n \"last_name\": \"Thompson\"\n },\n \"settings\": {\n \"preferred_language\": \"en-GB\",\n \"timezone\": \"Europe/London\"\n },\n \"work\": {\n \"cscs\": \"GBCSCS789\",\n \"eusr\": \"GBEUSR012\",\n \"occupation\": \"Senior Software Engineer\",\n \"start_date\": \"2018-03-15T00:00:00.000Z\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/users/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"attributes\": {\n \"profile\": {\n \"address\": {\n \"area\": \"Central London\",\n \"country_code\": \"GB\",\n \"county\": \"Greater London\",\n \"name\": \"The Shard\",\n \"number\": \"32A\",\n \"postcode\": \"SE1 9SG\",\n \"street\": \"London Bridge Street\",\n \"town\": \"London\",\n \"what3words\": \"spark.dizzy.ramp\"\n },\n \"contact\": {\n \"landline\": \"020 3728 5000\",\n \"mobile\": \"07700 900456\"\n },\n \"personal\": {\n \"dob\": \"1985-06-15T00:00:00.000Z\",\n \"first_name\": \"Charlotte\",\n \"last_name\": \"Thompson\"\n },\n \"settings\": {\n \"preferred_language\": \"en-GB\",\n \"timezone\": \"Europe/London\"\n },\n \"work\": {\n \"cscs\": \"GBCSCS789\",\n \"eusr\": \"GBEUSR012\",\n \"occupation\": \"Senior Software Engineer\",\n \"start_date\": \"2018-03-15T00:00:00.000Z\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": {
"email": "jsmith@example.com",
"identities": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "<string>",
"meta": {}
}
],
"profile": {
"work": {
"occupation": "<string>",
"cscs": "<string>",
"eusr": "<string>",
"start_date": "2023-12-25"
},
"personal": {
"first_name": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"username": "<string>"
},
"contact": {
"mobile": "<string>",
"landline": "<string>"
},
"address": {
"number": "",
"street": "<string>",
"area": "<string>",
"town": "<string>",
"county": "<string>",
"postcode": "<string>",
"country_code": "<string>",
"what3words": "<string>"
},
"settings": {
"preferred_language": "en-GB",
"timezone": "<string>"
}
}
},
"meta": {},
"relationships": {
"organisations": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"teams": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"managing_organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
}
}
},
"jsonapi": {
"version": "<string>"
},
"included": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": {
"name": "<string>",
"slug": "<string>",
"sandbox": true,
"description": "<string>",
"settings": {
"teams": {
"customer_representatives": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
}
},
"meta": {
"v3": true,
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"features": [
{
"name": "<string>",
"enabled": true,
"limit": 123
}
]
},
"relationships": {
"users": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"service_accounts": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"groups": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"teams": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"nomenclature": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
}
}
}
]
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Users
Update a user
Update an existing user.
PUT
/
v3
/
users
/
{user_id}
Update a User
curl --request PUT \
--url https://api.ctrl-hub.com/v3/users/{user_id} \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": {
"profile": {
"address": {
"area": "Central London",
"country_code": "GB",
"county": "Greater London",
"name": "The Shard",
"number": "32A",
"postcode": "SE1 9SG",
"street": "London Bridge Street",
"town": "London",
"what3words": "spark.dizzy.ramp"
},
"contact": {
"landline": "020 3728 5000",
"mobile": "07700 900456"
},
"personal": {
"dob": "1985-06-15T00:00:00.000Z",
"first_name": "Charlotte",
"last_name": "Thompson"
},
"settings": {
"preferred_language": "en-GB",
"timezone": "Europe/London"
},
"work": {
"cscs": "GBCSCS789",
"eusr": "GBEUSR012",
"occupation": "Senior Software Engineer",
"start_date": "2018-03-15T00:00:00.000Z"
}
}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/users/{user_id}"
payload = { "data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": { "profile": {
"address": {
"area": "Central London",
"country_code": "GB",
"county": "Greater London",
"name": "The Shard",
"number": "32A",
"postcode": "SE1 9SG",
"street": "London Bridge Street",
"town": "London",
"what3words": "spark.dizzy.ramp"
},
"contact": {
"landline": "020 3728 5000",
"mobile": "07700 900456"
},
"personal": {
"dob": "1985-06-15T00:00:00.000Z",
"first_name": "Charlotte",
"last_name": "Thompson"
},
"settings": {
"preferred_language": "en-GB",
"timezone": "Europe/London"
},
"work": {
"cscs": "GBCSCS789",
"eusr": "GBEUSR012",
"occupation": "Senior Software Engineer",
"start_date": "2018-03-15T00:00:00.000Z"
}
} }
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
type: '<string>',
attributes: {
profile: {
address: {
area: 'Central London',
country_code: 'GB',
county: 'Greater London',
name: 'The Shard',
number: '32A',
postcode: 'SE1 9SG',
street: 'London Bridge Street',
town: 'London',
what3words: 'spark.dizzy.ramp'
},
contact: {landline: '020 3728 5000', mobile: '07700 900456'},
personal: {
dob: '1985-06-15T00:00:00.000Z',
first_name: 'Charlotte',
last_name: 'Thompson'
},
settings: {preferred_language: 'en-GB', timezone: 'Europe/London'},
work: {
cscs: 'GBCSCS789',
eusr: 'GBEUSR012',
occupation: 'Senior Software Engineer',
start_date: '2018-03-15T00:00:00.000Z'
}
}
}
}
})
};
fetch('https://api.ctrl-hub.com/v3/users/{user_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_URL => "https://api.ctrl-hub.com/v3/users/{user_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([
'data' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'type' => '<string>',
'attributes' => [
'profile' => [
'address' => [
'area' => 'Central London',
'country_code' => 'GB',
'county' => 'Greater London',
'name' => 'The Shard',
'number' => '32A',
'postcode' => 'SE1 9SG',
'street' => 'London Bridge Street',
'town' => 'London',
'what3words' => 'spark.dizzy.ramp'
],
'contact' => [
'landline' => '020 3728 5000',
'mobile' => '07700 900456'
],
'personal' => [
'dob' => '1985-06-15T00:00:00.000Z',
'first_name' => 'Charlotte',
'last_name' => 'Thompson'
],
'settings' => [
'preferred_language' => 'en-GB',
'timezone' => 'Europe/London'
],
'work' => [
'cscs' => 'GBCSCS789',
'eusr' => 'GBEUSR012',
'occupation' => 'Senior Software Engineer',
'start_date' => '2018-03-15T00:00:00.000Z'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <api-key>"
],
]);
$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 := "https://api.ctrl-hub.com/v3/users/{user_id}"
payload := strings.NewReader("{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"attributes\": {\n \"profile\": {\n \"address\": {\n \"area\": \"Central London\",\n \"country_code\": \"GB\",\n \"county\": \"Greater London\",\n \"name\": \"The Shard\",\n \"number\": \"32A\",\n \"postcode\": \"SE1 9SG\",\n \"street\": \"London Bridge Street\",\n \"town\": \"London\",\n \"what3words\": \"spark.dizzy.ramp\"\n },\n \"contact\": {\n \"landline\": \"020 3728 5000\",\n \"mobile\": \"07700 900456\"\n },\n \"personal\": {\n \"dob\": \"1985-06-15T00:00:00.000Z\",\n \"first_name\": \"Charlotte\",\n \"last_name\": \"Thompson\"\n },\n \"settings\": {\n \"preferred_language\": \"en-GB\",\n \"timezone\": \"Europe/London\"\n },\n \"work\": {\n \"cscs\": \"GBCSCS789\",\n \"eusr\": \"GBEUSR012\",\n \"occupation\": \"Senior Software Engineer\",\n \"start_date\": \"2018-03-15T00:00:00.000Z\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.ctrl-hub.com/v3/users/{user_id}")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"attributes\": {\n \"profile\": {\n \"address\": {\n \"area\": \"Central London\",\n \"country_code\": \"GB\",\n \"county\": \"Greater London\",\n \"name\": \"The Shard\",\n \"number\": \"32A\",\n \"postcode\": \"SE1 9SG\",\n \"street\": \"London Bridge Street\",\n \"town\": \"London\",\n \"what3words\": \"spark.dizzy.ramp\"\n },\n \"contact\": {\n \"landline\": \"020 3728 5000\",\n \"mobile\": \"07700 900456\"\n },\n \"personal\": {\n \"dob\": \"1985-06-15T00:00:00.000Z\",\n \"first_name\": \"Charlotte\",\n \"last_name\": \"Thompson\"\n },\n \"settings\": {\n \"preferred_language\": \"en-GB\",\n \"timezone\": \"Europe/London\"\n },\n \"work\": {\n \"cscs\": \"GBCSCS789\",\n \"eusr\": \"GBEUSR012\",\n \"occupation\": \"Senior Software Engineer\",\n \"start_date\": \"2018-03-15T00:00:00.000Z\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/users/{user_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"type\": \"<string>\",\n \"attributes\": {\n \"profile\": {\n \"address\": {\n \"area\": \"Central London\",\n \"country_code\": \"GB\",\n \"county\": \"Greater London\",\n \"name\": \"The Shard\",\n \"number\": \"32A\",\n \"postcode\": \"SE1 9SG\",\n \"street\": \"London Bridge Street\",\n \"town\": \"London\",\n \"what3words\": \"spark.dizzy.ramp\"\n },\n \"contact\": {\n \"landline\": \"020 3728 5000\",\n \"mobile\": \"07700 900456\"\n },\n \"personal\": {\n \"dob\": \"1985-06-15T00:00:00.000Z\",\n \"first_name\": \"Charlotte\",\n \"last_name\": \"Thompson\"\n },\n \"settings\": {\n \"preferred_language\": \"en-GB\",\n \"timezone\": \"Europe/London\"\n },\n \"work\": {\n \"cscs\": \"GBCSCS789\",\n \"eusr\": \"GBEUSR012\",\n \"occupation\": \"Senior Software Engineer\",\n \"start_date\": \"2018-03-15T00:00:00.000Z\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": {
"email": "jsmith@example.com",
"identities": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"platform": "<string>",
"meta": {}
}
],
"profile": {
"work": {
"occupation": "<string>",
"cscs": "<string>",
"eusr": "<string>",
"start_date": "2023-12-25"
},
"personal": {
"first_name": "<string>",
"last_name": "<string>",
"dob": "2023-12-25",
"username": "<string>"
},
"contact": {
"mobile": "<string>",
"landline": "<string>"
},
"address": {
"number": "",
"street": "<string>",
"area": "<string>",
"town": "<string>",
"county": "<string>",
"postcode": "<string>",
"country_code": "<string>",
"what3words": "<string>"
},
"settings": {
"preferred_language": "en-GB",
"timezone": "<string>"
}
}
},
"meta": {},
"relationships": {
"organisations": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"teams": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"managing_organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
}
}
},
"jsonapi": {
"version": "<string>"
},
"included": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": {
"name": "<string>",
"slug": "<string>",
"sandbox": true,
"description": "<string>",
"settings": {
"teams": {
"customer_representatives": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
}
},
"meta": {
"v3": true,
"status": "active",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"features": [
{
"name": "<string>",
"enabled": true,
"limit": 123
}
]
},
"relationships": {
"users": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"service_accounts": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"groups": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"teams": {
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
]
},
"nomenclature": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
}
}
}
]
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Authorizations
SessionOAuth2Cookie
Session token for authentication.
Path Parameters
The unique identifier for the user.
Body
application/vnd.api+json
The user profile to update.
Show child attributes
Show child attributes
⌘I