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-04T12:28:06Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "EditDate": "2024-05-04T12:28:06Z",
  "CreateDate": "2024-05-04T12:28:06Z",
  "DisplayDate": "2024-05-04T12:28:06Z",
  "NoteText": "sample string 5",
  "NoteTypeID": 6,
  "ID": "b9f5e714-6d71-474f-975b-9965443afb27",
  "ManageUserID": "e9fe0283-9ccd-4c35-aae3-f6bd471b8693",
  "ManageUserName": "sample string 9",
  "CreateUserID": "ce17970f-fead-4eb6-bd45-5b32422c10ec",
  "CreateUserName": "sample string 11",
  "EditUserID": "8c6ef397-11ac-4986-a5c2-46c2e10bd107",
  "EditUserName": "sample string 13",
  "IsPrivate": true,
  "LinkedEntities": {
    "Contacts": [
      "4ed346f0-6a34-4d4d-ba85-cf6655209a25",
      "2686b0ed-61dd-4d1c-acbd-fbc1b295793e"
    ],
    "Companies": [
      "6b56c9ce-781f-448e-8414-899da9de1c68",
      "aba4136f-bc14-48b4-95f3-f57bb30a5ec9"
    ],
    "Groups": [
      "7d37e458-5199-4338-938b-a636b54a45a4",
      "e4c33843-8061-4db1-992f-dfe2a9539094"
    ],
    "Opportunities": [
      "999bfdfd-fc57-4ff2-af37-38bd63cfb101",
      "3678413e-f1f8-43a9-ad49-286ea56e2102"
    ]
  }
}

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:

"dfb24448-7db8-454b-b016-665c117f700d"