Skip to content

Edit a note

Tool name: edit_note

Changes one of the member’s own notes on a customer. A member cannot edit anyone else’s note, or a note synced from a CRM other than Salesforce. Take the note’s id from list_customer_notes. Only the fields given change: a null title removes it, and userIds or contactIds replace the people linked to the note. Confirm the changes with the person first.

Input schema

customerstring, non-emptyrequired

The name of the customer, its ID, or its ID in a CRM or another source written as source:ID, such as salesforce:0010x000000aAAA. Use an ID when you have one; a name must match one customer

noteIdinteger, ( 0 .. 9007199254740991 ]required

The id of the note, as returned by list_customer_notes

categoryIdinteger, ( 0 .. 9007199254740991 ]

The new category of the note

titlestring or null
Any of:

The new title of the note, or null to remove it

[ 1 .. 200 ] characters
string
bodystring, [ 1 .. 20000 ] characters

The new text of the note

userIdsArray of integers

The users at the customer the note is about

contactIdsArray of integers

The contacts at the customer the note is about

Input example
{ "customer": "string", "noteId": 1, "categoryId": 1, "title": "string", "body": "string", "userIds": [ 1 ], "contactIds": [ 1 ] }