Update group

curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/settings/v1/groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupName": "Engineering Team",
  "displayName": "Engineering Team",
  "isDeleted": false,
  "addParentGroupIds": [
    "uuid",
    "uuid"
  ],
  "removeParentGroupIds": [
    "uuid",
    "uuid"
  ],
  "legalName": "Engineering Department LLC",
  "address": {
    "street1": "123 Main Street",
    "street2": "Suite 100",
    "city": "New York",
    "state": "New York",
    "stateCode": "NY",
    "zipCode": "10001",
    "country": "United States",
    "countryCode": "US"
  }
}
'

import requests

url = "https://staging.api.us.aptlydone.com/settings/v1/groups/{id}"

payload = {
    "groupName": "Engineering Team",
    "displayName": "Engineering Team",
    "isDeleted": False,
    "addParentGroupIds": ["uuid", "uuid"],
    "removeParentGroupIds": ["uuid", "uuid"],
    "legalName": "Engineering Department LLC",
    "address": {
        "street1": "123 Main Street",
        "street2": "Suite 100",
        "city": "New York",
        "state": "New York",
        "stateCode": "NY",
        "zipCode": "10001",
        "country": "United States",
        "countryCode": "US"
    }
}
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({
    groupName: 'Engineering Team',
    displayName: 'Engineering Team',
    isDeleted: false,
    addParentGroupIds: ['uuid', 'uuid'],
    removeParentGroupIds: ['uuid', 'uuid'],
    legalName: 'Engineering Department LLC',
    address: {
      street1: '123 Main Street',
      street2: 'Suite 100',
      city: 'New York',
      state: 'New York',
      stateCode: 'NY',
      zipCode: '10001',
      country: 'United States',
      countryCode: 'US'
    }
  })
};

fetch('https://staging.api.us.aptlydone.com/settings/v1/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://staging.api.us.aptlydone.com/settings/v1/groups/{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([
    'groupName' => 'Engineering Team',
    'displayName' => 'Engineering Team',
    'isDeleted' => false,
    'addParentGroupIds' => [
        'uuid',
        'uuid'
    ],
    'removeParentGroupIds' => [
        'uuid',
        'uuid'
    ],
    'legalName' => 'Engineering Department LLC',
    'address' => [
        'street1' => '123 Main Street',
        'street2' => 'Suite 100',
        'city' => 'New York',
        'state' => 'New York',
        'stateCode' => 'NY',
        'zipCode' => '10001',
        'country' => 'United States',
        'countryCode' => 'US'
    ]
  ]),
  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://staging.api.us.aptlydone.com/settings/v1/groups/{id}"

	payload := strings.NewReader("{\n  \"groupName\": \"Engineering Team\",\n  \"displayName\": \"Engineering Team\",\n  \"isDeleted\": false,\n  \"addParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"removeParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"legalName\": \"Engineering Department LLC\",\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"street2\": \"Suite 100\",\n    \"city\": \"New York\",\n    \"state\": \"New York\",\n    \"stateCode\": \"NY\",\n    \"zipCode\": \"10001\",\n    \"country\": \"United States\",\n    \"countryCode\": \"US\"\n  }\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://staging.api.us.aptlydone.com/settings/v1/groups/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"groupName\": \"Engineering Team\",\n  \"displayName\": \"Engineering Team\",\n  \"isDeleted\": false,\n  \"addParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"removeParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"legalName\": \"Engineering Department LLC\",\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"street2\": \"Suite 100\",\n    \"city\": \"New York\",\n    \"state\": \"New York\",\n    \"stateCode\": \"NY\",\n    \"zipCode\": \"10001\",\n    \"country\": \"United States\",\n    \"countryCode\": \"US\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging.api.us.aptlydone.com/settings/v1/groups/{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  \"groupName\": \"Engineering Team\",\n  \"displayName\": \"Engineering Team\",\n  \"isDeleted\": false,\n  \"addParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"removeParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"legalName\": \"Engineering Department LLC\",\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"street2\": \"Suite 100\",\n    \"city\": \"New York\",\n    \"state\": \"New York\",\n    \"stateCode\": \"NY\",\n    \"zipCode\": \"10001\",\n    \"country\": \"United States\",\n    \"countryCode\": \"US\"\n  }\n}"

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

{
  "statusCode": 200,
  "timestamp": "2026-01-08T06:33:20.711Z",
  "message": "Success",
  "data": {
    "id": "3de3ba12-fe6e-4242-b2c2-57aa17d2b959",
    "tenantId": "9409925f-e386-428d-b82d-bc96fc7d785e",
    "groupId": "drDwrQ",
    "groupName": "Engineering Team",
    "createdOn": "2023-01-01T12:00:00Z",
    "updatedOn": "2023-01-15T12:00:00Z",
    "isSynced": false,
    "tenantGroupType": {
      "id": "6e606506-4c84-49a9-8abe-ce46d5b44e70",
      "groupTypeName": "Department",
      "shouldAllowEnableDisable": true,
      "isDefault": false
    },
    "isDeleted": false,
    "disableOption": "NA",
    "baseCurrency": "",
    "displayName": "Engineering Department",
    "legalName": "Engineering Department LLC",
    "externalId": "EXT-GROUP-12345",
    "instanceId": "02198055-706d-417d-9573-d376ced5c6f6",
    "address": {
      "id": "f2dfca59-4d8d-4636-a73b-41e97b3ba548",
      "groupId": "1cbaa43f-c81c-45e9-a0c4-31b632d0502b",
      "street1": "123 Main Street",
      "city": "New York",
      "state": "New York",
      "zipCode": "10001",
      "country": "United States",
      "createdOn": "2023-01-01T12:00:00Z",
      "updatedOn": "2023-01-15T12:00:00Z",
      "street2": "Suite 100",
      "stateCode": "NY",
      "countryCode": "US"
    },
    "parentGroups": [
      {
        "id": "f8e83c38-c408-46d0-8e10-a3bc01073a28",
        "parentId": "f3babb40-7bfa-4fc0-9942-4af717f25701",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "parentGroup": {
          "id": "e9db3b7c-e5cd-4ff4-9d6d-a6528ec04aa1",
          "tenantId": "56cdb45f-cd19-4be3-963c-2b4b4eb4529e",
          "groupId": "10000",
          "groupName": "Engineering Team",
          "displayName": "Engineering Team",
          "legalName": "Engineering Team",
          "tenantGroupType": {
            "id": "6414c9b4-72f9-4788-99da-976747a10992",
            "groupTypeName": "Department"
          }
        }
      }
    ],
    "decisionsCount": 25,
    "delegationsCount": 25
  }
}

PATCH

groups

{id}

Update group

curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/settings/v1/groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupName": "Engineering Team",
  "displayName": "Engineering Team",
  "isDeleted": false,
  "addParentGroupIds": [
    "uuid",
    "uuid"
  ],
  "removeParentGroupIds": [
    "uuid",
    "uuid"
  ],
  "legalName": "Engineering Department LLC",
  "address": {
    "street1": "123 Main Street",
    "street2": "Suite 100",
    "city": "New York",
    "state": "New York",
    "stateCode": "NY",
    "zipCode": "10001",
    "country": "United States",
    "countryCode": "US"
  }
}
'

import requests

url = "https://staging.api.us.aptlydone.com/settings/v1/groups/{id}"

payload = {
    "groupName": "Engineering Team",
    "displayName": "Engineering Team",
    "isDeleted": False,
    "addParentGroupIds": ["uuid", "uuid"],
    "removeParentGroupIds": ["uuid", "uuid"],
    "legalName": "Engineering Department LLC",
    "address": {
        "street1": "123 Main Street",
        "street2": "Suite 100",
        "city": "New York",
        "state": "New York",
        "stateCode": "NY",
        "zipCode": "10001",
        "country": "United States",
        "countryCode": "US"
    }
}
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({
    groupName: 'Engineering Team',
    displayName: 'Engineering Team',
    isDeleted: false,
    addParentGroupIds: ['uuid', 'uuid'],
    removeParentGroupIds: ['uuid', 'uuid'],
    legalName: 'Engineering Department LLC',
    address: {
      street1: '123 Main Street',
      street2: 'Suite 100',
      city: 'New York',
      state: 'New York',
      stateCode: 'NY',
      zipCode: '10001',
      country: 'United States',
      countryCode: 'US'
    }
  })
};

fetch('https://staging.api.us.aptlydone.com/settings/v1/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://staging.api.us.aptlydone.com/settings/v1/groups/{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([
    'groupName' => 'Engineering Team',
    'displayName' => 'Engineering Team',
    'isDeleted' => false,
    'addParentGroupIds' => [
        'uuid',
        'uuid'
    ],
    'removeParentGroupIds' => [
        'uuid',
        'uuid'
    ],
    'legalName' => 'Engineering Department LLC',
    'address' => [
        'street1' => '123 Main Street',
        'street2' => 'Suite 100',
        'city' => 'New York',
        'state' => 'New York',
        'stateCode' => 'NY',
        'zipCode' => '10001',
        'country' => 'United States',
        'countryCode' => 'US'
    ]
  ]),
  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://staging.api.us.aptlydone.com/settings/v1/groups/{id}"

	payload := strings.NewReader("{\n  \"groupName\": \"Engineering Team\",\n  \"displayName\": \"Engineering Team\",\n  \"isDeleted\": false,\n  \"addParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"removeParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"legalName\": \"Engineering Department LLC\",\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"street2\": \"Suite 100\",\n    \"city\": \"New York\",\n    \"state\": \"New York\",\n    \"stateCode\": \"NY\",\n    \"zipCode\": \"10001\",\n    \"country\": \"United States\",\n    \"countryCode\": \"US\"\n  }\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://staging.api.us.aptlydone.com/settings/v1/groups/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"groupName\": \"Engineering Team\",\n  \"displayName\": \"Engineering Team\",\n  \"isDeleted\": false,\n  \"addParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"removeParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"legalName\": \"Engineering Department LLC\",\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"street2\": \"Suite 100\",\n    \"city\": \"New York\",\n    \"state\": \"New York\",\n    \"stateCode\": \"NY\",\n    \"zipCode\": \"10001\",\n    \"country\": \"United States\",\n    \"countryCode\": \"US\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://staging.api.us.aptlydone.com/settings/v1/groups/{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  \"groupName\": \"Engineering Team\",\n  \"displayName\": \"Engineering Team\",\n  \"isDeleted\": false,\n  \"addParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"removeParentGroupIds\": [\n    \"uuid\",\n    \"uuid\"\n  ],\n  \"legalName\": \"Engineering Department LLC\",\n  \"address\": {\n    \"street1\": \"123 Main Street\",\n    \"street2\": \"Suite 100\",\n    \"city\": \"New York\",\n    \"state\": \"New York\",\n    \"stateCode\": \"NY\",\n    \"zipCode\": \"10001\",\n    \"country\": \"United States\",\n    \"countryCode\": \"US\"\n  }\n}"

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

{
  "statusCode": 200,
  "timestamp": "2026-01-08T06:33:20.711Z",
  "message": "Success",
  "data": {
    "id": "3de3ba12-fe6e-4242-b2c2-57aa17d2b959",
    "tenantId": "9409925f-e386-428d-b82d-bc96fc7d785e",
    "groupId": "drDwrQ",
    "groupName": "Engineering Team",
    "createdOn": "2023-01-01T12:00:00Z",
    "updatedOn": "2023-01-15T12:00:00Z",
    "isSynced": false,
    "tenantGroupType": {
      "id": "6e606506-4c84-49a9-8abe-ce46d5b44e70",
      "groupTypeName": "Department",
      "shouldAllowEnableDisable": true,
      "isDefault": false
    },
    "isDeleted": false,
    "disableOption": "NA",
    "baseCurrency": "",
    "displayName": "Engineering Department",
    "legalName": "Engineering Department LLC",
    "externalId": "EXT-GROUP-12345",
    "instanceId": "02198055-706d-417d-9573-d376ced5c6f6",
    "address": {
      "id": "f2dfca59-4d8d-4636-a73b-41e97b3ba548",
      "groupId": "1cbaa43f-c81c-45e9-a0c4-31b632d0502b",
      "street1": "123 Main Street",
      "city": "New York",
      "state": "New York",
      "zipCode": "10001",
      "country": "United States",
      "createdOn": "2023-01-01T12:00:00Z",
      "updatedOn": "2023-01-15T12:00:00Z",
      "street2": "Suite 100",
      "stateCode": "NY",
      "countryCode": "US"
    },
    "parentGroups": [
      {
        "id": "f8e83c38-c408-46d0-8e10-a3bc01073a28",
        "parentId": "f3babb40-7bfa-4fc0-9942-4af717f25701",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "parentGroup": {
          "id": "e9db3b7c-e5cd-4ff4-9d6d-a6528ec04aa1",
          "tenantId": "56cdb45f-cd19-4be3-963c-2b4b4eb4529e",
          "groupId": "10000",
          "groupName": "Engineering Team",
          "displayName": "Engineering Team",
          "legalName": "Engineering Team",
          "tenantGroupType": {
            "id": "6414c9b4-72f9-4788-99da-976747a10992",
            "groupTypeName": "Department"
          }
        }
      }
    ],
    "decisionsCount": 25,
    "delegationsCount": 25
  }
}

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

groupName

string

Group Name

Maximum string length: 100

Example:

"Engineering Team"

displayName

string

Display Name

Maximum string length: 100

Example:

"Engineering Team"

status

enum<string>

Status

Available options:

ACTIVE,

INACTIVE

isDeleted

boolean

Is Deleted

Example:

false

addParentGroupIds

string[]

Parent group ids to add

Example:

["uuid", "uuid"]

removeParentGroupIds

string[]

Parent group ids to remove

Example:

["uuid", "uuid"]

disableOption

enum<string>

Disable option

Available options:

KEEP_ASSOCIATIONS,

REMOVE_ASSOCIATIONS,

NA

legalName

string

Legal Name

Maximum string length: 100

Example:

"Engineering Department LLC"

address

object

Group Address

Show child attributes

Response

200 - application/json

Group updated successfully

statusCode

number

required

HTTP Status code

Example:

200

timestamp

string

required

Timestamp of the response

Example:

"2026-01-08T06:33:20.711Z"

message

string

required

Response message

Example:

"Success"

data

object

required

Response data

Show child attributes

Get group List group types

⌘I

API Authentication

Decisions

Delegations

Matrices

Actions

Documents

Tenants

Users

Groups

Positions

Reporting

Notifications

Update group

Authorizations

Path Parameters

Body

Response