Add or Replace Staff Note
Sets a staff member’s note for a date. Shared rules: see Writing Data.
- There is one note per staff member per date.
- No note on that date: a note is created (
201,action: created). - A note already exists: its text is replaced (
200,action: updated). If several exist, the newest is replaced. Images and the original creator andcreated_onare kept. - CRM and business-contact notes are never touched.
- The staff member gets an app notification (“Admin has added a new note.” or “Admin has updated a note.”).
- Editing notes any other way, and deleting notes, is not available. Use List Staff Notes to read notes back.
Custom role needs: staff_details:edit.
Authentication
AuthorizationApi-Key
Format: “Api-Key {api-key}”
Request
This endpoint expects an object.
salarybox_id
SalaryBox ID of the staff member the note is for.
note
Note text, 1-2000 characters (extra spaces around it are trimmed).
date
The date the note is about, YYYY-MM-DD.
Response
A note already existed for that date and its text was overwritten (data.action = updated).
message
Note added successfully when created, Note for this date updated successfully when overwritten.
status
data
Errors
400
Bad Request Error
403
Forbidden Error
404
Not Found Error
