PUT api/Notes/{id}

Update an existing Note. This is not a partial update therefore, please pass in the full Note object to your request. For partial updates, use the PATCH endpoint

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Note ID	globally unique identifier	Required

Body Parameters

Serialized Note record in the body of the request

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-04T19:30:28Z",
    "FileType": "sample string 4",
    "FileExtension": "sample string 5",
    "FileName": "sample string 6",
    "Personal": true,
    "Shortcut": true
  },
  "EditDate": "2024-05-04T19:30:28Z",
  "CreateDate": "2024-05-04T19:30:28Z",
  "DisplayDate": "2024-05-04T19:30:28Z",
  "NoteText": "sample string 5",
  "NoteTypeID": 6,
  "ID": "881cc432-3a4a-4592-a7fe-57ef42fe4290",
  "ManageUserID": "295c69aa-bbe6-4f0b-ae4f-b0689bb9080c",
  "ManageUserName": "sample string 9",
  "CreateUserID": "7f8249de-93e5-4953-bc7c-922fc0be6b3c",
  "CreateUserName": "sample string 11",
  "EditUserID": "ac0eeea2-044d-4ab0-8841-7f56891cc5fe",
  "EditUserName": "sample string 13",
  "IsPrivate": true,
  "LinkedEntities": {
    "Contacts": [
      "cfe69197-d0c9-4e21-a26c-cd3df17de10c",
      "5bb7362a-7509-47d6-95ce-0f4ed521f32b"
    ],
    "Companies": [
      "92aef0c3-9a90-4ed2-8c47-5ebd52659270",
      "a1789953-f45a-4828-9d70-0b986c0174a9"
    ],
    "Groups": [
      "fefd95f0-3bfe-4e37-851c-af760ccf638f",
      "3fba17c9-f5d3-449f-af67-e477d9c07946"
    ],
    "Opportunities": [
      "4eb83f3e-f7a6-429e-a092-6d828530fe1e",
      "ab226926-0bd9-4c5b-83a4-b9306e497300"
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.