PATCH
/
{version}
/
users
/
{user}
/
rank-records
/
{rank_record}
curl --request PATCH \
  --url https://api.perscom.io/{version}/users/{user}/rank-records/{rank_record} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": 123,
  "rank_id": 123,
  "document_id": 123,
  "author_id": 123,
  "text": "<string>",
  "type": 0
}'
{
  "data": {
    "id": 123,
    "user_id": 123,
    "rank_id": 123,
    "document_id": 123,
    "author_id": 123,
    "text": "<string>",
    "type": 0,
    "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
​
user
integer
required
​
rank_record
integer
required

Query Parameters

​
include
enum<string>
Available options:
attachments,
author,
author.*,
comments,
comments.*,
document,
rank,
rank.image

Body

application/json
​
user_id
integer
required
​
rank_id
integer
required
​
type
enum<integer>
required

0: Promotion, 1: Demotion, 2: Lateral, 3: Transfer

Available options:
0,
1,
2,
3
​
document_id
integer | null
​
author_id
integer | null
​
text
string | null

Supports HTML.

Response

200
application/json
OK
​
data
object

Was this page helpful?

Delete rank recordCreate a batch of rank records