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-07-19T05:30:03Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "EditDate": "2025-07-19T05:30:03Z",
  "CreateDate": "2025-07-19T05:30:03Z",
  "DisplayDate": "2025-07-19T05:30:03Z",
  "NoteText": "sample string 5",
  "NoteTypeID": 6,
  "ID": "e5a9233e-c145-4a06-8715-8f7b7c97aff0",
  "ManageUserID": "d301155d-f3b8-4199-94b4-44e3181e3ff0",
  "ManageUserName": "sample string 9",
  "CreateUserID": "9d591129-8daa-472d-beca-0b8cbf4ffe9c",
  "CreateUserName": "sample string 11",
  "EditUserID": "1fa41733-97d4-49e8-8f08-014fdff5b55e",
  "EditUserName": "sample string 13",
  "IsPrivate": true,
  "LinkedEntities": {
    "Contacts": [
      "6c1659c4-a0ff-4dbd-a0a3-97a846340b6e",
      "2e751b10-4f4b-4159-904e-174564c5bbef"
    ],
    "Companies": [
      "e758a774-3b48-4157-9150-3260aefb19bc",
      "84d02ff5-45ae-4604-814a-f5cc1a9e6873"
    ],
    "Groups": [
      "099b3a40-583b-4993-ab43-092d74801f3e",
      "3f789bca-e8d6-44cf-bffc-03c976131f46"
    ],
    "Opportunities": [
      "8db91e16-de2d-4ed3-a058-45ac77e985d1",
      "e0b09f2d-fc6f-469b-ac66-b6eb6169d3e3"
    ]
  }
}

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:
"6454c4aa-40c4-40f1-ad6f-5d6f73d64ed0"