Update TeamMember
curl --request PUT \
--url https://platform.kodexa.ai/api/team-members/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"team": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"organization": {
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000",
"archived": true
},
"organizationId": "<string>",
"searchText": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"teamId": "<string>",
"user": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"invited": true,
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userHash": "<string>",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"userId": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/team-members/{id}"
payload = {
"changeSequence": 123,
"team": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"organization": {
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000",
"archived": True
},
"organizationId": "<string>",
"searchText": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"teamId": "<string>",
"user": {
"active": True,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"invited": True,
"isExternallyManaged": True,
"lastName": "<string>",
"preferences": {
"showOnboarding": True,
"showScrollbars": True,
"showWelcomeMessage": True
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": { "roles": ["<string>"] },
"showDeveloperTools": True,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userHash": "<string>",
"userStorage": { "favoriteLinks": [{ "link": "<string>" }] },
"userType": "<string>",
"uuid": "<string>"
},
"userId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeSequence: 123,
team: {
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
description: '<string>',
id: '<string>',
name: '<string>',
organization: {
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000',
archived: true
},
organizationId: '<string>',
searchText: '<string>',
slug: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
},
teamId: '<string>',
user: {
active: true,
bio: '<string>',
businessGroup: '<string>',
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
email: '<string>',
firstName: '<string>',
groupsJson: '<string>',
id: '<string>',
image: '<string>',
invited: true,
isExternallyManaged: true,
lastName: '<string>',
preferences: {showOnboarding: true, showScrollbars: true, showWelcomeMessage: true},
rolesJson: '<string>',
searchText: '<string>',
security: {roles: ['<string>']},
showDeveloperTools: true,
title: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
userHash: '<string>',
userStorage: {favoriteLinks: [{link: '<string>'}]},
userType: '<string>',
uuid: '<string>'
},
userId: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/team-members/{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://platform.kodexa.ai/api/team-members/{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([
'changeSequence' => 123,
'team' => [
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'id' => '<string>',
'name' => '<string>',
'organization' => [
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000',
'archived' => true
],
'organizationId' => '<string>',
'searchText' => '<string>',
'slug' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
],
'teamId' => '<string>',
'user' => [
'active' => true,
'bio' => '<string>',
'businessGroup' => '<string>',
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'email' => '<string>',
'firstName' => '<string>',
'groupsJson' => '<string>',
'id' => '<string>',
'image' => '<string>',
'invited' => true,
'isExternallyManaged' => true,
'lastName' => '<string>',
'preferences' => [
'showOnboarding' => true,
'showScrollbars' => true,
'showWelcomeMessage' => true
],
'rolesJson' => '<string>',
'searchText' => '<string>',
'security' => [
'roles' => [
'<string>'
]
],
'showDeveloperTools' => true,
'title' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'userHash' => '<string>',
'userStorage' => [
'favoriteLinks' => [
[
'link' => '<string>'
]
]
],
'userType' => '<string>',
'uuid' => '<string>'
],
'userId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://platform.kodexa.ai/api/team-members/{id}"
payload := strings.NewReader("{\n \"changeSequence\": 123,\n \"team\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"organization\": {\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\",\n \"archived\": true\n },\n \"organizationId\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"invited\": true,\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userHash\": \"<string>\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<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("https://platform.kodexa.ai/api/team-members/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"team\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"organization\": {\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\",\n \"archived\": true\n },\n \"organizationId\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"invited\": true,\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userHash\": \"<string>\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/team-members/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changeSequence\": 123,\n \"team\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"organization\": {\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\",\n \"archived\": true\n },\n \"organizationId\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"invited\": true,\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userHash\": \"<string>\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"teamId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userId": "<string>",
"uuid": "<string>",
"team": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"organization": {
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000",
"archived": true
},
"organizationId": "<string>",
"searchText": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"user": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"invited": true,
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userHash": "<string>",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
}
}Team Members
Update TeamMember
Updates an existing TeamMember. Team members represent users assigned to teams.
PUT
/
api
/
team-members
/
{id}
Update TeamMember
curl --request PUT \
--url https://platform.kodexa.ai/api/team-members/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"team": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"organization": {
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000",
"archived": true
},
"organizationId": "<string>",
"searchText": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"teamId": "<string>",
"user": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"invited": true,
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userHash": "<string>",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"userId": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/team-members/{id}"
payload = {
"changeSequence": 123,
"team": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"organization": {
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000",
"archived": True
},
"organizationId": "<string>",
"searchText": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"teamId": "<string>",
"user": {
"active": True,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"invited": True,
"isExternallyManaged": True,
"lastName": "<string>",
"preferences": {
"showOnboarding": True,
"showScrollbars": True,
"showWelcomeMessage": True
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": { "roles": ["<string>"] },
"showDeveloperTools": True,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userHash": "<string>",
"userStorage": { "favoriteLinks": [{ "link": "<string>" }] },
"userType": "<string>",
"uuid": "<string>"
},
"userId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeSequence: 123,
team: {
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
description: '<string>',
id: '<string>',
name: '<string>',
organization: {
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000',
archived: true
},
organizationId: '<string>',
searchText: '<string>',
slug: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
},
teamId: '<string>',
user: {
active: true,
bio: '<string>',
businessGroup: '<string>',
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
email: '<string>',
firstName: '<string>',
groupsJson: '<string>',
id: '<string>',
image: '<string>',
invited: true,
isExternallyManaged: true,
lastName: '<string>',
preferences: {showOnboarding: true, showScrollbars: true, showWelcomeMessage: true},
rolesJson: '<string>',
searchText: '<string>',
security: {roles: ['<string>']},
showDeveloperTools: true,
title: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
userHash: '<string>',
userStorage: {favoriteLinks: [{link: '<string>'}]},
userType: '<string>',
uuid: '<string>'
},
userId: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/team-members/{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://platform.kodexa.ai/api/team-members/{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([
'changeSequence' => 123,
'team' => [
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'description' => '<string>',
'id' => '<string>',
'name' => '<string>',
'organization' => [
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000',
'archived' => true
],
'organizationId' => '<string>',
'searchText' => '<string>',
'slug' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
],
'teamId' => '<string>',
'user' => [
'active' => true,
'bio' => '<string>',
'businessGroup' => '<string>',
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'email' => '<string>',
'firstName' => '<string>',
'groupsJson' => '<string>',
'id' => '<string>',
'image' => '<string>',
'invited' => true,
'isExternallyManaged' => true,
'lastName' => '<string>',
'preferences' => [
'showOnboarding' => true,
'showScrollbars' => true,
'showWelcomeMessage' => true
],
'rolesJson' => '<string>',
'searchText' => '<string>',
'security' => [
'roles' => [
'<string>'
]
],
'showDeveloperTools' => true,
'title' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'userHash' => '<string>',
'userStorage' => [
'favoriteLinks' => [
[
'link' => '<string>'
]
]
],
'userType' => '<string>',
'uuid' => '<string>'
],
'userId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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://platform.kodexa.ai/api/team-members/{id}"
payload := strings.NewReader("{\n \"changeSequence\": 123,\n \"team\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"organization\": {\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\",\n \"archived\": true\n },\n \"organizationId\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"invited\": true,\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userHash\": \"<string>\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<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("https://platform.kodexa.ai/api/team-members/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"team\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"organization\": {\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\",\n \"archived\": true\n },\n \"organizationId\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"invited\": true,\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userHash\": \"<string>\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/team-members/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changeSequence\": 123,\n \"team\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"organization\": {\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\",\n \"archived\": true\n },\n \"organizationId\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"teamId\": \"<string>\",\n \"user\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"invited\": true,\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userHash\": \"<string>\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"userId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"teamId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userId": "<string>",
"uuid": "<string>",
"team": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"id": "<string>",
"name": "<string>",
"organization": {
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000",
"archived": true
},
"organizationId": "<string>",
"searchText": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"user": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"invited": true,
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userHash": "<string>",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
}
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Path Parameters
Unique identifier (UUID) of the resource.
Body
application/json
A team member represents a user's membership in a team.
Response
Updated TeamMember
A team member represents a user's membership in a team.
A team groups users together for collaborative access control within projects.
Show child attributes
Show child attributes
A platform user represents a user account in the Kodexa platform.
Show child attributes
Show child attributes