⚡️ Other integrations

Notes

The Note object

Property

Description

Editable

id

Vitally's unique ID for the Note

No

createdAt

Datetime the Note was created

No

updatedAt

Datetime the Note was last updated

No

externalId

Your unique ID for the Note

Only on create

note

Required The body of the Note, may include HTML (see HTML Fields)

noteDate

Required The date-time of when the Note was created

subject

The subject or title of the Note

authorId

The ID of the Vitally Admin who created the Note

categoryId

The ID of the Vitally Note Category the Note belongs to

The Note Category object

Property

Description

Editable

id

Vitally's unique ID for the Message

No

createdAt

Datetime the Note was created

No

updatedAt

Datetime the Note was last updated

No

name

The name of the Note Category

In-app

List Notes GET

https://rest.vitally.io/resources/notes

Paginated list of Notes, by default ordered by updatedAt.

Params (see Pagination)

Example Request

GET https://rest.vitally.io/resources/notes?limit=10&from=cursor

Example Response

{
"results": [
{
"externalId": "note-1",
"subject": "What's the deal with the Account",
"note": "<p>Be sure to check in on them</p>",
"noteDate": "2020-12-11T20:16:27.370Z",
"authorId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
],
"next": "c29tZWJhc2U2NA=="
}

List Notes For An Account GET

https://rest.vitally.io/resources/accounts/:accountId/notes

Paginated list of Notes for a given Account, by default ordered by updatedAt.

Query Params (see Pagination)

Param

Type

Description

limit

number

(optional) The number of items to return. The max/default is 100

from

string

(optional) The cursor returned from a previous request

Example Request

GET https://rest.vitally.io/resources/accounts/:accountId/notes?limit=10&from=cursor

Example Response

{
"results": [
{
"id": "xxxx-xxxxx-xxxxxxxx-xxxxxxxx",
"externalId": "note-1",
"subject": "What's the deal with the Account",
"note": "<p>Be sure to check in on them</p>",
"createdAt": "2020-12-11T20:16:27.370Z",
"updatedAt": "2020-12-11T20:16:27.370Z",
"authorId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
],
"next": "c29tZWJhc2U2NA=="
}

Create A Note POST

https://rest.vitally.io/resources/notes

Note's are unique on externalId. So creating and updating are both possible via the POST endpoint.

Request Body

Property

Type

Description

accountId

string

Required The ID of the Vitally Account to associate the Note with

note

string

Required The body of the Note, may include HTML (see HTML Fields)

noteDate

string

Required The timestamp of when the Note was created

externalId

string

The unique ID of the Note in your system

subject

string

The subject or title of the Note

authorId

string

The ID of the Vitally User who created the Note

categoryId

string

THe ID of the Vitally Note Category the Note belongs to

Example Request

POST https://rest.vitally.io/resources/notes
{
"externalId": "note-1",
"subject": "What's the deal with the Account",
"note": "<p>Be sure to check in on them</p>",
"noteDate": "2020-12-11T20:16:27.370Z",
"authorId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Example Response

{
"externalId": "note-1",
"subject": "What's the deal with the Account",
"note": "<p>Be sure to check in on them</p>",
"noteDate": "2020-12-11T20:16:27.370Z",
"authorId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Get A Note GET

https://rest.vitally.io/resources/notes/:id

Request Params

Property

Type

Description

id

string

Accepts both the Note ID assigned by Vitally and the externalId if provided when creating the Note

Update A Note PUT

https://rest.vitally.io/resources/notes/:id

Request Params

Property

Type

Description

id

string

The Note ID assigned by Vitally

Request Body

Property

Type

Description

accountId

string

The ID of the Vitally Account to associate the Note with

note

string

The body of the Note, may include HTML (see HTML Fields)

noteDate

string

The timestamp of when the Note was created

externalId

string

The unique ID of the Note in your system

subject

string

The subject or title of the Note

authorId

string

The ID of the Vitally User who created the Note

categoryId

string

THe ID of the Vitally Note Category the Note belongs to

Delete A Note DELETE

https://rest.vitally.io/resources/notes/:id

Request Params

Property

Type

Description

id

string

The Note ID assigned by Vitally

List A Note Categories GET

https://rest.vitally.io/resources/noteCategories

Paginated list of Note Categories.

Note Categories are managed in the Vitally UI. The ID of the Note Category is required for associating a Note with a Note Category via the Rest API.

Params (see Pagination)

Query Params

Param

Type

Description

limit

number

(optional) The number of items to return. The max/default is 100

from

string

(optional) The cursor returned from a previous request

Example Request

GET https://rest.vitally.io/resources/noteCategories?limit=10&from=cursor

Example Response

{
"results": [
{
"id": "xxxx-xxxxx-xxxxxxxx-xxxxxxxx",
"name": "Call",
"createdAt": "2020-12-11T20:16:27.370Z",
"updatedAt": "2020-12-11T20:16:27.370Z"
},
{
"id": "xxxx-xxxxx-xxxxxxxx-xxxxxxxx",
"name": "Meeting",
"createdAt": "2020-12-11T20:16:27.370Z",
"updatedAt": "2020-12-11T20:16:27.370Z"
}
],
"next": "c29tZWJhc2U2NA=="
}