v1

latestOpenAPI 3.1.1Productboard Proprietary2026-07-2453178243.2 KB
notes

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:

  • "textNote" - for plain, unstructured notes
  • "conversationNote" - for structured messages (e.g., from chat, email, or support systems)

Legacy aliases (simple, conversation, opportunity) are accepted on input and normalized before business rules are applied.

⚠️ Notes of type opportunityNote 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/configurations endpoint to discover available fields for each type.

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

post/notes

Request body

Example request

{
  "data": {
    "type": "textNote",
    "metadata": {
      "source": {
        "system": "zendesk",
        "recordId": "ticket-999",
        "url": "https://example.zendesk.com/tickets/999"
      }
    },
    "relationships": [
      {
        "target": {
          "type": "user"
        }
      }
    ]
  }
}

Response

Note created successfully

Example response

{
  "data": {
    "type": "textNote",
    "links": {
      "self": "https://api.productboard.com/v2/notes/123e4567-e89b-12d3-a456-426614174000",
      "html": "https://example.productboard.com/all-notes/notes/42"
    }
  }
}