Update group type

PATCH /v1/group-types/{id}

Update group type

cURL

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",
  "addressEnabled": false
}
'

200

{
  "statusCode": 200,
  "timestamp": "2026-01-08T06:33:20.711Z",
  "message": "Success",
  "data": {
    "id": "3201254a-c76c-4ab3-8ba5-dffbe3fd87e1",
    "tenantId": "176c9cbd-c764-433a-9b5f-f35327513553",
    "groupTypeName": "Department",
    "shouldAllowEnableDisable": true,
    "addressEnabled": false,
    "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 string length: 50

Example:

"Department"

disableOption · enum<string>

Disable option

Available options: KEEP_ASSOCIATIONS, REMOVE_ASSOCIATIONS, NA

status · enum<string>

Status

Available options: ACTIVE, INACTIVE

addressEnabled · boolean

Address Enabled

Example:

false

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:

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

message · string · required

Response message

Example:

"Success"

data · object · required

Response data

Show child attributes