Create a new category
  • 05 Dec 2024
  • 1 Minute to read

Create a new category


Article summary

Post
/v{version}/Categories

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
version
stringRequired

The requested API version

Default"1.18"
Body parameters

Creation request that contains information for creating a new category

Expand All
object

Request that contains information for creating a new category

Name
string Required

Name of the category

ParentId
integer (int32)

Unique ID of the parent category

Minimum1.0
Maximum2147483647.0
Permissions
object Required

Permissions of the category

property*
object additionalProperties
Read
boolean
Write
boolean
Selectable
boolean

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

Responses
200

OK

Expand All
object

Category

Created
string (date-time)

Creation date in UTC

Id
integer (int32)

Unique ID of the category

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the category

ParentId
integer (int32)

Unique ID of the parent category

Permissions
object

Permissions of the category

Read
boolean
Write
boolean
Selectable
boolean

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

400

Bad request

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

Access denied

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

Unexpected error

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

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.