inventory/category/add - Equotix One API

This adds a category to the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

parent_id

integer

required

The parent ID for the category. Use 0 if it is a parent itself.

name

string

required

The name of the category.

channel_group_id

integer

required

The channel group ID for restriction control. Accepts 0 if none.

image

string

required

The image URL or file path to the image stored on Equotix One. Leave empty if none.

Example

{
    "domain": "string",
    "api_key": "string",
    "auth_timestamp": 0,
    "auth_signature": "string",
    "parent_id": 0,
    "name": "string",
    "channel_group_id": 0,
    "image": "string"
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

success

boolean

optional

Returns only if there is no error.

category_id

integer

optional

The newly added category ID.

Example

{
    "error": [
        "string"
    ],
    "success": true,
    "category_id": 0
}