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": "2024-05-18T23:49:51Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "EditDate": "2024-05-18T23:49:51Z",
  "CreateDate": "2024-05-18T23:49:51Z",
  "DisplayDate": "2024-05-18T23:49:51Z",
  "NoteText": "sample string 5",
  "NoteTypeID": 6,
  "ID": "1e2bd929-1639-4989-b392-a7d118046b7e",
  "ManageUserID": "6359cd73-13aa-497a-92ad-72aa679a1717",
  "ManageUserName": "sample string 9",
  "CreateUserID": "4fead868-76b5-4ebe-80d5-1d8d1df14bc6",
  "CreateUserName": "sample string 11",
  "EditUserID": "53bc187c-7f2c-4c1d-ae3a-6034a6f9e775",
  "EditUserName": "sample string 13",
  "IsPrivate": true,
  "LinkedEntities": {
    "Contacts": [
      "bace0007-31ee-4566-8b45-07cd30acc7dc",
      "8c65ba04-82eb-4ce5-af12-d013983ecf8a"
    ],
    "Companies": [
      "e80fb38b-c6ee-439a-9265-8f5c72d8e7c7",
      "5be10fd2-530a-4f8a-9660-3d65c3572586"
    ],
    "Groups": [
      "27f353e8-b27b-4798-a33f-80c4b093d0a2",
      "f99acb64-07a3-4d3b-8649-31cd662b4f30"
    ],
    "Opportunities": [
      "f0eced56-fcaf-4437-8702-39b3d6c84a73",
      "8b8fc2fe-7ff2-47a6-8b9a-ed720c25f392"
    ]
  }
}

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:
"a45bbc5a-11e7-4811-97a8-e11431bfe804"