PUT v1/Contacts/Notes

Create or update a note for a contact.

Request Information

URI Parameters

None.

Body Parameters

The note to create or update. To create a note, omit Id (or set it to 0). Required fields: AssignedContactId (ID of the contact the note belongs to), Comment (note text content).To update a note, provide the existing note Id and the updated Comment. Required fields: Id, Comment. Optional fields: AssignedPolicyId, EmployeeId, Important, IsPinned, RelatedNotes.

NoteDTO

Name	Description	Type	Additional information
Id	Id of the note	integer	None.
Comment	Comment	string	None.
CreatedBy	Created by	string	None.
EmployeeId	Id of the employee	integer	None.
CreatedOn	Created on	string	None.
ModifiedAt	Last modified date	string	None.
ModifiedBy	Last modified by	string	None.
ParentId	Id of the parent	integer	None.
AssignedPolicyId	Id of the assigned policy	integer	None.
AssignedContactId	Id of the assigned contact id	integer	None.
Important	Signifies whether the note is important	boolean	None.
RelatedNotes	List of related notes	Collection of RelatedNoteDTO	None.
BulkInsertId		globally unique identifier	None.
BulkInsertSessionId		globally unique identifier	None.
IsPinned	Indicates whether the note is pinned	boolean	None.
NotesHistories	Edit history for this note	Collection of NotesHistoryDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Comment": "sample string 2",
  "CreatedBy": "sample string 3",
  "EmployeeId": 1,
  "CreatedOn": "sample string 4",
  "ModifiedAt": "sample string 5",
  "ModifiedBy": "sample string 6",
  "ParentId": 1,
  "AssignedPolicyId": 1,
  "AssignedContactId": 7,
  "Important": true,
  "RelatedNotes": [
    {
      "Id": 1,
      "Comment": "sample string 2",
      "CreatedBy": "sample string 3",
      "EmployeeId": 1,
      "CreatedOn": "sample string 4",
      "IsPinned": "sample string 5",
      "ModifiedAt": "sample string 6",
      "ModifiedBy": "sample string 7",
      "ParentId": 1,
      "AssignedPolicyId": 1,
      "AssignedContactId": 8,
      "Important": true,
      "BulkInsertId": "67d98c1e-cbd6-4217-b80d-fec22cd2ac06",
      "BulkInsertSessionId": "84b43f4d-2945-456f-bae5-3db9daf5ba5f"
    },
    {
      "Id": 1,
      "Comment": "sample string 2",
      "CreatedBy": "sample string 3",
      "EmployeeId": 1,
      "CreatedOn": "sample string 4",
      "IsPinned": "sample string 5",
      "ModifiedAt": "sample string 6",
      "ModifiedBy": "sample string 7",
      "ParentId": 1,
      "AssignedPolicyId": 1,
      "AssignedContactId": 8,
      "Important": true,
      "BulkInsertId": "67d98c1e-cbd6-4217-b80d-fec22cd2ac06",
      "BulkInsertSessionId": "84b43f4d-2945-456f-bae5-3db9daf5ba5f"
    }
  ],
  "BulkInsertId": "fa07e519-5bb3-4cdc-8889-ec6891e63fb1",
  "BulkInsertSessionId": "3a7210c9-2a00-4d91-9680-7daad5ba128d",
  "IsPinned": true,
  "NotesHistories": [
    {
      "NoteHistoryId": 1,
      "NoteId": 2,
      "VersionId": 1,
      "NoteText": "sample string 3",
      "CreatedBy": "sample string 4",
      "CreatedAt": "2026-08-19T11:30:51.3292774+00:00",
      "Important": true,
      "IsPinned": true
    },
    {
      "NoteHistoryId": 1,
      "NoteId": 2,
      "VersionId": 1,
      "NoteText": "sample string 3",
      "CreatedBy": "sample string 4",
      "CreatedAt": "2026-08-19T11:30:51.3292774+00:00",
      "Important": true,
      "IsPinned": true
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'NoteDTO'.

application/xml, text/xml

Sample:

<NoteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
  <AssignedContactId>7</AssignedContactId>
  <AssignedPolicyId>1</AssignedPolicyId>
  <BulkInsertId>fa07e519-5bb3-4cdc-8889-ec6891e63fb1</BulkInsertId>
  <BulkInsertSessionId>3a7210c9-2a00-4d91-9680-7daad5ba128d</BulkInsertSessionId>
  <Comment>sample string 2</Comment>
  <CreatedBy>sample string 3</CreatedBy>
  <CreatedOn>sample string 4</CreatedOn>
  <EmployeeId>1</EmployeeId>
  <Id>1</Id>
  <Important>true</Important>
  <IsPinned>true</IsPinned>
  <ModifiedAt>sample string 5</ModifiedAt>
  <ModifiedBy>sample string 6</ModifiedBy>
  <NotesHistories>
    <NotesHistoryDTO>
      <CreatedAt>2026-08-19T11:30:51.3292774+00:00</CreatedAt>
      <CreatedBy>sample string 4</CreatedBy>
      <Important>true</Important>
      <IsPinned>true</IsPinned>
      <NoteHistoryId>1</NoteHistoryId>
      <NoteId>2</NoteId>
      <NoteText>sample string 3</NoteText>
      <VersionId>1</VersionId>
    </NotesHistoryDTO>
    <NotesHistoryDTO>
      <CreatedAt>2026-08-19T11:30:51.3292774+00:00</CreatedAt>
      <CreatedBy>sample string 4</CreatedBy>
      <Important>true</Important>
      <IsPinned>true</IsPinned>
      <NoteHistoryId>1</NoteHistoryId>
      <NoteId>2</NoteId>
      <NoteText>sample string 3</NoteText>
      <VersionId>1</VersionId>
    </NotesHistoryDTO>
  </NotesHistories>
  <ParentId>1</ParentId>
  <RelatedNotes>
    <RelatedNoteDTO>
      <AssignedContactId>8</AssignedContactId>
      <AssignedPolicyId>1</AssignedPolicyId>
      <BulkInsertId>67d98c1e-cbd6-4217-b80d-fec22cd2ac06</BulkInsertId>
      <BulkInsertSessionId>84b43f4d-2945-456f-bae5-3db9daf5ba5f</BulkInsertSessionId>
      <Comment>sample string 2</Comment>
      <CreatedBy>sample string 3</CreatedBy>
      <CreatedOn>sample string 4</CreatedOn>
      <EmployeeId>1</EmployeeId>
      <Id>1</Id>
      <Important>true</Important>
      <IsPinned>sample string 5</IsPinned>
      <ModifiedAt>sample string 6</ModifiedAt>
      <ModifiedBy>sample string 7</ModifiedBy>
      <ParentId>1</ParentId>
    </RelatedNoteDTO>
    <RelatedNoteDTO>
      <AssignedContactId>8</AssignedContactId>
      <AssignedPolicyId>1</AssignedPolicyId>
      <BulkInsertId>67d98c1e-cbd6-4217-b80d-fec22cd2ac06</BulkInsertId>
      <BulkInsertSessionId>84b43f4d-2945-456f-bae5-3db9daf5ba5f</BulkInsertSessionId>
      <Comment>sample string 2</Comment>
      <CreatedBy>sample string 3</CreatedBy>
      <CreatedOn>sample string 4</CreatedOn>
      <EmployeeId>1</EmployeeId>
      <Id>1</Id>
      <Important>true</Important>
      <IsPinned>sample string 5</IsPinned>
      <ModifiedAt>sample string 6</ModifiedAt>
      <ModifiedBy>sample string 7</ModifiedBy>
      <ParentId>1</ParentId>
    </RelatedNoteDTO>
  </RelatedNotes>
</NoteDTO>

Response Information

Resource Description

The created or updated note.

ActionResultDTOOfNoteDTO

Name	Description	Type	Additional information
Result		NoteDTO	None.
CreatedBy		string	None.
EntityID		integer	None.
RowSource		string	None.
PolicyID		integer	None.
IsSuccess	Signifies whether action is successful	boolean	None.
ErrorCode	Error code	string	None.
ErrorMessage	Error message	string	None.
InfoMessage	Information message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "Id": 1,
    "Comment": "sample string 2",
    "CreatedBy": "sample string 3",
    "EmployeeId": 1,
    "CreatedOn": "sample string 4",
    "ModifiedAt": "sample string 5",
    "ModifiedBy": "sample string 6",
    "ParentId": 1,
    "AssignedPolicyId": 1,
    "AssignedContactId": 7,
    "Important": true,
    "RelatedNotes": [
      {
        "Id": 1,
        "Comment": "sample string 2",
        "CreatedBy": "sample string 3",
        "EmployeeId": 1,
        "CreatedOn": "sample string 4",
        "IsPinned": "sample string 5",
        "ModifiedAt": "sample string 6",
        "ModifiedBy": "sample string 7",
        "ParentId": 1,
        "AssignedPolicyId": 1,
        "AssignedContactId": 8,
        "Important": true,
        "BulkInsertId": "edb656ee-2243-4429-8c6d-8dfc09129418",
        "BulkInsertSessionId": "d2c161d1-1b21-436b-bb03-2fdadbdf0008"
      },
      {
        "Id": 1,
        "Comment": "sample string 2",
        "CreatedBy": "sample string 3",
        "EmployeeId": 1,
        "CreatedOn": "sample string 4",
        "IsPinned": "sample string 5",
        "ModifiedAt": "sample string 6",
        "ModifiedBy": "sample string 7",
        "ParentId": 1,
        "AssignedPolicyId": 1,
        "AssignedContactId": 8,
        "Important": true,
        "BulkInsertId": "edb656ee-2243-4429-8c6d-8dfc09129418",
        "BulkInsertSessionId": "d2c161d1-1b21-436b-bb03-2fdadbdf0008"
      }
    ],
    "BulkInsertId": "fc8ddd3a-58e7-4cd6-9cfd-32fd9abfcb29",
    "BulkInsertSessionId": "14f1e2b1-ca4b-4f30-8d48-1e0101b22e5f",
    "IsPinned": true,
    "NotesHistories": [
      {
        "NoteHistoryId": 1,
        "NoteId": 2,
        "VersionId": 1,
        "NoteText": "sample string 3",
        "CreatedBy": "sample string 4",
        "CreatedAt": "2026-08-19T11:30:51.359146+00:00",
        "Important": true,
        "IsPinned": true
      },
      {
        "NoteHistoryId": 1,
        "NoteId": 2,
        "VersionId": 1,
        "NoteText": "sample string 3",
        "CreatedBy": "sample string 4",
        "CreatedAt": "2026-08-19T11:30:51.359146+00:00",
        "Important": true,
        "IsPinned": true
      }
    ]
  },
  "CreatedBy": "sample string 1",
  "EntityID": 2,
  "RowSource": "sample string 3",
  "PolicyID": 4,
  "IsSuccess": true,
  "ErrorCode": "sample string 6",
  "ErrorMessage": "sample string 7",
  "InfoMessage": "sample string 8"
}

application/xml, text/xml

Sample:

<ActionResultOfNoteDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 6</ErrorCode>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InfoMessage>sample string 8</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 1</CreatedBy>
  <EntityID>2</EntityID>
  <PolicyID>4</PolicyID>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts">
    <d2p1:AssignedContactId>7</d2p1:AssignedContactId>
    <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
    <d2p1:BulkInsertId>fc8ddd3a-58e7-4cd6-9cfd-32fd9abfcb29</d2p1:BulkInsertId>
    <d2p1:BulkInsertSessionId>14f1e2b1-ca4b-4f30-8d48-1e0101b22e5f</d2p1:BulkInsertSessionId>
    <d2p1:Comment>sample string 2</d2p1:Comment>
    <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
    <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
    <d2p1:EmployeeId>1</d2p1:EmployeeId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Important>true</d2p1:Important>
    <d2p1:IsPinned>true</d2p1:IsPinned>
    <d2p1:ModifiedAt>sample string 5</d2p1:ModifiedAt>
    <d2p1:ModifiedBy>sample string 6</d2p1:ModifiedBy>
    <d2p1:NotesHistories>
      <d2p1:NotesHistoryDTO>
        <d2p1:CreatedAt>2026-08-19T11:30:51.359146+00:00</d2p1:CreatedAt>
        <d2p1:CreatedBy>sample string 4</d2p1:CreatedBy>
        <d2p1:Important>true</d2p1:Important>
        <d2p1:IsPinned>true</d2p1:IsPinned>
        <d2p1:NoteHistoryId>1</d2p1:NoteHistoryId>
        <d2p1:NoteId>2</d2p1:NoteId>
        <d2p1:NoteText>sample string 3</d2p1:NoteText>
        <d2p1:VersionId>1</d2p1:VersionId>
      </d2p1:NotesHistoryDTO>
      <d2p1:NotesHistoryDTO>
        <d2p1:CreatedAt>2026-08-19T11:30:51.359146+00:00</d2p1:CreatedAt>
        <d2p1:CreatedBy>sample string 4</d2p1:CreatedBy>
        <d2p1:Important>true</d2p1:Important>
        <d2p1:IsPinned>true</d2p1:IsPinned>
        <d2p1:NoteHistoryId>1</d2p1:NoteHistoryId>
        <d2p1:NoteId>2</d2p1:NoteId>
        <d2p1:NoteText>sample string 3</d2p1:NoteText>
        <d2p1:VersionId>1</d2p1:VersionId>
      </d2p1:NotesHistoryDTO>
    </d2p1:NotesHistories>
    <d2p1:ParentId>1</d2p1:ParentId>
    <d2p1:RelatedNotes>
      <d2p1:RelatedNoteDTO>
        <d2p1:AssignedContactId>8</d2p1:AssignedContactId>
        <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
        <d2p1:BulkInsertId>edb656ee-2243-4429-8c6d-8dfc09129418</d2p1:BulkInsertId>
        <d2p1:BulkInsertSessionId>d2c161d1-1b21-436b-bb03-2fdadbdf0008</d2p1:BulkInsertSessionId>
        <d2p1:Comment>sample string 2</d2p1:Comment>
        <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
        <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
        <d2p1:EmployeeId>1</d2p1:EmployeeId>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Important>true</d2p1:Important>
        <d2p1:IsPinned>sample string 5</d2p1:IsPinned>
        <d2p1:ModifiedAt>sample string 6</d2p1:ModifiedAt>
        <d2p1:ModifiedBy>sample string 7</d2p1:ModifiedBy>
        <d2p1:ParentId>1</d2p1:ParentId>
      </d2p1:RelatedNoteDTO>
      <d2p1:RelatedNoteDTO>
        <d2p1:AssignedContactId>8</d2p1:AssignedContactId>
        <d2p1:AssignedPolicyId>1</d2p1:AssignedPolicyId>
        <d2p1:BulkInsertId>edb656ee-2243-4429-8c6d-8dfc09129418</d2p1:BulkInsertId>
        <d2p1:BulkInsertSessionId>d2c161d1-1b21-436b-bb03-2fdadbdf0008</d2p1:BulkInsertSessionId>
        <d2p1:Comment>sample string 2</d2p1:Comment>
        <d2p1:CreatedBy>sample string 3</d2p1:CreatedBy>
        <d2p1:CreatedOn>sample string 4</d2p1:CreatedOn>
        <d2p1:EmployeeId>1</d2p1:EmployeeId>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Important>true</d2p1:Important>
        <d2p1:IsPinned>sample string 5</d2p1:IsPinned>
        <d2p1:ModifiedAt>sample string 6</d2p1:ModifiedAt>
        <d2p1:ModifiedBy>sample string 7</d2p1:ModifiedBy>
        <d2p1:ParentId>1</d2p1:ParentId>
      </d2p1:RelatedNoteDTO>
    </d2p1:RelatedNotes>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfNoteDTO>