Update a group

Client version1.8.0 (latest)1.7.0Version overview

PUT

Example base URLhttp://local.zhongyibrowser.com:39025http://127.0.0.1:39025/api/v1/groups/{group_id}

Update the name and notes of a regular group in the current team. The default group cannot be modified through the Local API.

Request parameters

Authorization Bearer Token

Include your API Key as a Bearer token in the Authorization request header.

Authorization: Bearer <api-key>

Path parameters

1

Fields

›stringrequired

Unique profile group ID

Example"group_01JABCDEF1234567890"

minLength: 1

Body parameters

requiredRequest content typeapplication/jsonGroupMutationRequest

Fields

›stringrequired

Group name, unique within the current team

minLength: 1maxLength: 64

›string | null

Group notes

maxLength: 500

Example

Generated from the schema; not a live response.

{
  "name": "string"
}

Request code examples

JavaScript / TypeScript: Node.js 18+ with fetch; PHP: cURL extension; Go: 1.16+; Java: JDK 11+. Replace the token and example parameter values before running.

curl -X PUT -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "name": "string"
}' 'http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890'

fetch("http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890", {
  method: "PUT",
  headers: {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
  body: "{\n  \"name\": \"string\"\n}",
})
  .then((response) => response.json())
  .then((data) => console.log(data))

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "PUT",
    "headers": {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
    "body": "{\n  \"name\": \"string\"\n}"
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890", options)
  const data: unknown = await response.json()
  console.log(data)
}

main().catch(console.error)

<?php
$ch = curl_init('http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "name": "string"
}',
]);

$response = curl_exec($ch);
if ($response === false) {
  throw new RuntimeException(curl_error($ch));
}
curl_close($ch);
echo $response . PHP_EOL;

package main

import (
	"fmt"
	"io"
	"log"
	"net/http"
	"strings"
)

func main() {
	req, err := http.NewRequest("PUT", "http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890", strings.NewReader(`{
  "name": "string"
}`))
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "Bearer <TOKEN>")
	req.Header.Set("Content-Type", "application/json")

	response, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer response.Body.Close()

	data, err := io.ReadAll(response.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
  public static void main(String[] args) throws Exception {
    String body = "{\n" +
        "  \"name\": \"string\"\n" +
        "}";
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890"))
        .header("Authorization", "Bearer <TOKEN>")
        .header("Content-Type", "application/json")
        .method("PUT", HttpRequest.BodyPublishers.ofString(body))
        .build();

    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  }
}

import requests

url = "http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"name\": \"string\"\n}"

response = requests.put(url, headers=headers, data=data)
print(response.json())

Responses

Success: code = 0. Failure: code > 0. Select a status to view its fields and example. Expand objects to inspect nested fields. Optional fields may be omitted.

Updated group details

Body

Response content typeapplication/jsonGroupDetailSuccessResponse

Fields

›numberrequired

Business status code; always 0 on success

Enum

›stringrequired

Business status message; always success on success

Enum

›objectrequired

Endpoint business data

Additional fields are not allowed.

Example

Generated from the schema; not a live response.

{
  "code": 0,
  "message": "success",
  "data": {
    "id": "group_01JABCDEF1234567890",
    "name": "string",
    "remark": "string",
    "is_default": true,
    "browser_count": 0,
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "browsers": [
      {
        "env_id": "env_01JABCDEF1234567890",
        "env_sn": "string",
        "env_name": "string",
        "remark": "string"
      }
    ]
  }
}

View all business error codes and HTTP statuses