POST api/Notes

Create a new Note

Request Information

URI Parameters

None.

Body Parameters

Note

Name	Description	Type	Additional 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": "2024-05-08T00:20:38Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "EditDate": "2024-05-08T00:20:38Z",
  "CreateDate": "2024-05-08T00:20:38Z",
  "DisplayDate": "2024-05-08T00:20:38Z",
  "NoteText": "sample string 5",
  "NoteTypeID": 6,
  "ID": "4d504bfb-a5a4-4df8-98c5-351eff7cfed0",
  "ManageUserID": "3be9dd83-89c1-4550-aa28-ad59a5181c09",
  "ManageUserName": "sample string 9",
  "CreateUserID": "94a10698-690f-4635-9f3a-789624c3d50a",
  "CreateUserName": "sample string 11",
  "EditUserID": "3f396556-1ec6-427c-8f52-d6680d2393af",
  "EditUserName": "sample string 13",
  "IsPrivate": true,
  "LinkedEntities": {
    "Contacts": [
      "8bf5ed8e-1c3d-4656-a289-9b74c846d364",
      "82f94c16-fced-4ab2-a062-14593ce83212"
    ],
    "Companies": [
      "b6bae97d-e793-4b58-8c1b-49bf42495bf1",
      "bfe01263-68bf-420f-81ec-96d45f9f7486"
    ],
    "Groups": [
      "137c538e-5bf0-4b6c-afe6-91b395481d7c",
      "891205c8-6bc0-4be9-943e-b0332f0f3b1d"
    ],
    "Opportunities": [
      "ab11b281-6b8e-4a3a-9a0f-32fa7445bb40",
      "3f3a9f1c-d4fe-42d3-9ceb-61cec105924c"
    ]
  }
}

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:

"db1f261e-d686-4c89-b767-3fda0de13856"