Update a custom group

PUT

/v1/custom-groups/{groupId}

Replaces a custom group definition (name and categories) for the current user.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Body Params

application/json-patch+json

Example

{
    "groupName": "string",
    "categories": [
        {
            "name": "string",
            "displayOrder": 0
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/v1/custom-groups/' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--data '{
    "groupName": "string",
    "categories": [
        {
            "name": "string",
            "displayOrder": 0
        }
    ]
}'

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "id": 0,
    "groupName": "string",
    "categories": [
        {
            "name": "string",
            "displayOrder": 0
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Modified at 2026-07-08 10:04:10

Get a custom group

Delete a custom group