POST api/Notes

Create a new Note

Request Information

URI Parameters

None.

Body Parameters

Note
NameDescriptionTypeAdditional information
HasAttachment

boolean

None.

Attachment

Attachment

None.

EditDate

SQL Column Name: [EDIT_DATE]

date

None.

CreateDate

SQL Column Name: [CREATE_DATE]

date

None.

DisplayDate

SQL Column Name: [NOTE_DATE]

date

None.

NoteText

SQL Column Name: [NOTE]

string

None.

NoteTypeID

SQL Column Name: [NOTETYPEID]

integer

None.

ID

SQL Column Name: [NOTEID]

globally unique identifier

None.

ManageUserID

globally unique identifier

None.

ManageUserName

SQL Column Name: [RECORD_MANAGER]

string

None.

CreateUserID

globally unique identifier

None.

CreateUserName

SQL Column Name: [RECORD_CREATOR]

string

None.

EditUserID

globally unique identifier

None.

EditUserName

SQL Column Name: [LAST_EDITED_BY]

string

None.

IsPrivate

SQL Column Name: [PRIVATE]

boolean

None.

LinkedEntities

LinkedEntities

None.

Request Formats

application/json, text/json

Sample:
{
  "HasAttachment": true,
  "Attachment": {
    "DisplayName": "sample string 1",
    "FileSize": 2.1,
    "LastModified": "2025-10-26T21:23:36Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "EditDate": "2025-10-26T21:23:36Z",
  "CreateDate": "2025-10-26T21:23:36Z",
  "DisplayDate": "2025-10-26T21:23:36Z",
  "NoteText": "sample string 5",
  "NoteTypeID": 6,
  "ID": "5270f21a-4af7-4b01-8743-16b8ddb0f1cb",
  "ManageUserID": "0ddcf935-a50b-4498-8e7d-169a6a4908cc",
  "ManageUserName": "sample string 9",
  "CreateUserID": "48d4165c-bfd2-4281-b4af-69b21560e02a",
  "CreateUserName": "sample string 11",
  "EditUserID": "2cb0cb80-fb0e-4c9e-8057-63a4b23e2003",
  "EditUserName": "sample string 13",
  "IsPrivate": true,
  "LinkedEntities": {
    "Contacts": [
      "4c9c6061-eaf4-4809-ac61-3eb8b9c5f576",
      "28d525b4-9582-4780-9caf-d82e72dc630d"
    ],
    "Companies": [
      "a6e24dc2-7ba2-43f1-b535-e6e69ec8f9d5",
      "5c097bfa-be5b-41d2-8722-d470e9ab9a81"
    ],
    "Groups": [
      "baa0c696-de39-499a-8cd1-9166854f4491",
      "c25f5f2a-81f9-4379-a2fd-85dd5c10183f"
    ],
    "Opportunities": [
      "14363d2e-cb17-43b3-b450-d19a78f6cbfe",
      "1699b475-49f4-4afd-880f-8c9c54b2f560"
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Id of the new Note record

globally unique identifier

Response Formats

application/json, text/json

Sample:
"fc74ad96-b3be-4a7d-99bb-3a9a180fecbd"