Skip to main content
PATCH
/
v1
/
group-types
/
{id}
Update group type
curl --request PATCH \
  --url https://staging.api.us.aptlydone.com/settings/v1/group-types/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "groupTypeName": "Department",
  "disableOption": "KEEP_ASSOCIATIONS",
  "status": "ACTIVE"
}'
{
  "statusCode": 200,
  "timestamp": "2025-06-24T08:51:42.214Z",
  "message": "Success",
  "data": {
    "id": "8fbc5342-8e74-46ff-afa0-f78390dc216c",
    "tenantId": "437218eb-07f2-457a-8628-de3936de2f68",
    "groupTypeName": "Department",
    "shouldAllowEnableDisable": true,
    "isDefault": false,
    "disableOption": "NA",
    "isDeleted": false,
    "status": "ACTIVE",
    "createdBy": null,
    "createdOn": "2024-12-18T09:50:43.338Z",
    "updatedOn": "2024-12-18T09:50:43.338Z",
    "updatedBy": null
  }
}

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
​
groupTypeName
string

Group type name

Maximum length: 50
Example:

"Department"

​
disableOption
enum<string>

Disable option

Available options:
KEEP_ASSOCIATIONS,
REMOVE_ASSOCIATIONS,
NA
​
status
enum<string>

Status

Available options:
ACTIVE,
INACTIVE

Response

200 - application/json

Tenant group type 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