TAG LINE
TAG LINE
SMALL TITLE

Note

(API Version v5)


Represents a note made on an Account.


What can you do with Note?

  • DELETE Note/{id}
    Delete an instance of the Note object.

  • GET Note/
    Retrieve all of the Note objects.

  • GET Note/Paged
    Retrieve all of the Note objects in a paged fashion.

  • GET Note/{id}
    Retrieve an instance of the Note object by its ID.

  • POST Note/
    Create a new instance of the Note object.

  • PUT Note/{id}
    Update an existing instance of the Note object.


Properties

Property Details
identity
READ-ONLY
"identity": 19
Type: Number
This is the unique numeric identifier for the Note
subject
"subject": "Delivery Instuctions"
Type: String
User defined subject for this Note.
text
"text": "Drop off at rear door."
Type: String
User defined text body for this Note.
noteTypeId
"noteTypeId": 13
Type: Number
Unique identifier for the associated NoteType object.
noteTypeName
"noteTypeName": "Sample Name"
Type: String
The name of the object associated with the noteTypeId property.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
createdByUserId
"createdByUserId": 12
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.
updated
READ-ONLY
"updated": "2021-04-26T15:25:27.587Z"
Type: Date
Date time stamp the last time this Note was updated

Date and time values are specified in the ISO 8601 format.
updatedByUserId
"updatedByUserId": 22
Type: Number
Unique identifier for the associated User object.
updatedByUserName
"updatedByUserName": "Sample Name"
Type: String
The name of the object associated with the updatedByUserId property.
showOnOverview
"showOnOverview": true
Type: Boolean
Whether or not to show this Note on the Account overview screen.
isImportant
"isImportant": true
Type: Boolean
Whether or not this should be displayed with importance.


End Points

DELETENote/{id}
Delete an instance of the Note object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the Note object.
Delete an instance of the Note object.
DELETE Note/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "note"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETNote/
Retrieve all of the Note objects.
Retrieve all of the Note objects.
GET Note/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "subject": "Delivery Instuctions",
            "text": "Drop off at rear door.",
            "noteTypeId": 2,
            "noteTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 16,
            "createdByUserName": "Sample Text Data",
            "updated": "2021-04-26T15:25:27.587Z",
            "updatedByUserId": 19,
            "updatedByUserName": "Sample Text Data",
            "showOnOverview": true,
            "isImportant": true
        }
    ]
}
GETNote/Paged
Retrieve all of the Note objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the Note objects in a paged fashion.
GET Note/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "subject": "Delivery Instuctions",
                "text": "Drop off at rear door.",
                "noteTypeId": 7,
                "noteTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 9,
                "createdByUserName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "updatedByUserId": 25,
                "updatedByUserName": "Sample Text Data",
                "showOnOverview": true,
                "isImportant": true
            }
        ]
    }
}
GETNote/{id}
Retrieve an instance of the Note object by its ID.
{id}Unique identifier for the Note object.
Retrieve an instance of the Note object by its ID.
GET Note/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "subject": "Delivery Instuctions",
        "text": "Drop off at rear door.",
        "noteTypeId": 4,
        "noteTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 8,
        "createdByUserName": "Sample Text Data",
        "updated": "2021-04-26T15:25:27.587Z",
        "updatedByUserId": 27,
        "updatedByUserName": "Sample Text Data",
        "showOnOverview": true,
        "isImportant": true
    }
}
POSTNote/
Create a new instance of the Note object.
Create a new instance of the Note object.
POST Note/

{
    "subject": "Delivery Instuctions",
    "text": "Drop off at rear door.",
    "noteTypeId": 23,
    "createdByUserId": 23,
    "updatedByUserId": 21,
    "showOnOverview": true,
    "isImportant": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "subject": "Delivery Instuctions",
                "text": "Drop off at rear door.",
                "noteTypeId": 24,
                "noteTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 18,
                "createdByUserName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "updatedByUserId": 24,
                "updatedByUserName": "Sample Text Data",
                "showOnOverview": true,
                "isImportant": true
            }
        ]
    }
}
PUTNote/{id}
Update an existing instance of the Note object.
Update an existing instance of the Note object.
PUT Note/{id}

{
    "identity": 1,
    "subject": "Delivery Instuctions",
    "text": "Drop off at rear door.",
    "noteTypeId": 6,
    "createdByUserId": 10,
    "updatedByUserId": 3,
    "showOnOverview": true,
    "isImportant": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "subject": "Delivery Instuctions",
                "text": "Drop off at rear door.",
                "noteTypeId": 13,
                "noteTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 27,
                "createdByUserName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "updatedByUserId": 2,
                "updatedByUserName": "Sample Text Data",
                "showOnOverview": true,
                "isImportant": true
            }
        ]
    }
}