How to Create Ideas via the Ideanote API

Updated 11 months ago by Ideanote

You can find the full API documentation at developer.ideanote.io

Introduction

The Ideanote API is organized around REST. Our API has predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The API is versioned to ensure backwards compatibility: the current version is v1. Note that the query parameter “fields” is required for most endpoints.

For basics on how to authenticate, see this article.

Idea Model

FIELD

TYPE

DESCRIPTION

id

Id

Unique identifier for the Item

createdAt

ISODate

An ISODate describing when this idea was created

updatedAt

ISODate

An ISODate describing when this idea was last updated

friendlyId

Number

An easy to read, workspace-unique identifier for the Item

stats

FIELD	TYPE	DESCRIPTION
`likes.total`	Number

Stats regarding the idea

fields

FIELD	TYPE	DESCRIPTION
`kind`	`"ATTACHMENTS" \| "SELECT" \| "RADIO" \| "NUMERIC" \| "LONG_TEXT" \| "SHORT_TEXT" \| "CHECKMARK" \| "SLIDER"`	The type of idea field
`title`	String	The title of idea field
`value`	`number \| string \|` `Media`	The value of idea field

An array of field items that describes the content of the idea

keywords

String[]

Keywords of the idea extracted from the content of the idea

mission

Mission

The mission of the idea

owner

User

The owner of the idea

isLiked

Boolean

A boolean describing if the authorized user has liked the idea

Create a new Idea

POST /v1/missions/<mission_id>/ideas

The content of an idea consists of idea fields. As each mission can have a different idea field templates, the fields that define the schema creating ideas are based on the Mission that it needs to be created in. In order to create an idea with fields you will have to send a JSON body with keys being the title of the idea fields. For example, if you want to fill out an idea field with the title Describe your idea the JSON body will have to look like the following:

{ "Describe your idea": "This is a description of my idea" }

Idea fields can have different types (eg. you want the user to fill out a number or select from a list of options). This is a list of how different field types should be filled out:

FIELD TYPE

DESCRIPTION

Short Text

Long Text

The expected value type of this field type is a string

{ "Describe your idea": "This is a description of my idea" }

Numeric

The expected value type of this field type is a number

{ "How many days will it take to build your idea?": 15 }

Attachment

The expected value type of this field type is a string array

{ "Please upload attachments": ["https://assets-global.website-files.com/60058af53d79fbd8e14841ea/606325aaa86c5c3f9081365c_ideanote-logomark-obsidian.png"] }

Checkmark

The expected value type of this field type is a string array

{ "Where can your idea be used?": ["Kitchen", "Bathroom] }

Radio

Select

The expected value type of this field type is a string

{ "Choose category": "Marketing" }

Example Request

The following example shows how to use the API to create an idea for the following idea prompt.

curl "https://api.ideanote.io/v1/missions/7aa21216-0f70-4ec6-a521-53ced10530ac/ideas?fields=id" \
  -H "Authorization: Bearer bed5a85927285aaf6e85aa1c7eb62a" \
  -H "Content-Type: application/json" \
  -d '{
    "Give your idea a title": "My great idea",
    "Describe your idea": "This is a description of my idea",
    "Upload some images": [
        "https://assets-global.website-files.com/60058af53d79fbd8e14841ea/606325aaa86c5c3f9081365c_ideanote-logomark-obsidian.png"
    ],
    "How many days will it take to develop your idea?": 12,
    "Choose areas": ["Sales", "Marketing"],
    "What best describes your idea?": "Low hanging fruit"
}'

How to Create Ideas via the Ideanote API

Introduction

Idea Model

Create a new Idea

Example Request

How did we do?

Related Articles

Contact