> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # UpdateNote # Package: notes # Namespace: Notes # Method link: https://dev.wix.com/docs/api-reference/crm/members-contacts/contacts/notes/notes-v2/update-note.md ## Permission Scopes: Manage Notes: SCOPE.DC-CRM.MANAGE-NOTES ## Introduction Updates a note. This method supports partial updates. To prevent conflicting changes, the current revision must be passed when updating the note. --- ## REST API ### Schema ``` Method: updateNote Description: Updates a note. This method supports partial updates. To prevent conflicting changes, the current revision must be passed when updating the note. URL: https://www.wixapis.com/crm/notes/v2/notes/{note.id} Method: PATCH # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: note, note.id, note.revision Method parameters: param name: note | type: Note | description: A note contains textual information associated with a contact. | required: true - name: id | type: string | description: Note GUID. | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the note is updated. To prevent conflicting changes, the current revision must be passed when updating the note. | required: true - name: contactId | type: string | description: Contact GUID associated with the note. - name: text | type: string | description: Note text. - name: type | type: NoteType | description: Note type for organizing notes by their purpose. Default: `NOT_SET` - enum: - UNKNOWN_TYPE: Unknown note type. - NOT_SET: Note doesn't have a specific classification. - MEETING_SUMMARY: Note is a summary of a meeting related to the contact. - CALL_SUMMARY: Note is a summary of a call related to the contact. Return type: UpdateNoteResponse - name: note | type: Note | description: Updated note. - name: id | type: string | description: Note GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the note is updated. To prevent conflicting changes, the current revision must be passed when updating the note. - name: createdDate | type: string | description: Date and time the note was created. - name: updatedDate | type: string | description: Date and time the note was last updated. - name: contactId | type: string | description: Contact GUID associated with the note. - name: text | type: string | description: Note text. - name: type | type: NoteType | description: Note type for organizing notes by their purpose. Default: `NOT_SET` - enum: - UNKNOWN_TYPE: Unknown note type. - NOT_SET: Note doesn't have a specific classification. - MEETING_SUMMARY: Note is a summary of a meeting related to the contact. - CALL_SUMMARY: Note is a summary of a call related to the contact. - name: source | type: NoteSource | description: Information about who created the note. - name: sourceType | type: SourceType | description: Note creator. - enum: UNKNOWN_SOURCE_TYPE, APP, USER - name: appId | type: string | description: App GUID, if the note was created by an app. - name: userId | type: string | description: User GUID, if the note was created by a Wix user. ``` ### Examples ### Update Note Updates a new Note ```curl curl -X PATCH \ 'https://www.wixapis.com/crm/notes/v2/notes/547bb310-8e15-45d2-8118-aa272dcb1d75' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ --data-raw ' { "note": { "id": "95c3f7cf-ee34-49cd-9c14-020fdb4ce442", "revision": "1", "text": "Sample updated text of a note", "type": "CALL_SUMMARY" } }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.notes.Notes.updateNote(_id, note) Description: Updates a note. This method supports partial updates. To prevent conflicting changes, the current revision must be passed when updating the note. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: note, _id, note.revision Method parameters: param name: _id | type: string | description: Note GUID. | required: true param name: note | type: UpdateNote | description: A note contains textual information associated with a contact. | required: true - name: revision | type: string | description: Revision number, which increments by 1 each time the note is updated. To prevent conflicting changes, the current revision must be passed when updating the note. | required: true - name: contactId | type: string | description: Contact GUID associated with the note. - name: text | type: string | description: Note text. - name: type | type: NoteType | description: Note type for organizing notes by their purpose. Default: `NOT_SET` - enum: - UNKNOWN_TYPE: Unknown note type. - NOT_SET: Note doesn't have a specific classification. - MEETING_SUMMARY: Note is a summary of a meeting related to the contact. - CALL_SUMMARY: Note is a summary of a call related to the contact. Return type: PROMISE - name: _id | type: string | description: Note GUID. - name: revision | type: string | description: Revision number, which increments by 1 each time the note is updated. To prevent conflicting changes, the current revision must be passed when updating the note. - name: _createdDate | type: Date | description: Date and time the note was created. - name: _updatedDate | type: Date | description: Date and time the note was last updated. - name: contactId | type: string | description: Contact GUID associated with the note. - name: text | type: string | description: Note text. - name: type | type: NoteType | description: Note type for organizing notes by their purpose. Default: `NOT_SET` - enum: - UNKNOWN_TYPE: Unknown note type. - NOT_SET: Note doesn't have a specific classification. - MEETING_SUMMARY: Note is a summary of a meeting related to the contact. - CALL_SUMMARY: Note is a summary of a call related to the contact. - name: source | type: NoteSource | description: Information about who created the note. - name: sourceType | type: SourceType | description: Note creator. - enum: UNKNOWN_SOURCE_TYPE, APP, USER - name: appId | type: string | description: App GUID, if the note was created by an app. - name: userId | type: string | description: User GUID, if the note was created by a Wix user. ``` ### Examples ### updateNote ```javascript import { notes } from '@wix/crm'; async function updateNote(_id,note) { const response = await notes.updateNote(_id,note); }; ``` ### updateNote (with elevated permissions) ```javascript import { notes } from '@wix/crm'; import { auth } from '@wix/essentials'; async function myUpdateNoteMethod(_id,note) { const elevatedUpdateNote = auth.elevate(notes.updateNote); const response = await elevatedUpdateNote(_id,note); } ``` ### updateNote (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { notes } from '@wix/crm'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { notes }, // Include the auth strategy and host as relevant }); async function updateNote(_id,note) { const response = await myWixClient.notes.updateNote(_id,note); }; ``` ---