REST API: Notes
Last updated
Last updated
Replace {subdomain} in the endpoints below with your Vitally subdomain.
You can find your subdomain in the URL used to log into Vitally (i.e., https://yoursubdomain.vitally.io
| Property | Description | Editable |
|---|
| Property | Description | Editable |
|---|
In Vitally, if you are an admin, you can add additional fields to your notes via the Traits management section. When you create a trait, we will provide you with a key for that trait:
Using this key, you can set values for this trait when POSTing or PUTing to the API:
Example Request
Example Response
Note that when updating traits, if a trait is not specified, it will not be deleted from the note (i.e. the value for the trait will remain unchanged). To actually delete a trait from a note, simply specify the trait with a null value.
GETUS Data Center (default):
EU Data Center:
Paginated list of Notes, by default ordered by updatedAt.
Example Request
Example Response
GETUS Data Center (default):
EU Data Center:
Paginated list of Notes for a given Account, by default ordered by updatedAt.
Example Requests
Example Response
GETUS Data Center (default):
EU Data Center:
Paginated list of Notes for a given Organization, by default ordered by updatedAt.
Example Request
Example Response
POSTUS Data Center (default):
EU Data Center:
Notes are unique on externalId.
Request Body
Example Request
Example Response
GETUS Data Center (default):
EU Data Center:
Request Params
PUTUS Data Center (default):
EU Data Center:
Request Params
Request Body
DELETEUS Data Center (default):
EU Data Center:
Request Params
GETUS Data Center (default):
EU Data Center:
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.
Query Params
Example Request
Example Response
Params (see )
Query Params (see )
| Param | Type | Description |
|---|
Query Params (see )
| Param | Type | Description |
|---|
| Property | Type | Description |
|---|
| Property | Type | Description |
|---|
| Property | Type | Description |
|---|
| Property | Type | Description |
|---|
Params (see )
| Param | Type | Description |
|---|
limit |
| (optional) The number of items to return. The max/default is 100 |
from |
| (optional) The cursor returned from a previous request |
archived |
| (optional) Show only deleted items if |
limit |
| (optional) The number of items to return. The max/default is 100 |
from |
| (optional) The cursor returned from a previous request |
id |
| Accepts both the Note ID assigned by Vitally and the |
id |
| Accepts both the Note ID assigned by Vitally and the |
id |
| The Note ID assigned by Vitally |
limit |
| (optional) The number of items to return. The max/default is 100 |
from |
| (optional) The cursor returned from a previous request |
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 | Only on create |
note | Yes |
noteDate | Required The date-time of when the Note was created | Yes |
subject | The subject or title of the Note | Yes |
authorId | Yes |
categoryId | Yes |
archivedAt | Datetime the Note was deleted |
tags | An array of string tags to associate to the note | Yes |
traits | A key-value JSON object of custom note traits. See below for more details. | Yes |
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 |
accountId |
| Required The ID of the Vitally Account to associate the Note with. Not to be confused with an External ID, this is the Vitally Account ID |
organizationId |
| Required (when applicable) The ID of the Vitally Organization to associate the Note with. Not to be confused with an External ID, this is the Vitally Organization ID |
note |
|
noteDate |
| Required The timestamp of when the Note was created |
externalId |
| The unique ID of the Note in your system |
subject |
| The subject or title of the Note |
authorId |
| The ID of the Vitally User who created the Note |
categoryId |
| The ID of the Vitally Note Category the Note belongs to |
tags |
| An array of string tags to associate to the note |
traits |
| A key-value JSON object of custom note traits. See above for more details. |
accountId |
| The ID of the Vitally Account to associate the Note with |
organizationId |
| The ID of the Vitally Organization account to associate the Note with |
note |
|
noteDate |
| The timestamp of when the Note was created |
externalId |
| The unique ID of the Note in your system |
subject |
| The subject or title of the Note |
authorId |
| The ID of the Vitally User who created the Note |
categoryId |
| The ID of the Vitally Note Category the Note belongs to |
tags |
| An array of string tags to associate to the note |
traits |
| A key-value JSON object of custom note traits. See above for more details. |
for the Note
Required The body of the Note, may include HTML (see )
The ID of the Vitally who created the Note
The ID of the Vitally the Note belongs to
Set when notes are deleted in-app or via endpoint
Required The body of the Note, may include HTML (see )
The body of the Note, may include HTML (see )