Adding notes to a contact

To add a note to a contact in Core, you will need the following permissions:

Cases - Write
Contact - Write
Bids - Write
Notes - Write

Use the following endpoint:

POST /flow/api/Notes

and include a request body similar to:

{
    "Message":"Some descriptive note.",
    "ContactIds":[123123],
    "SharedWithCaseIds":[],
    "OwnerId":123123,
    "OwnerType":"Contact"
}

You should retrieve a response similar to:

{
    "Id": 29071,
    "Message": "Some descriptive note.",
    "CreatedDate": "2024-11-19T09:50:33.4691773+01:00",
    "CreatedById": 999888,
    "NoteType": "Overview",
    "ContactIds": [
        123123
    ],
    "CaseIds": [],
    "BidIds": [],
    "InvoiceSerialNumbers": [],
    "IsBidComment": false,
    "IsImportant": false,
    "NoteParentType": "Stakeholder",
    "IsReadOnly": false,
    "OwnerCaseType": "Unknown"
}

Editing an existing note

If you need to edit an existing note, you will need the same permissions as if you’re adding a note.

Use the following endpoint after replacing {noteId} with the ID of any note.

PATCH /flow/api/Notes/{noteId}

{
    "Message":"An even more descriptive note",
    "IsImportant":false,
    "NoteType":"Overview",
    "OwnerType":"Contact",
    "CaseIds":[],
    "ContactIds":[123123]
}

Unless you want to remove or edit all related IDs to the note, make sure to include the existing ContactIds of the note in the PATCH request.

You should get a response similar to:

{
    "Id": 29071,
    "Message": "An even more descriptive note",
    "CreatedDate": "2024-11-19T09:50:33.4691773+01:00",
    "CreatedById": 999888,
    "NoteType": "Overview",
    "ContactIds": [
        123123
    ],
    "CaseIds": [],
    "BidIds": [],
    "InvoiceSerialNumbers": [],
    "IsBidComment": false,
    "IsImportant": false,
    "NoteParentType": "Stakeholder",
    "IsReadOnly": false,
    "OwnerCaseType": "Unknown"
}

Including a case relation to a Note

As described under ‘Notes’, a note can be attached to multiple contacts, cases, or bids at a time.

If you want to attach a note to one or several cases when creating a note, include it in CaseIds similar to:

POST /flow/api/Notes

{
    "Message":"Some descriptive note.",
    "ContactIds":[123123],
    "CaseIds":[222333]
    "SharedWithCaseIds":[],
    "OwnerId":123123,
    "OwnerType":"Contact"
}

You should get a response similar to:

{
    "Id": 29072,
    "Message": "a pretty good note",
    "CreatedDate": "2024-11-19T10:08:01.4720027+01:00",
    "CreatedById": 999888,
    "NoteType": "Overview",
    "ContactIds": [
        123123
    ],
    "CaseIds": [
        222333
    ],
    "BidIds": [],
    "InvoiceSerialNumbers": [],
    "IsBidComment": false,
    "IsImportant": false,
    "NoteParentType": "Stakeholder",
    "IsReadOnly": false,
    "OwnerCaseType": "Unknown"
}

The will be attached to both a contact and a case.