POST
/
staff
/
history
Create a 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

loader-id
string
header
required

Body

application/json
actioningUser
string
required
userId
string
required
reason
string
required
type
enum<string>
required
Available options:
promotion,
writeup,
suspension,
termination
approval_required
boolean
required
notify
boolean
role
string
expiresInDays
number

Response

The request was successful, and the server has returned the requested resource in the response body.

success
boolean
required
history
object
required

A ReAdmin Staff Histoy Item