Skip to main content
POST
/
{version}
/
categories
Create category
curl --request POST \
  --url https://api.perscom.io/{version}/categories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "resource": "<string>",
  "description": "<string>"
}
'
{
  "data": {
    "name": "<string>",
    "resource": "<string>",
    "id": 123,
    "description": "<string>",
    "label": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
version
enum<string>
default:v2
required

The API version to use.

Available options:
v1,
v2

Query Parameters

​
include
enum<string>
Available options:
awards,
documents,
forms,
qualifications,
ranks

Body

application/json
​
name
string
required

The name of the category.

Maximum string length: 255
​
resource
string
required

The resource type this category is associated with.

Maximum string length: 255
​
description
string | null

A description of the category. Supports HTML.

Maximum string length: 65535

Response

OK

​
data
CategoryResource · object