Create note

Creates a new note in your workspace. Notes represent individual pieces of feedback from customers, internal teams, or external systems.

You must specify the type of note you're creating:

  • "simple" – for plain, unstructured notes
  • "conversation" – for structured messages (e.g., from chat, email, or support systems)

Notes of type opportunity cannot be created via the API.

Field Requirements and Configuration

The fields.name attribute is required for all note types. Other fields depend on the selected note type and your workspace configuration. Use the /v2/notes/configuration endpoint to discover available fields for each type.

Notes can also be linked to Customers entities or Product hierarchy items (like features) via relationships.

Code examples

Replace <your-token> with a valid API token.

Create a simple note with name and content:

curl -X POST "https://api.productboard.com/v2/notes" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "type": "simple",
      "fields": {
        "name": "Feedback about dashboard filters",
        "content": "It would be great if I could filter the dashboard by region."
      }
    }
  }'

Create a conversation note with one message, a tag, and an owner:

curl -X POST "https://api.productboard.com/v2/notes" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "type": "conversation",
      "fields": {
        "name": "Conversation Note",
        "content": [
          {
            "externalId": "000",
            "content": "Hello",
            "timestamp": "2023-10-01T11:00:00Z",
            "authorType": "agent"
          }
        ],
        "tags": [
          { "name": "support" }
        ],
        "owner": {
          "email": "[email protected]"
        }
      }
    }
  }'
Language
Credentials
Header
Click Try It! to start a request and see the response here!