Skip to main content
PATCH
/
v1
/
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",
  "status": "ACTIVE",
  "isDeleted": false,
  "addParentGroupIds": [
    "uuid",
    "uuid"
  ],
  "removeParentGroupIds": [
    "uuid",
    "uuid"
  ],
  "disableOption": "KEEP_ASSOCIATIONS"
}'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:42.214Z",
  "message": "Success",
  "data": {
    "id": "ef985735-4b23-446e-997a-0928b90f9a24",
    "tenantId": "c25232d9-4a19-44b6-9170-6f88477ae400",
    "baseCurrency": "",
    "groupId": "drDwrQ",
    "groupName": "Engineering Team",
    "status": "ACTIVE",
    "createdOn": "2023-01-01T12:00:00Z",
    "updatedOn": "2023-01-15T12:00:00Z",
    "isSynced": false,
    "parentGroups": [
      {
        "id": "228bcd5c-8dd9-4813-9271-e18c9445e34b",
        "parentId": "9e0b5c32-5ffc-4ee0-a3e5-6a9f8f46af9b",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "parentGroup": {
          "id": "89d2b657-bf38-451b-8943-d055866cffe8",
          "tenantId": "8d8e50e6-8365-455d-ac5a-f431f47980d7",
          "groupId": "10000",
          "groupName": "Engineering Team",
          "status": "ACTIVE",
          "tenantGroupType": {
            "id": "5eaa2416-0dd1-441a-a54e-50a37944f70f",
            "groupTypeName": "Department"
          }
        }
      }
    ],
    "tenantGroupType": {
      "id": "0c59c20e-9f0f-4394-a239-39a0acba5047",
      "groupTypeName": "Department",
      "shouldAllowEnableDisable": true,
      "isDefault": false,
      "disableOption": "KEEP_ASSOCIATIONS"
    },
    "isDeleted": false,
    "disableOption": "NA",
    "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

​
id
string
required

Body

application/json
​
groupName
string

Group Name

Maximum 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

Response

200 - application/json

Group updated successfully

​
statusCode
number
required

HTTP Status code

Example:

200

​
timestamp
string
required

Timestamp of the response

Example:

"2025-06-24T08:51:42.214Z"

​
message
string
required

Response message

Example:

"Success"

​
data
object
required

Response data