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-10-18T15:59:28Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "EditDate": "2025-10-18T15:59:28Z",
  "CreateDate": "2025-10-18T15:59:28Z",
  "DisplayDate": "2025-10-18T15:59:28Z",
  "NoteText": "sample string 5",
  "NoteTypeID": 6,
  "ID": "3d5d2bb1-f42c-41c7-933d-5818ca22d3e5",
  "ManageUserID": "389ba748-0eb6-4011-bc71-9d25b8a9ac9b",
  "ManageUserName": "sample string 9",
  "CreateUserID": "a0f5aa2f-c809-45e6-8b28-df6bdebc9af2",
  "CreateUserName": "sample string 11",
  "EditUserID": "f1feda7d-d4d2-4b31-a952-597a411a635d",
  "EditUserName": "sample string 13",
  "IsPrivate": true,
  "LinkedEntities": {
    "Contacts": [
      "a0d9847a-9488-467e-9591-6eb8dd887bb0",
      "b113175d-e588-4749-ba08-f49472d2e3d6"
    ],
    "Companies": [
      "9bcb7794-8607-4d66-a769-dd61d55fa73c",
      "dbccc943-349e-49cd-880a-9f4c06078183"
    ],
    "Groups": [
      "dfd52232-87b4-432a-96d5-4b1e5470d57e",
      "ea7f2c70-f38c-4a5a-8e74-1b71bfba76e9"
    ],
    "Opportunities": [
      "e2b10a8f-81dd-4e9e-931f-2d6cfd1fdfc1",
      "b926e1f9-15e3-4e16-b573-09e5bffee5e8"
    ]
  }
}

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:
"1dd3afe6-5c72-47ba-8855-6dc3b8529fe0"