Update user group

Update an existing user group. See User Groups.

PATCH /userGroups/{id}

Update user group

cURL

curl --request PATCH \
  --url https://api.galtea.ai/userGroups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "Example Name"
}
'

import requests

url = "https://api.galtea.ai/userGroups/{id}"

payload = {
    "name": "<string>",
    "description": "Example Name"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', description: 'Example Name'})
};

fetch('https://api.galtea.ai/userGroups/{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.galtea.ai/userGroups/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => 'Example Name'
  ]),
  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.galtea.ai/userGroups/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"Example Name\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.galtea.ai/userGroups/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"Example Name\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galtea.ai/userGroups/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"Example Name\"\n}"

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

200

{
  "id": "ug_123",
  "organizationId": "org_123",
  "name": "QA Team",
  "type": "EVALUATOR",
  "description": "Quality assurance team",
  "createdAt": "2023-11-07T05:31:56Z",
  "userIds": [
    "user_123"
  ],
  "metricIds": [
    "metric_123"
  ]
}

{
  "error": "Error type",
  "message": "Error message description"
}

{
  "error": "Error type",
  "message": "Error message description"
}

Authorizations

Authorization · string · header · required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Path Parameters

id · string · required

User group ID

Body

application/json

name · string

description · string

Example:

"Example Name"

Response

200

application/json

User group updated successfully

id · string

Example:

"ug_123"

organizationId · string

Example:

"org_123"

name · string

Example:

"QA Team"

type · enum<string>

Available options: EVALUATOR

Example:

"EVALUATOR"

description · string | null

Example:

"Quality assurance team"

createdAt · string<date-time>

userIds · string[]

Example:

["user_123"]

metricIds · string[]

Example:

["metric_123"]