Update Group

PUT

groups

{id}

Update Group

curl --request PUT \
  --url https://public.api.serval.com/v2/groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "userIds": [
    "<string>"
  ],
  "members": {
    "userIds": [
      "<string>"
    ]
  },
  "scopedId": "<string>",
  "teamId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/groups/{id}"

payload = {
    "name": "<string>",
    "userIds": ["<string>"],
    "members": { "userIds": ["<string>"] },
    "scopedId": "<string>",
    "teamId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    userIds: ['<string>'],
    members: {userIds: ['<string>']},
    scopedId: '<string>',
    teamId: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/groups/{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://public.api.serval.com/v2/groups/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'userIds' => [
        '<string>'
    ],
    'members' => [
        'userIds' => [
                '<string>'
        ]
    ],
    'scopedId' => '<string>',
    'teamId' => '<string>'
  ]),
  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://public.api.serval.com/v2/groups/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"members\": {\n    \"userIds\": [\n      \"<string>\"\n    ]\n  },\n  \"scopedId\": \"<string>\",\n  \"teamId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/groups/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"members\": {\n    \"userIds\": [\n      \"<string>\"\n    ]\n  },\n  \"scopedId\": \"<string>\",\n  \"teamId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/groups/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"members\": {\n    \"userIds\": [\n      \"<string>\"\n    ]\n  },\n  \"scopedId\": \"<string>\",\n  \"teamId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "organizationId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "deletedAt": "2025-01-15T01:30:15.000Z",
    "userIds": [
      "<string>"
    ],
    "managerTeamIds": [
      "<string>"
    ],
    "scopedId": "<string>",
    "externallyManaged": true,
    "configurationTeamId": "<string>"
  }
}

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key or Workspace-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.

Credential	Access requirements
Organization-scoped API key	Manage an organization-wide group: `groups:manage` Manage a restricted group, Manage a group your workspace manages: Unsupported
Workspace-scoped API key	Manage an organization-wide group, Manage a restricted group: Unsupported Manage a group your workspace manages: `groups:manage`
User-based token (OAuth)	Manage an organization-wide group, Manage a restricted group: Supported, subject to permissions Manage a group your workspace manages: Unsupported

Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.

Manage a restricted group: A second check requires a user owner, an organization-admin user, or permission to manage groups on a manager workspace. Organization-scoped API keys cannot manage restricted groups.
Manage a group your workspace manages: A workspace-scoped key can change only groups managed by a workspace it allows, never organization-wide groups. A synced group cannot be renamed or have its members replaced, and members must be people rather than agent identities. Changing scoped_id requires the group to be configured for a workspace the key allows. A workspace-scoped key cannot replace the members of a group that grants a workspace role. The key must hold groups:manage; a full-access workspace key cannot.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Body

application/json

name

string | null

userIds

string[]

members

members · object

Show child attributes

scopedId

string | null

teamId

string | null

Response

200 - application/json

Success

data

data · object

Show child attributes

Update Group

curl --request PUT \
  --url https://public.api.serval.com/v2/groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "userIds": [
    "<string>"
  ],
  "members": {
    "userIds": [
      "<string>"
    ]
  },
  "scopedId": "<string>",
  "teamId": "<string>"
}
'

import requests

url = "https://public.api.serval.com/v2/groups/{id}"

payload = {
    "name": "<string>",
    "userIds": ["<string>"],
    "members": { "userIds": ["<string>"] },
    "scopedId": "<string>",
    "teamId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    userIds: ['<string>'],
    members: {userIds: ['<string>']},
    scopedId: '<string>',
    teamId: '<string>'
  })
};

fetch('https://public.api.serval.com/v2/groups/{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://public.api.serval.com/v2/groups/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'userIds' => [
        '<string>'
    ],
    'members' => [
        'userIds' => [
                '<string>'
        ]
    ],
    'scopedId' => '<string>',
    'teamId' => '<string>'
  ]),
  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://public.api.serval.com/v2/groups/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"members\": {\n    \"userIds\": [\n      \"<string>\"\n    ]\n  },\n  \"scopedId\": \"<string>\",\n  \"teamId\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://public.api.serval.com/v2/groups/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"members\": {\n    \"userIds\": [\n      \"<string>\"\n    ]\n  },\n  \"scopedId\": \"<string>\",\n  \"teamId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public.api.serval.com/v2/groups/{id}")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"userIds\": [\n    \"<string>\"\n  ],\n  \"members\": {\n    \"userIds\": [\n      \"<string>\"\n    ]\n  },\n  \"scopedId\": \"<string>\",\n  \"teamId\": \"<string>\"\n}"

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

{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "organizationId": "<string>",
    "createdAt": "2025-01-15T01:30:15.000Z",
    "deletedAt": "2025-01-15T01:30:15.000Z",
    "userIds": [
      "<string>"
    ],
    "managerTeamIds": [
      "<string>"
    ],
    "scopedId": "<string>",
    "externallyManaged": true,
    "configurationTeamId": "<string>"
  }
}

Get started

Authentication

Endpoints

Development

Authentication and permissions

Authorizations

Path Parameters

Body

Response

​Authentication and permissions

Authorizations

Path Parameters

Body

Response

Authentication and permissions