Skip to content

Add Customer Note ​

Appends an internal note to a customer's record. The response is the created note.

EndpointMethod
/api/admin/customers/{customerId}/notesPOST

Response Fields ​

FieldTypeDescription
idintegerNote ID.
customerIdintegerThe customer the note belongs to.
notestringThe note text.
customerNotifiedbooleanWhether the customer was emailed this note.
createdAtstringWhen the note was created.

Request Body ​

FieldTypeRequiredDescription
notestringyesNon-empty. Empty → 422.
customer_notifiedbooleannoWhen true, fires the customer notification email listener.

Append-only ​

Notes are append-only. There is no update/delete endpoint — every note is a separate row for audit.

Permission: customers.customers.edit.

For how the notes log works, see the Notes overview.

Released under the MIT License.