Skip to navigation
Customer Notes

Create a customer note

View as Markdown
Creates a note on this customer. The author is the dashboard user who created the API key making the request.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

idstringRequired
Customer Id

Request

This endpoint expects an object.
noteobjectRequired
Note text to attach to the customer.

Response

The created note
payloadobject
Response payload, will be empty when success is false
successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional
json element with any error messages or warnings

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error