Skip to content

Notes

The Notes menu records internal notes against a customer — the running log of comments the team keeps on an account (a support interaction, a fraud flag, a follow-up reminder). It mirrors the notes panel on the admin customer view screen.

How notes work

Notes are append-only: each note is a separate, timestamped entry, and adding one never overwrites an earlier note. The notes list shows them newest-first. There is no edit or delete in this menu — the log is a permanent trail.

Notifying the customer

When adding a note you can set customer_notified to email the note's text to the customer. Leave it off to keep the note purely internal. Each note records whether the customer was notified.

Field meanings

FieldMeaning
noteThe note text.
customerIdThe customer the note belongs to.
customerNotifiedWhether the customer was emailed this note.
createdAtWhen the note was added.

Endpoints in this menu

ActionEndpoint
List NotesGET /api/admin/customers/{customerId}/notes
Add NotePOST /api/admin/customers/{customerId}/notes

Permission: customers.customers.edit.

All endpoints require an admin Bearer token — see Authentication.

Released under the MIT License.