Delete a group

Client version1.8.0 (latest)1.7.0Version overview

DELETE

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

Delete a regular group in the current team. The default group cannot be deleted. If the group contains browser profiles, the Local API moves them to the default group before deleting it.

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

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 DELETE -H 'Authorization: Bearer <TOKEN>' 'http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890'

fetch("http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890", {
  method: "DELETE",
  headers: {
      "Authorization": "Bearer <TOKEN>"
    },
})
  .then((response) => response.json())
  .then((data) => console.log(data))

async function main(): Promise<void> {
  const options: RequestInit = {
    "method": "DELETE",
    "headers": {
      "Authorization": "Bearer <TOKEN>"
    }
  }
  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 => 'DELETE',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <TOKEN>',
  ],
]);

$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"
)

func main() {
	req, err := http.NewRequest("DELETE", "http://local.zhongyibrowser.com:39025/api/v1/groups/group_01JABCDEF1234567890", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("Authorization", "Bearer <TOKEN>")

	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 {
    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>")
        .method("DELETE", HttpRequest.BodyPublishers.noBody())
        .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>"
}

response = requests.delete(url, headers=headers)
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.

Group deletion result

Body

Response content typeapplication/jsonGroupDeleteSuccessResponse

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": "group_01JABCDEF1234567890",
    "status": "deleted",
    "moved_browser_count": 0,
    "moved_to_default_group": {
      "id": "string",
      "name": "string"
    }
  }
}

View all business error codes and HTTP statuses