PATCH
/
{version}
/
categories
/
{category}
/
ranks
/
{rank}
curl --request PATCH \
  --url https://api.perscom.io/{version}/categories/{category}/ranks/{rank} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "abbreviation": "<string>",
  "paygrade": "<string>",
  "order": 123
}'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "abbreviation": "<string>",
    "paygrade": "<string>",
    "order": 123,
    "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
​
category
integer
required
​
rank
integer
required

Query Parameters

​
include
enum<string>
Available options:
image

Body

application/json
​
name
string
required
​
description
string | null

Supports HTML.

​
abbreviation
string | null
​
paygrade
string | null
​
order
integer

Will be auto-calculated if nothing is provided.

Response

200
application/json
OK
​
data
object

Was this page helpful?

Delete rankCreate a batch of ranks