Skip to main content
POST
Create logbook entry

Authorizations

Authorization
string
header
required

A workspace API key from Settings › Developer.

Query Parameters

workspace_id
string
required

The workspace: the 24-character ID in its Ankra address, or its UUID.

Body

application/json
roblox_user_id
integer
required

The Roblox user ID of the person.

title
string
required

The first line of the entry.

entry_type
enum<string>
default:Note

"Strike" is a warning.

Available options:
Note,
Promotion,
Demotion,
Suspension,
Termination,
Strike,
Reminder,
Strike Revocation
content
string

The rest of the entry.

amount
integer
default:1

How many warnings a Strike gives, or a Strike Revocation takes back.

Required range: 1 <= x <= 100
executor_roblox_user_id
integer

Roblox user ID of whoever did this in game. Recorded as the actor when they are linked to someone in the workspace.

Response

Created.

id
string<uuid>
entry_type
string
Example:

"Promotion"

title
string
Example:

"Promotion"

content
string | null
Example:

"Promoted for hard work."

amount
integer
Example:

1

created_by
string<uuid> | null
created_at
string<date-time>