POST
/
staff
/
logbook
/
{workspaceId}
/
{staffId}
curl --request POST \
  --url https://api.hyra.io/staff/logbook/{workspaceId}/{staffId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "message": "<string>",
  "type": "promotion",
  "expiry": "2023-11-07T05:31:56Z"
}'
{
  "_id": "<string>",
  "author": "<string>",
  "workspace": "<string>",
  "staff_id": "<string>",
  "type": "<string>",
  "message": "<string>",
  "files": [
    "<string>"
  ],
  "videos": [
    "<string>"
  ],
  "expired": true,
  "expiration": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

There is a more advanced version of this endpoint that allows for uploading files and videos.

However, this API uses multipart encoding instead of JSON, so it has been omitted from this documentation and the Swagger reference.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
workspaceId
string
required
​
staffId
string
required

Body

application/json
​
message
string
required
​
type
enum<string>
required
Available options:
promotion,
note,
demotion,
warning,
termination,
suspension,
warning revocation,
reminder,
deprovisioned
​
expiry
string

Response

200 - application/json
Default Response
​
_id
string
required
​
author
string
required
​
workspace
string
required
​
staff_id
string
required
​
type
string
required
​
message
string
required
​
files
string[]
required
​
videos
string[]
required
​
createdAt
string
required
​
updatedAt
string
required
​
expired
boolean
​
expiration
string