Change an existing category

  • Updated on Aug 9, 2024
  • Published on Aug 8, 2024
  • 1 minute(s) reading time
Prev Next
Put
/v{version}/Categories/{id}

Only admins can access this endpoint.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
id
integer (int32) Required

Unique ID of the category

version
stringRequired

The requested API version

Default"1.17"
Body parameters

Change request that contains information for changing an existing category

Expand All
object

Request that contains information for changing an existing category

Name
string Required

Name of the category

Selectable
boolean

If true, the category is selectable in the IXM Platform. Default: false.

Permissions
object Required

Permissions of the category

property*
object additionalProperties
Read
boolean
Write
boolean
Responses
200

OK

Expand All
object

Category

Id
integer (int32)

Unique ID of the category

Name
string

Name of the category

ParentId
integer (int32)

Unique ID of the parent category

Selectable
boolean

If true, the category is selectable in the IXM Platform. Default: false.

Permissions
object

Permissions of the category

Read
boolean
Write
boolean
Created
string (date-time)

Creation date in UTC

Modified
string (date-time)

Modification date in UTC

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Access denied

Expand All
object
Id
string
Type
string
Message
string
Values
object
property*
object additionalProperties
404

Not found

Expand All
object
Id
string
Type
string
Message
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Type
string
Message
string
Values
object
property*
object additionalProperties