Notes

The Notes API is used to access, create, and modify the different notes objects on your business' account. The Notes API is connected to the Clients and Appointments APIs, as notes can be assigned to either clients or appointments.

Notes that are assigned to a client will have the clientId property set to the ID of the corresponding client, while notes assigned to an appointment will have the calendarId set to the ID of the corresponding appointment.

On this page

1 Notes API Endpoints
2 Notes API Parameters
3 Notes API Request Body/Payloads
4 Notes API Responses
5 Notes Object Values

Notes API Endpoints

Return to Top

These are the endpoints that are available under the /notes path, which lists all the different notes you have added to clients and appointments to your business account.

Endpoint	Description

Endpoint	Description
GET /notes/client/{clientId}	Returns all notes objects for the specified client.
GET /notes/appointment/{calendarId}	Returns all notes objects for the specified appointment.
POST /notes	Creates a new notes object on your business' account. Request body/payload: Must pass a notes object in the request body/payload. For these calls, you need to pass a notes object with all required fields and any fields you want to set filled in the body of the payload - must include businessId and either clientId if creating the note on a client, or calendarId if creating the note on an appointment. We have an example of a notes object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.
PUT /notes	Updates an existing notes object on your business' account. Request body/payload: Must pass a notes object in the request body/payload. For these calls, you need to pass a notes object with all required fields and any fields you want to update filled in the body of the payload - must include businessId and noteId. We have an example of a notes object in the responses section below and have indicated the required fields in the object values table at the bottom of this page.
DELETE /notes/{noteId}	Removes a notes object from view by setting its deleted property to true.

Notes API Parameters

Return to top

There are no parameters associated with notes calls.

Notes API Request Body/Payloads

Return to top

The objects below represent the minimum viable objects to pass that are needed to create or update a notes object. Check whether or not a property can be written to by looking at the Object Values table below to see if the property is writable.

{
    "alert": true,
    "businessId": 43111,
    "clientId": 4761823,
    "note": "<p>Gets confused easily</p>",
    "noteType": "COMMENT",
    "privateNote": true,
    "readOnly": false
}

{
    "alert": true,
    "businessId": 43111,
    "calendarId": null,
    "classScheduleId": null,
    "clientId": 4761823,
    "createdAge": "10 minutes ago",
    "createdDate": 1670524480721,
    "createdUser: "JoeSchmo",
    "deleted": false,
    "invoiceId": null,
    "modifiedAge": "",
    "modifiedDate": 1670525098981,
    "modifiedUser": "JoeSchmo",
    "note": "<p>Gets confused easily - give her some time</p>",
    "noteId": 228240897,
    "noteType": "COMMENT",
    "privateNote": true,
    "professionalId": 77961,
    "readOnly": false,
    "recurringAppointmentId": null,
    "recurringScheduleId": null,
    "waitListId": null
}

Notes API Responses

Return to Top

[{
    "alert": false,
    "businessId": 43111,
    "calendarId": null,
    "classScheduleId": null,
    "clientId": 4761823,
    "createdAge": "moments ago",
    "createdDate": 1542728185896,
    "createdUser": "JoeSchmo",
    "deleted": false,
    "invoiceId": null,
    "modifiedAge": "",
    "modifiedDate": null,
    "modifiedUser": null,
    "note": "<p>Gets confused easily</p>",
    "noteId": 10470567,
    "noteType": "COMMENT",
    "privateNote": true,
    "professionalId": 77961,
    "readOnly": false
    "recurringAppointmentId": null,
    "recurringScheduleId": null,
    "waitListId": null
}]

[{
    "alert": false,
    "businessId": 43111,
    "calendarId": 17683508,
    "clientId": null,
    "createdAge": "2 weeks ago",
    "createdDate": 1541527537548,
    "createdUser": "JoeSchmo",
    "deleted": false,
    "modifiedAge": "",
    "modifiedDate": null,
    "modifiedUser": null,
    "note": "The subStatus has been changed from 'OPEN' to 'CHECKEDIN'↵Checked in↵",
    "noteId": 10260547,
    "noteType": "CHANGE_SUMMARY",
    "privateNote": false,
    "professionalId": null,
    "readOnly": true
}]

{
    "alert": true,
    "businessId": 43111,
    "calendarId": null,
    "classScheduleId": null,
    "clientId": 4761823,
    "createdAge": null,
    "createdDate": 1542731958674,
    "createdUser": "JoeSchmo",
    "deleted": false,
    "invoiceId": null,
    "modifiedAge": null,
    "modifiedDate": null,
    "modifiedUser": null,
    "note": "<p>Gets confused easily</p>",
    "noteId": 228240897,
    "noteType": "COMMENT",
    "privateNote": true,
    "professionalId": 77961,
    "readOnly": false
    "recurringAppointmentId": null,
    "recurringScheduleId": null,
    "waitListId": null
}

{
    "alert": false,
    "businessId": 43111,
    "calendarId": null,
    "classScheduleId": null,
    "clientId": 4761823,
    "createdAge": "moments ago",
    "createdDate": 1542729372253,
    "createdUser": "JoeSchmo",
    "deleted": false,
    "invoiceId": null,
    "modifiedAge": null,
    "modifiedDate": 1542731384569,
    "modifiedUser": "JoeSchmo",
    "note": "<p>Gets confused easily - give her some time</p>",
    "noteId": 228240897,
    "noteType": "COMMENT",
    "privateNote": true,
    "professionalId": null,
    "readOnly": false,
    "recurringAppointmentId": null,
    "recurringScheduleId": null,
    "waitListId": null
}

Notes Object Values

Return to Top

Property name	Type	Required	Description

Property name	Type	Required	Description
alert	boolean		Indicates whether or not the specified note should be shown in an alert box at the top of client profile when viewed on back office.
businessId	integer	Yes	Provides unique numeric ID for the business the specified note belongs to.
calendarId	integer	Yes, if it's an appointment note	Provides unique numeric ID for calendar that the specified note is attached to if it is an appointment note.
classScheduleId	integer		Provides unique numeric ID for the class schedule the specified note belongs to if it is a class-based appointment note.
clientId	integer	Yes, if it's a client note	Provides unique numeric ID for the client that the specified note is attached to if it is an client note.
createdAge	string		Displays as a string representation of how old the specified note is.
createdDate	integer		Displays as date the specified note was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUser	string		Displays the username of user who created the specified note.
deleted	boolean		Indicates whether or not the specified note has been marked as deleted.
invoiceId	integer		Provides unique numeric ID for invoice associated with the specified note.
modifiedAge	string		Displays as a string representation of when the specified note was last modified.
modifiedDate	integer		Displays as date the specified note was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
modifiedUser	string		Displays the username of user who last modified the specified note.
note	string	Yes	Displays as the text of the specified note.
noteId	integer	Yes, on PUT calls	Provides unique numeric ID for the specified note.
noteType	string	Yes	Displays as the note type of the specified note. Has available options "COMMENT",
privateNote	boolean	Yes	Indicates whether or not the specified note is private.
professionalId	integer		Can be set to the professionalId of the staff member who created the specified note.
readOnly	boolean	Yes	Indicates whether or not the specified note is read-only.
recurringAppointmentId	integer		Provides unique numeric ID for the recurring appointment the specified note belongs to if it is a recurring appointment note.
recurringScheduleId	integer		Provides unique numeric ID for the recurring schedule the specified note belongs to if it is a appointment note that makes up part of a recurring schedule.
waitListId	integer		Provides unique numeric ID for the waitlist the specified note belongs to if it is a waitlist note.