Update an organization

POST

orgs

update

curl --request POST \
  --url https://{host}/v1/orgs/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
  "display_name": "Acme Corporation"
}
'

import requests

url = "https://{host}/v1/orgs/update"

payload = {
    "org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
    "display_name": "Acme Corporation"
}
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({
    org_id: '2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f',
    display_name: 'Acme Corporation'
  })
};

fetch('https://{host}/v1/orgs/update', 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/orgs/update",
  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([
    'org_id' => '2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f',
    'display_name' => 'Acme Corporation'
  ]),
  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/orgs/update"

	payload := strings.NewReader("{\n  \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\",\n  \"display_name\": \"Acme Corporation\"\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/orgs/update")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\",\n  \"display_name\": \"Acme Corporation\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/orgs/update")

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  \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\",\n  \"display_name\": \"Acme Corporation\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "updated": true
  }
}

Authorizations

Authorization

string

header

required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Body

application/json

org_id

string<uuid>

required

Org UUID

display_name

string

Human-readable org name

Minimum string length: 1

owner_id

string<uuid>

Active member to make an owner of the org (site admin or an existing owner only). Orgs may have several owners; the first one becomes the org\

Response

Success.

enum<boolean>

required

Always true on success.

Available options:

true

data

object

required

Show child attributes

Update an organization

curl --request POST \
  --url https://{host}/v1/orgs/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
  "display_name": "Acme Corporation"
}
'

import requests

url = "https://{host}/v1/orgs/update"

payload = {
    "org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
    "display_name": "Acme Corporation"
}
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({
    org_id: '2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f',
    display_name: 'Acme Corporation'
  })
};

fetch('https://{host}/v1/orgs/update', 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/orgs/update",
  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([
    'org_id' => '2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f',
    'display_name' => 'Acme Corporation'
  ]),
  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/orgs/update"

	payload := strings.NewReader("{\n  \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\",\n  \"display_name\": \"Acme Corporation\"\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/orgs/update")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\",\n  \"display_name\": \"Acme Corporation\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/orgs/update")

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  \"org_id\": \"2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f\",\n  \"display_name\": \"Acme Corporation\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "updated": true
  }
}

Introduction

System

Auth

Users

Organizations

Invitations

Teams

Realms

Daemons

Workspaces

Runs

Artifacts

Events

Reviews

Notification channels

Notifications

Agents

Settings

Mesh

Jira

A2A

Update an organization

Authorizations

Body

Response