Edit a category

put

https://{hostname}/api-definitions/v2/categories/{apiCategoryId}

Updates a category's description or unique name.

Path Params

apiCategoryId

integer

required

The unique identifier for the category.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

An endpoint category.

apiCategoryDescription

string | null

The description of the category that you may use to tag related endpoints. If you specify null or an empty string in the request, the JSON response doesn't include this field.

apiCategoryName

string

required

The unique-per-account name of the category. Any empty value reflects back as an __UNCATEGORIZED__ keyword.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200The response shows the updated category.

400Bad request. Some of the request input is invalid.

403Forbidden. You don't have permission to edit API endpoint category.