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-15T01:40:16Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "EditDate": "2024-05-15T01:40:16Z",
  "CreateDate": "2024-05-15T01:40:16Z",
  "DisplayDate": "2024-05-15T01:40:16Z",
  "NoteText": "sample string 5",
  "NoteTypeID": 6,
  "ID": "14e52d00-e342-47f6-9482-93896220487e",
  "ManageUserID": "49f48953-9150-471b-bfa1-b0fdf907b70c",
  "ManageUserName": "sample string 9",
  "CreateUserID": "f01ce75f-98cc-4a8c-bd5b-d0ad213d0a73",
  "CreateUserName": "sample string 11",
  "EditUserID": "88f71714-9e05-49cd-8093-2f705c354637",
  "EditUserName": "sample string 13",
  "IsPrivate": true,
  "LinkedEntities": {
    "Contacts": [
      "2f598e17-2182-472b-a280-19e55c51fe32",
      "1b5d2f91-bfdc-48a2-8964-a20baf520d44"
    ],
    "Companies": [
      "aa702191-29fc-4363-957c-976dbe83aedd",
      "59b4dae4-e64b-427c-85eb-86c3ba69b411"
    ],
    "Groups": [
      "8f0e4d17-c79a-4168-a1be-902f2bb388ed",
      "92fe58b2-ee8c-41cb-a5f0-97217b32cc60"
    ],
    "Opportunities": [
      "63ef0a39-b861-4f54-a1f2-4f60e564e4e3",
      "4fd873ff-2290-4f3e-97e0-810b66fe0381"
    ]
  }
}

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:
"67560d55-b645-4b49-9176-6bf15d89a727"