Rename a team
Renames a team within its scope. Installed copies and past runs keep working; the old name is free for reuse at once.
Requires a token whose user can see the team given by team_id or name: a public listed team, or a team of an organization you belong to.
POST
/
v1
/
teams
/
rename
Rename a team
curl --request POST \
--url https://{host}/v1/teams/rename \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": "acme",
"name": "code-review",
"new_name": "pr-review"
}
'import requests
url = "https://{host}/v1/teams/rename"
payload = {
"scope": "acme",
"name": "code-review",
"new_name": "pr-review"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({scope: 'acme', name: 'code-review', new_name: 'pr-review'})
};
fetch('https://{host}/v1/teams/rename', 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://{host}/v1/teams/rename",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scope' => 'acme',
'name' => 'code-review',
'new_name' => 'pr-review'
]),
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://{host}/v1/teams/rename"
payload := strings.NewReader("{\n \"scope\": \"acme\",\n \"name\": \"code-review\",\n \"new_name\": \"pr-review\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://{host}/v1/teams/rename")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"acme\",\n \"name\": \"code-review\",\n \"new_name\": \"pr-review\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/teams/rename")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": \"acme\",\n \"name\": \"code-review\",\n \"new_name\": \"pr-review\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
"name": "pr-review",
"scope": "acme"
}
}
Authorizations
User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).
Body
application/json
⌘I
Rename a team
curl --request POST \
--url https://{host}/v1/teams/rename \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scope": "acme",
"name": "code-review",
"new_name": "pr-review"
}
'import requests
url = "https://{host}/v1/teams/rename"
payload = {
"scope": "acme",
"name": "code-review",
"new_name": "pr-review"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({scope: 'acme', name: 'code-review', new_name: 'pr-review'})
};
fetch('https://{host}/v1/teams/rename', 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://{host}/v1/teams/rename",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'scope' => 'acme',
'name' => 'code-review',
'new_name' => 'pr-review'
]),
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://{host}/v1/teams/rename"
payload := strings.NewReader("{\n \"scope\": \"acme\",\n \"name\": \"code-review\",\n \"new_name\": \"pr-review\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://{host}/v1/teams/rename")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scope\": \"acme\",\n \"name\": \"code-review\",\n \"new_name\": \"pr-review\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/teams/rename")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"scope\": \"acme\",\n \"name\": \"code-review\",\n \"new_name\": \"pr-review\"\n}"
response = http.request(request)
puts response.read_body{
"ok": true,
"data": {
"id": "3f6c2a8e-6b1d-4c1e-9a57-0d2f4b8e91c4",
"name": "pr-review",
"scope": "acme"
}
}