Update team metadata
curl --request PUT \
--url https://api.getcortexapp.com/api/v1/teams/{tagOrId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cortexTeam": {
"members": [
{
"email": "<string>",
"name": "<string>",
"notificationsEnabled": true,
"roles": [
{
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
],
"description": "<string>",
"role": {
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
}
]
},
"type": "<string>",
"links": [
{
"name": "<string>",
"type": "<string>",
"url": "<string>",
"description": "<string>"
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"summary": "<string>"
},
"slackChannels": [
{
"name": "<string>",
"notificationsEnabled": true,
"description": "<string>"
}
]
}
'import requests
url = "https://api.getcortexapp.com/api/v1/teams/{tagOrId}"
payload = {
"cortexTeam": { "members": [
{
"email": "<string>",
"name": "<string>",
"notificationsEnabled": True,
"roles": [
{
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
],
"description": "<string>",
"role": {
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
}
] },
"type": "<string>",
"links": [
{
"name": "<string>",
"type": "<string>",
"url": "<string>",
"description": "<string>"
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"summary": "<string>"
},
"slackChannels": [
{
"name": "<string>",
"notificationsEnabled": True,
"description": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cortexTeam: {
members: [
{
email: '<string>',
name: '<string>',
notificationsEnabled: true,
roles: [{tag: '<string>', type: '<string>', source: '<string>'}],
description: '<string>',
role: {tag: '<string>', type: '<string>', source: '<string>'}
}
]
},
type: '<string>',
links: [{name: '<string>', type: '<string>', url: '<string>', description: '<string>'}],
metadata: {name: '<string>', description: '<string>', summary: '<string>'},
slackChannels: [{name: '<string>', notificationsEnabled: true, description: '<string>'}]
})
};
fetch('https://api.getcortexapp.com/api/v1/teams/{tagOrId}', 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.getcortexapp.com/api/v1/teams/{tagOrId}",
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([
'cortexTeam' => [
'members' => [
[
'email' => '<string>',
'name' => '<string>',
'notificationsEnabled' => true,
'roles' => [
[
'tag' => '<string>',
'type' => '<string>',
'source' => '<string>'
]
],
'description' => '<string>',
'role' => [
'tag' => '<string>',
'type' => '<string>',
'source' => '<string>'
]
]
]
],
'type' => '<string>',
'links' => [
[
'name' => '<string>',
'type' => '<string>',
'url' => '<string>',
'description' => '<string>'
]
],
'metadata' => [
'name' => '<string>',
'description' => '<string>',
'summary' => '<string>'
],
'slackChannels' => [
[
'name' => '<string>',
'notificationsEnabled' => true,
'description' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://api.getcortexapp.com/api/v1/teams/{tagOrId}"
payload := strings.NewReader("{\n \"cortexTeam\": {\n \"members\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"roles\": [\n {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"role\": {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"type\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary\": \"<string>\"\n },\n \"slackChannels\": [\n {\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"description\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.getcortexapp.com/api/v1/teams/{tagOrId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cortexTeam\": {\n \"members\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"roles\": [\n {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"role\": {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"type\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary\": \"<string>\"\n },\n \"slackChannels\": [\n {\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"description\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcortexapp.com/api/v1/teams/{tagOrId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cortexTeam\": {\n \"members\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"roles\": [\n {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"role\": {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"type\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary\": \"<string>\"\n },\n \"slackChannels\": [\n {\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"description\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"cortexTeam": {
"members": [
{
"email": "<string>",
"name": "<string>",
"notificationsEnabled": true,
"roles": [
{
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
],
"description": "<string>",
"role": {
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
}
]
},
"catalogEntityTag": "<string>",
"id": "<string>",
"isArchived": true,
"links": [
{
"name": "<string>",
"type": "<string>",
"url": "<string>",
"description": "<string>"
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"summary": "<string>"
},
"slackChannels": [
{
"name": "<string>",
"notificationsEnabled": true,
"description": "<string>"
}
],
"teamTag": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "INTEGRATION_MISSING",
"details": "<string>",
"errorCode": "<string>",
"gatewayHttpStatus": 123,
"httpStatus": 123,
"requestId": "<string>"
}{
"message": "<string>",
"type": "INTEGRATION_MISSING",
"details": "<string>",
"errorCode": "<string>",
"gatewayHttpStatus": 123,
"httpStatus": 123,
"requestId": "<string>"
}{
"status": 429,
"title": "<string>",
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"retryAfter": 1
}Update team metadata
PUT
/
api
/
v1
/
teams
/
{tagOrId}
Update team metadata
curl --request PUT \
--url https://api.getcortexapp.com/api/v1/teams/{tagOrId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cortexTeam": {
"members": [
{
"email": "<string>",
"name": "<string>",
"notificationsEnabled": true,
"roles": [
{
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
],
"description": "<string>",
"role": {
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
}
]
},
"type": "<string>",
"links": [
{
"name": "<string>",
"type": "<string>",
"url": "<string>",
"description": "<string>"
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"summary": "<string>"
},
"slackChannels": [
{
"name": "<string>",
"notificationsEnabled": true,
"description": "<string>"
}
]
}
'import requests
url = "https://api.getcortexapp.com/api/v1/teams/{tagOrId}"
payload = {
"cortexTeam": { "members": [
{
"email": "<string>",
"name": "<string>",
"notificationsEnabled": True,
"roles": [
{
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
],
"description": "<string>",
"role": {
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
}
] },
"type": "<string>",
"links": [
{
"name": "<string>",
"type": "<string>",
"url": "<string>",
"description": "<string>"
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"summary": "<string>"
},
"slackChannels": [
{
"name": "<string>",
"notificationsEnabled": True,
"description": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cortexTeam: {
members: [
{
email: '<string>',
name: '<string>',
notificationsEnabled: true,
roles: [{tag: '<string>', type: '<string>', source: '<string>'}],
description: '<string>',
role: {tag: '<string>', type: '<string>', source: '<string>'}
}
]
},
type: '<string>',
links: [{name: '<string>', type: '<string>', url: '<string>', description: '<string>'}],
metadata: {name: '<string>', description: '<string>', summary: '<string>'},
slackChannels: [{name: '<string>', notificationsEnabled: true, description: '<string>'}]
})
};
fetch('https://api.getcortexapp.com/api/v1/teams/{tagOrId}', 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.getcortexapp.com/api/v1/teams/{tagOrId}",
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([
'cortexTeam' => [
'members' => [
[
'email' => '<string>',
'name' => '<string>',
'notificationsEnabled' => true,
'roles' => [
[
'tag' => '<string>',
'type' => '<string>',
'source' => '<string>'
]
],
'description' => '<string>',
'role' => [
'tag' => '<string>',
'type' => '<string>',
'source' => '<string>'
]
]
]
],
'type' => '<string>',
'links' => [
[
'name' => '<string>',
'type' => '<string>',
'url' => '<string>',
'description' => '<string>'
]
],
'metadata' => [
'name' => '<string>',
'description' => '<string>',
'summary' => '<string>'
],
'slackChannels' => [
[
'name' => '<string>',
'notificationsEnabled' => true,
'description' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "https://api.getcortexapp.com/api/v1/teams/{tagOrId}"
payload := strings.NewReader("{\n \"cortexTeam\": {\n \"members\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"roles\": [\n {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"role\": {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"type\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary\": \"<string>\"\n },\n \"slackChannels\": [\n {\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"description\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.getcortexapp.com/api/v1/teams/{tagOrId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cortexTeam\": {\n \"members\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"roles\": [\n {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"role\": {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"type\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary\": \"<string>\"\n },\n \"slackChannels\": [\n {\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"description\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcortexapp.com/api/v1/teams/{tagOrId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cortexTeam\": {\n \"members\": [\n {\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"roles\": [\n {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"role\": {\n \"tag\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\"\n }\n }\n ]\n },\n \"type\": \"<string>\",\n \"links\": [\n {\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"url\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"metadata\": {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"summary\": \"<string>\"\n },\n \"slackChannels\": [\n {\n \"name\": \"<string>\",\n \"notificationsEnabled\": true,\n \"description\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"cortexTeam": {
"members": [
{
"email": "<string>",
"name": "<string>",
"notificationsEnabled": true,
"roles": [
{
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
],
"description": "<string>",
"role": {
"tag": "<string>",
"type": "<string>",
"source": "<string>"
}
}
]
},
"catalogEntityTag": "<string>",
"id": "<string>",
"isArchived": true,
"links": [
{
"name": "<string>",
"type": "<string>",
"url": "<string>",
"description": "<string>"
}
],
"metadata": {
"name": "<string>",
"description": "<string>",
"summary": "<string>"
},
"slackChannels": [
{
"name": "<string>",
"notificationsEnabled": true,
"description": "<string>"
}
],
"teamTag": "<string>",
"type": "<string>"
}{
"message": "<string>",
"type": "INTEGRATION_MISSING",
"details": "<string>",
"errorCode": "<string>",
"gatewayHttpStatus": 123,
"httpStatus": 123,
"requestId": "<string>"
}{
"message": "<string>",
"type": "INTEGRATION_MISSING",
"details": "<string>",
"errorCode": "<string>",
"gatewayHttpStatus": 123,
"httpStatus": 123,
"requestId": "<string>"
}{
"status": 429,
"title": "<string>",
"type": "<string>",
"detail": "<string>",
"instance": "<string>",
"retryAfter": 1
}Authorizations
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Path Parameters
The tag (x-cortex-tag) or unique, auto-generated identifier (CID) for the entity. If the tag contains forward slashes, URL-encode each / as %2F. The tag is matched exactly as encoded, including leading, trailing, and consecutive slashes, which are preserved and not collapsed (for example, the tag /services/payments-api is referenced as %2Fservices%2Fpayments-api). Tags containing slashes are supported via the API but not in the Cortex UI; this difference is expected.
Entity identifier - can be a tag or CID
Body
application/json
- CORTEX
- IDP
Use this request shape when updating a team entry whose memberships are manually maintained via API or the UI.
Response
Successfully updated team
- CORTEX
- IDP
Last modified on September 24, 2026