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




Notes API Endpoints

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

GET /notes/client/{clientId}

Returns a notes object for the specified client.

GET /notes/appointment/{calendarId}Returns a notes object 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

There are no parameters associated with notes calls.




Notes API Responses

GET /notes/cllient/{clientId}
[{
    "alert": false,
    "businessId": 43111,
    "calendarId": null,
    "clientId": 5146945,
    "createdAge": "moments ago",
    "createdDate": 1542728185896,
    "createdUser": "JoeSchmo",
    "deleted": false,
    "modifiedAge": "",
    "modifiedDate": null,
    "modifiedUser": null,
    "note": "<p>Has a bit of a temper!</p>",
    "noteId": 10470567,
    "noteType": "COMMENT",
    "privateNote": true,
    "professionalId": null,
    "readOnly": false
}]
GET /notes/appointment/{calendarId}
[{
    "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
}]
POST /notes
{
    "alert": false,
    "businessId": 43111,
    "calendarId": null,
    "clientId": 5360110,
    "createdAge": null,
    "createdDate": 1542731958674,
    "createdUser": "JoeSchmo",
    "deleted": false,
    "modifiedAge": null,
    "modifiedDate": null,
    "modifiedUser": null,
    "note": "<p>Recently lost his son - be sensitive!</p>",
    "noteId": 10472029,
    "noteType": "COMMENT",
    "privateNote": true,
    "professionalId": null,
    "readOnly": false
}
PUT /notes
{
    "alert": false,
    "businessId": 43111,
    "calendarId": 17683508,
    "clientId": null,
    "createdAge": "moments ago",
    "createdDate": 1542729372253,
    "createdUser": "JoeSchmo",
    "deleted": false,
    "modifiedAge": null,
    "modifiedDate": 1542731384569,
    "modifiedUser": "JoeSchmo",
    "note": "<p>Just the basics</p>",
    "noteId": 10471323,
    "noteType": "COMMENT",
    "privateNote": true,
    "professionalId": null,
    "readOnly": false
}




Notes Object Values

Property nameTypeRequiredDescription
alertboolean
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.
businessIdintegerYesProvides unique numeric ID for the business the specified note belongs to.
calendarIdintegerYes, if it's an appointment noteProvides unique numeric ID for client that the specified note is attached to if it is a client note.
clientIdintegerYes, if it's a client noteProvides unique numeric ID for the calendar that the specified note is attached to if it is an appointment note.
createdAgestring
Displays as a string representation of how old the specified note is. 
createdDateinteger
Displays as date the specified note was created in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
createdUserstring
Displays the username of user who created the specified note.
deletedboolean
Indicates whether or not the specified note has been marked as deleted.
modifiedAgestring
Displays as a string representation of when the specified note was last modified. 
modifiedDateinteger
Displays as date the specified note was last modified in milliseconds elapsed since January 1, 1970 00:00:00 UTC form.
modifiedUserstring
Displays the username of user who last modified the specified note.
notestringYesDisplays as the text of the specified note.
noteIdintegerYes,, on PUT callsProvides unique numeric ID for the specified note.
noteTypestringYesDisplays as the note type of the specified note. Has available options "COMMENT", 
privateNotebooleanYesIndicates whether or not the specified note is private.
professionalIdinteger
Can be set to the professionalId of the staff member who created the specified note.
readOnlybooleanYesIndicates whether or not the specified note is read-only.