Notes
List Customer Notes
Requires admin privileges
GET/api/customers/{customer_id}/notes
Path parameters
customer_id*integer (int64)
Query parameters
Response
OK
Body
idinteger (int64)
reference_typeNoteReferenceType (enum)
businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent
reference_idinteger (int64)
typenullable string
detailsnullable string
created_onstring (date-time)
statusNoteStatus (enum)
openclosed
remindernullable string
user_idinteger (int64)
company_idinteger (int64)
customer_idinteger (int64)
confidentialboolean
priorityboolean
tagsnullable array of string
subjectnullable string
customerCustomerSummary (object)
userUser (object)
assigneesnullable array of NoteAssignee (object)
messagesnullable array of NoteMessage (object)
Request
Response
Create Customer Note
Requires admin privileges
POST/api/customers/{customer_id}/notes
Path parameters
customer_id*integer (int64)
Body
typenullable string
detailsnullable string
remindernullable string
statusnullable string
reference_typeNoteReferenceType (enum)
businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent
reference_idinteger (int64)
subjectnullable string
confidentialboolean
priorityboolean
tagsnullable array of string
assigneesnullable array of integer (int64)
Response
OK
Body
idinteger (int64)
reference_typeNoteReferenceType (enum)
businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent
reference_idinteger (int64)
typenullable string
detailsnullable string
created_onstring (date-time)
statusNoteStatus (enum)
openclosed
remindernullable string
user_idinteger (int64)
company_idinteger (int64)
customer_idinteger (int64)
confidentialboolean
priorityboolean
tagsnullable array of string
subjectnullable string
customerCustomerSummary (object)
userUser (object)
assigneesnullable array of NoteAssignee (object)
messagesnullable array of NoteMessage (object)
Request
Response
Get Customer Note
Requires admin privileges
GET/api/customers/notes/{note_id}
Path parameters
note_id*integer (int64)
Response
OK
Body
idinteger (int64)
reference_typeNoteReferenceType (enum)
businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent
reference_idinteger (int64)
typenullable string
detailsnullable string
created_onstring (date-time)
statusNoteStatus (enum)
openclosed
remindernullable string
user_idinteger (int64)
company_idinteger (int64)
customer_idinteger (int64)
confidentialboolean
priorityboolean
tagsnullable array of string
subjectnullable string
customerCustomerSummary (object)
userUser (object)
assigneesnullable array of NoteAssignee (object)
messagesnullable array of NoteMessage (object)
Request
Response
Update Customer Note
Requires admin privileges
PATCH/api/customers/notes/{note_id}
Path parameters
note_id*integer (int64)
Body
typenullable string
remindernullable string
customer_idnullable string
subjectnullable string
detailsnullable string
statusnullable string
reference_typenullable string
reference_idnullable string
confidentialnullable string
prioritynullable string
tagsnullable array of string
Response
OK
Body
idinteger (int64)
reference_typeNoteReferenceType (enum)
businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent
reference_idinteger (int64)
typenullable string
detailsnullable string
created_onstring (date-time)
statusNoteStatus (enum)
openclosed
remindernullable string
user_idinteger (int64)
company_idinteger (int64)
customer_idinteger (int64)
confidentialboolean
priorityboolean
tagsnullable array of string
subjectnullable string
customerCustomerSummary (object)
userUser (object)
assigneesnullable array of NoteAssignee (object)
messagesnullable array of NoteMessage (object)
Request
Response
List all Notes
Requires admin privileges
GET/api/customers/notes
Query parameters
Response
OK
Body
idinteger (int64)
reference_typeNoteReferenceType (enum)
businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent
reference_idinteger (int64)
typenullable string
detailsnullable string
created_onstring (date-time)
statusNoteStatus (enum)
openclosed
remindernullable string
user_idinteger (int64)
company_idinteger (int64)
customer_idinteger (int64)
confidentialboolean
priorityboolean
tagsnullable array of string
subjectnullable string
customerCustomerSummary (object)
userUser (object)
assigneesnullable array of NoteAssignee (object)
messagesnullable array of NoteMessage (object)
Request
Response