Add a new category

Add a new category to portal

Authorization

userApiKey

api_access_token<token>

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

In: header

Path Parameters

account_id*integer

The numeric ID of the account

id*string

The slug identifier of the portal

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

The name of the category

description?string

A description for the category

position?integer

Category position in the portal list to sort

slug?string

The category slug used in the URL

locale?string

The locale of the category

icon?string

The icon of the category as a string (emoji)

parent_category_id?integer

To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.

associated_category_id?integer

To associate similar categories to each other, e.g same category of product documentation in different languages

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/accounts/0/portals/string/categories" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": 0,
  "description": "string",
  "locale": "string",
  "name": "string",
  "slug": "string",
  "position": 0,
  "portal_id": 0,
  "account_id": 0,
  "associated_category_id": 0,
  "parent_category_id": 0
}

{
  "description": "string",
  "errors": [
    {
      "field": "string",
      "message": "string",
      "code": "string"
    }
  ]
}

Authorization

Path Parameters

Request Body

Response Body

200application/json

403application/json

`application/json`

`application/json`