# About the Notes API

The Notes API allows you to create and manage notes associated with a specific contact on a site. Notes allow Wix users to document interactions, meetings, phone calls, and other important details about their contacts. This helps Wix users become more organized and provide relevant context for future interactions with their contacts. 

With the Notes API, you can:
- Create, update, and delete notes associated with a contact. 
- Retrieve and query notes. 

## Before you begin

It's important to note the following points before starting to code: 

- All notes must be associated with a contact. When creating a note, you need to specify an existing contact ID. 
- The maximum size of a note's text is 2048 characters. 

## Use cases

- [Add custom note-taking functionality](fallback::https://dev.wix.com/docs/rest/crm/members-contacts/contacts/notes/notes-v2/sample-flows/#add-custom-note-taking-functionality)
- [Sync notes between your app and Wix](fallback::https://dev.wix.com/docs/rest/crm/members-contacts/contacts/notes/notes-v2/sample-flows/#sync-notes-between-your-app-and-wix)


## Terminology
- **Note**: A text-based record associated with a contact that documents interactions, meetings, calls, or other important information.
- **Note type**: Optional classification for organizing notes by their purpose: 
    - `NOT_SET`: General notes about a contact.
    - `MEETING_SUMMARY`: Summary notes following a meeting with a contact. 
    - `CALL_SUMMARY`: Summary notes following a call with a contact.

# Notes API: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. These flows provide a helpful jumping-off point as you plan your implementation.

## Add custom note-taking functionality

You can create custom note-taking capabilities to help Wix users document interactions with their contacts.

To add custom note-taking functionality:

1. When a Wix user creates or selects a contact, get the contact's ID to create notes associated with that contact.

2. Provide a form where Wix users can enter note text and select a note type from a dropdown for organizational purposes.

3. Call [Create Note](fallback::https://dev.wix.com/docs/rest/crm/members-contacts/contacts/notes/notes-v2/create-note) with the contact ID, note text, and selected type to save the note.

4. Call [Query Notes](fallback::https://dev.wix.com/docs/rest/crm/members-contacts/contacts/notes/notes-v2/query-notes) with the contact ID, to display existing notes sorted by created date.

5. Allow Wix users to edit notes by calling [Get Note](fallback::https://dev.wix.com/docs/rest/crm/members-contacts/contacts/notes/notes-v2/get-note) to retrieve current content, then calling [Update Note](fallback::https://dev.wix.com/docs/rest/crm/members-contacts/contacts/notes/notes-v2/update-note) with the revised information and current revision number.

## Sync notes between your app and Wix

Your app already has its own notes system and you want to synchronize notes bidirectionally with Wix contacts.

To sync notes between your app and Wix:

1. Map your existing contacts to Wix contact IDs and store this mapping in your database.

2. When a Wix user creates a note in your app, call [Create Note](fallback::https://dev.wix.com/docs/rest/crm/members-contacts/contacts/notes/notes-v2/create-note) to add the note to the corresponding Wix contact.

3. Periodically call [Query Notes](fallback::https://dev.wix.com/docs/rest/crm/members-contacts/contacts/notes/notes-v2/query-notes) for each mapped contact to retrieve new notes created in Wix since your last sync.

4. Import new notes from Wix into your app's database, avoiding duplicates by checking note IDs.

5. Handle updates by comparing revision numbers and calling [Update Note](fallback::https://dev.wix.com/docs/rest/crm/members-contacts/contacts/notes/notes-v2/update-note) when notes have been modified.

# Notes: Supported Filters and Sorting

The following table shows field support and sorting for the note object:

| Field | Supported Filters | Sortable |
|-------|-------------------| -------- |
| `id` | `$eq`, `$in` |
| `type` | `$eq`, `$in`, `$ne`, `$nin` |
| `contactId` | `$eq`, `$in` |
| `createdDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |
| `updatedDate` | `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$nin`, `$exists` | Sortable |


## Related Content

- [API Query Language](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::8158a590-f60c-4606-9fed-16a34e275f3a*fallback::https://dev.wix.com/api/rest/getting-started/api-query-language)
- [Query Notes](fallback::https://dev.wix.com/docs/rest/crm/members-contacts/contacts/notes/notes-v2/query-notes)