Move browser profiles to a group

Client version1.8.0 (latest)1.7.0Version overview

POST

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

Move browser profiles to the specified group. The Local API first verifies that the target group and profiles belong to the current user and team. Profiles that do not exist or are inaccessible are reported as individual failures.

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/jsonGroupMoveBrowsersRequest

Fields

›string[]required

Profile IDs to move to this group. Duplicate values are processed only once.

minItems: 1maxItems: 100

Each array item:

Unique browser profile ID

Example"env_01JABCDEF1234567890"

minLength: 1

Example

Generated from the schema; not a live response.

{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}

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 POST -H 'Authorization: Bearer <TOKEN>' -H 'Content-Type: application/json' -d '{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}' 'http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890/browsers'

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

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "POST",
    "headers": {
      "Authorization": "Bearer <TOKEN>",
      "Content-Type": "application/json"
    },
    "body": "{\n  \"env_ids\": [\n    \"env_01JABCDEF1234567890\"\n  ]\n}"
  }
  const response: Response = await fetch("http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890/browsers", 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/browsers');
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
    'Content-Type: application/json',
  ],
  CURLOPT_POSTFIELDS => '{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}',
]);

$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("POST", "http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890/browsers", strings.NewReader(`{
  "env_ids": [
    "env_01JABCDEF1234567890"
  ]
}`))
	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" +
        "  \"env_ids\": [\n" +
        "    \"env_01JABCDEF1234567890\"\n" +
        "  ]\n" +
        "}";
    HttpClient client = HttpClient.newHttpClient();
    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890/browsers"))
        .header("Authorization", "Bearer <TOKEN>")
        .header("Content-Type", "application/json")
        .method("POST", 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/browsers"
headers = {
    "Authorization": "Bearer <TOKEN>",
    "Content-Type": "application/json"
}
data = "{\n  \"env_ids\": [\n    \"env_01JABCDEF1234567890\"\n  ]\n}"

response = requests.post(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.

Individual profile move results

Body

Response content typeapplication/jsonGroupMoveBrowsersSuccessResponse

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": {
    "group": {
      "id": "string",
      "name": "string"
    },
    "total": 0,
    "success_count": 0,
    "failed_count": 0,
    "items": [
      {
        "env_id": "env_01JABCDEF1234567890",
        "success": true,
        "data": {
          "group": {
            "id": "string",
            "name": "string"
          }
        }
      }
    ]
  }
}

View all business error codes and HTTP statuses