⚑
Other integrations
πŸ’Ÿ
Account health scores & metrics
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

1
https://rest.vitally.io/resources/notes
Copied!
Paginated list of Notes, by default ordered by updatedAt.
Params (see Pagination)
Example Request
1
GET https://rest.vitally.io/resources/notes?limit=10&from=cursor
Copied!
Example Response
1
{
2
"results": [
3
{
4
"externalId": "note-1",
5
"subject": "What's the deal with the Account",
6
"note": "<p>Be sure to check in on them</p>",
7
"noteDate": "2020-12-11T20:16:27.370Z",
8
"authorId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
9
}
10
],
11
"next": "c29tZWJhc2U2NA=="
12
}
Copied!

List Notes For An Account GET

1
https://rest.vitally.io/resources/accounts/:accountId/notes
Copied!
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
1
GET https://rest.vitally.io/resources/accounts/:accountId/notes?limit=10&from=cursor
Copied!
Example Response
1
{
2
"results": [
3
{
4
"id": "xxxx-xxxxx-xxxxxxxx-xxxxxxxx",
5
"externalId": "note-1",
6
"subject": "What's the deal with the Account",
7
"note": "<p>Be sure to check in on them</p>",
8
"createdAt": "2020-12-11T20:16:27.370Z",
9
"updatedAt": "2020-12-11T20:16:27.370Z",
10
"authorId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
11
}
12
],
13
"next": "c29tZWJhc2U2NA=="
14
}
Copied!

Create A Note POST

1
https://rest.vitally.io/resources/notes
Copied!
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
1
POST https://rest.vitally.io/resources/notes
2
{
3
"externalId": "note-1",
4
"subject": "What's the deal with the Account",
5
"note": "<p>Be sure to check in on them</p>",
6
"noteDate": "2020-12-11T20:16:27.370Z",
7
"authorId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
8
}
Copied!
Example Response
1
{
2
"externalId": "note-1",
3
"subject": "What's the deal with the Account",
4
"note": "<p>Be sure to check in on them</p>",
5
"noteDate": "2020-12-11T20:16:27.370Z",
6
"authorId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
7
}
Copied!

Get A Note GET

1
https://rest.vitally.io/resources/notes/:id
Copied!
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

1
https://rest.vitally.io/resources/notes/:id
Copied!
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

1
https://rest.vitally.io/resources/notes/:id
Copied!
Request Params
Property
Type
Description
id
string
The Note ID assigned by Vitally

List A Note Categories GET

1
https://rest.vitally.io/resources/noteCategories
Copied!
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
1
GET https://rest.vitally.io/resources/noteCategories?limit=10&from=cursor
Copied!
Example Response
1
{
2
"results": [
3
{
4
"id": "xxxx-xxxxx-xxxxxxxx-xxxxxxxx",
5
"name": "Call",
6
"createdAt": "2020-12-11T20:16:27.370Z",
7
"updatedAt": "2020-12-11T20:16:27.370Z"
8
},
9
{
10
"id": "xxxx-xxxxx-xxxxxxxx-xxxxxxxx",
11
"name": "Meeting",
12
"createdAt": "2020-12-11T20:16:27.370Z",
13
"updatedAt": "2020-12-11T20:16:27.370Z"
14
}
15
],
16
"next": "c29tZWJhc2U2NA=="
17
}
Copied!
Last modified 5mo ago