Notes

Notes are texts that are linked to case and contact objects.

Create, retrieve, update or delete notes for a particular contact or case.

Attributes

Attribute

Type

Description

id

Integer

Specifies ID of the note.

contactId

Integer

Specifies the contactID of the note

under which it was created.

type

String

Specifies the type of note and whether or not

it's a separate note or a note message.

title

String

Specifies the title of the note which was created.

description

String

Specifies the description of the note.

userId

Integer

Specifies the ID of the user who created the note.

dateCreated

Date

Specifies the date on which the note was created.

users

Object

Specifies the details of the users

involved in the notes.

lastMessage

Object

Specifies the last, or most recent, message in the note section

Permissions

To request a case endpoint, you will need a valid API key with note access permissions.

Last updated