Staff History
Create a staff history
API Documentation
Ranking Key
Staff History
Workspace
Sessions
Orders
Staff History
Create a staff history
POST
/
staff
/
history
curl --request POST \
--url https://api.readmin.app/staff/history \
--header 'Content-Type: application/json' \
--header 'loader-id: <api-key>' \
--data '{
"actioningUser": "<string>",
"userId": "<string>",
"reason": "<string>",
"type": "promotion",
"notify": true,
"role": "<string>",
"expiresInDays": 123,
"approval_required": true
}'
{
"success": true,
"history": {
"_id": "<string>",
"groupId": "<string>",
"type": "promotion",
"userId": true,
"disciplinarianId": "<string>",
"reason": "<string>",
"created": "<string>",
"expires": "<string>",
"rankTo": "<string>",
"rankFrom": "<string>",
"ended": true,
"endedBy": "<string>",
"evidence": [
"<string>"
],
"pendingApproval": true,
"approvedBy": "<string>",
"notify": true,
"distribution": 123
}
}
Authorizations
Body
application/json
The body is of type object
.
Response
200
application/json
The request was successful, and the server has returned the requested resource in the response body.
The response is of type object
.
curl --request POST \
--url https://api.readmin.app/staff/history \
--header 'Content-Type: application/json' \
--header 'loader-id: <api-key>' \
--data '{
"actioningUser": "<string>",
"userId": "<string>",
"reason": "<string>",
"type": "promotion",
"notify": true,
"role": "<string>",
"expiresInDays": 123,
"approval_required": true
}'
{
"success": true,
"history": {
"_id": "<string>",
"groupId": "<string>",
"type": "promotion",
"userId": true,
"disciplinarianId": "<string>",
"reason": "<string>",
"created": "<string>",
"expires": "<string>",
"rankTo": "<string>",
"rankFrom": "<string>",
"ended": true,
"endedBy": "<string>",
"evidence": [
"<string>"
],
"pendingApproval": true,
"approvedBy": "<string>",
"notify": true,
"distribution": 123
}
}