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-08-21T15:23:34Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "EditDate": "2025-08-21T15:23:34Z",
  "CreateDate": "2025-08-21T15:23:34Z",
  "DisplayDate": "2025-08-21T15:23:34Z",
  "NoteText": "sample string 5",
  "NoteTypeID": 6,
  "ID": "aae29657-2dc3-4c40-95e0-6a71e931b717",
  "ManageUserID": "1dc3b567-e349-4638-a860-892ea3f7c3fc",
  "ManageUserName": "sample string 9",
  "CreateUserID": "619b648e-0f7c-4324-95f1-f04984b25610",
  "CreateUserName": "sample string 11",
  "EditUserID": "c7b3eb39-022a-4d35-b608-df9e17312c21",
  "EditUserName": "sample string 13",
  "IsPrivate": true,
  "LinkedEntities": {
    "Contacts": [
      "86d09624-dafc-483c-bee7-a1d8ebdb7e8c",
      "415478a7-3b79-4aaa-86f1-62ec6974efc1"
    ],
    "Companies": [
      "745828d0-548e-4d7f-82da-6314f4618edf",
      "1d90933d-db8e-49d6-aace-487dfc89d1ec"
    ],
    "Groups": [
      "42afbbfe-e032-476b-9f8a-cca4f62a3496",
      "bd2d1061-e780-410e-bcde-a994502f2916"
    ],
    "Opportunities": [
      "cde3bf59-e962-4907-9941-5fa0496162c0",
      "f720f7ac-683c-42e3-a931-07c24fbccfd3"
    ]
  }
}

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:
"df98438f-945b-4e3c-be3d-c71a2d205ae0"