POST api/Notes
Create a new Note
Request Information
URI Parameters
None.
Body Parameters
NoteName | 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": "2025-04-11T06:49:36Z", "FileType": "sample string 4", "FileExtension": "sample string 5", "FileName": "sample string 6", "Personal": true, "Shortcut": true }, "EditDate": "2025-04-11T06:49:36Z", "CreateDate": "2025-04-11T06:49:36Z", "DisplayDate": "2025-04-11T06:49:36Z", "NoteText": "sample string 5", "NoteTypeID": 6, "ID": "99106212-bfae-404d-ad8f-5df46f05e58b", "ManageUserID": "27045087-05f3-45bb-a441-dd7dc8693f83", "ManageUserName": "sample string 9", "CreateUserID": "9c225d57-fb9f-419e-a997-f78130e701b8", "CreateUserName": "sample string 11", "EditUserID": "ad93180e-3717-4d52-b666-35355f33a79b", "EditUserName": "sample string 13", "IsPrivate": true, "LinkedEntities": { "Contacts": [ "7644c3b8-f299-45e7-aa8f-f8130840889b", "776f014d-cb48-4831-b662-b7172991b3df" ], "Companies": [ "3d2998e7-47ff-4737-931a-e826aaa831a9", "a77da62d-ad13-462d-b697-9cad1132dd11" ], "Groups": [ "336779bd-7a35-4ba8-9395-517fe5b22622", "f0b6001b-8089-4fda-acfc-ee21c4b9cb9a" ], "Opportunities": [ "04211320-8a73-47ee-a4a1-9baf01cbbd40", "51d1a035-b82a-4f77-99b0-1f9935242f47" ] } }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Id of the new Note record
globally unique identifierResponse Formats
application/json, text/json
Sample:
"4e9172fe-42a1-4470-9ae0-bac36d6c52ef"