These docs are for v1.0.0. Click to read the latest docs for v2.0.0.

Create a note

Creates a new note in Productboard

Whenever the email field is mentioned in the descriptions of this endpoint, it is referring to the field user.email or customer_email

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Note to add

string
required
string
required

HTML-encoded rich text supported by certain tags; unsupported tags will be stripped out

string
deprecated

Use the user.email property instead.

Email address of customer to attach to the note - will use an existing customer record if one is found, otherwise will create one with the specified email address within a company with matching domain (if it already exists).

This field can't be combined with neither company.domain nor user.email.

url

For entities that originated in external systems and entered Productboard via the API or integrations, a url where the external entity can be accessed - displayed as a clickable title in the Productboard UI.

user
object
company
object

The company to be associated with the note.

source
object

For entities that originated in external systems and entered Productboard via the API or integrations, the source keeps track of the original source entity in that origin system(s). Once this is set, it cannot be updated by design. It’s a reference to an external system, and if that reference changes to another external resource, we consider it as different Note. The recommended way is to create a new note that will refer to different origins.

owner
object

The user to add as an owner to the note.

Productboard will try to find an existing user with the given email address and add them as an owner to the note. If no user is found, an error will be thrown.

tags
array of strings

A set of tags for categorizing the note; tag uniqueness is case- and diacritic-insensitive, so Apple, APPLE, and äpple will all end up assigned to the same tag, and the tag displayed will be whichever variant was first (chronologically) entered into Productboard

tags
Headers
integer
enum
required

API version.

Allowed:
string

A unique string identifying the external system through which the data came.

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json; charset=utf-8
*/*