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-12-04T22:50:14Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "EditDate": "2024-12-04T22:50:14Z",
  "CreateDate": "2024-12-04T22:50:14Z",
  "DisplayDate": "2024-12-04T22:50:14Z",
  "NoteText": "sample string 5",
  "NoteTypeID": 6,
  "ID": "c48dd768-f708-458c-8487-a47fce595af7",
  "ManageUserID": "1939138f-0b6d-4501-9d01-9dafe319790e",
  "ManageUserName": "sample string 9",
  "CreateUserID": "d76f4e71-0c53-48eb-a54f-a3461f6edfff",
  "CreateUserName": "sample string 11",
  "EditUserID": "a78b5047-9e48-467a-bc2a-41799ce65318",
  "EditUserName": "sample string 13",
  "IsPrivate": true,
  "LinkedEntities": {
    "Contacts": [
      "f60ad12a-eb9e-4e55-ac7e-6c9251b4e1e6",
      "cf17b07c-c01f-44a2-ba95-81156146ca09"
    ],
    "Companies": [
      "17635c56-73b6-4623-b517-739a12646d3c",
      "116bff4d-53c0-4508-8f9f-04f487133eac"
    ],
    "Groups": [
      "f1cc148a-4be7-42af-9b15-fb645b20aa5d",
      "40532ab9-86bf-4cfd-be86-cd60d8df4117"
    ],
    "Opportunities": [
      "beb90944-3492-4c94-ab48-9aa64ee11a0e",
      "6fdf7f7c-181c-4155-a7c6-174f05bff92f"
    ]
  }
}

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:

"d780efaf-5668-41d6-af1d-eeb146a7f3d6"