Resource URL

Post Body

Fields

Description of the idea. Can include HTML markup. Either a description or title is required otherwise a 400 will be returned

title

string

Yes if description is not supplied

Title of the idea. Can include HTML markup. Either a description or title is required otherwiese a 400 error will be returned

creator

hash

Yes

The key used is “id” and the value is the user id of someone with a role in the account who will be set as the creator of the idea. The user ids for an account can be fetched using the GET /users endpoint

business_case

hash

No

The business case has two keys: “problem” with a value that is a string describing the problem being solved and “value” with a value that is a string describing the value of solving this problem. Both values will accept HTML

functional

string

No

The functional specs for the idea. HTML is valid for this field

functional

string

No

The functional specs for the idea. HTML is valid for this field

notes

string

No

Notes on the idea. HTML is valid for this field.

user_stories

array of hashes

No

Each hash has two keys: “story” which has a string value and “acceptance_criteria” which has a string value. HTML is valid for both key values. This field is not required.

comments

array of hashes

No

Each hash has two keys: “comment” which has a string value and “user_id” which has a integer value and is one of the user ids with a role in the account. The user ids can be fetched using the GET /users endpoint.

products

array of hashes

No

Each hash contains one key “id” which has an integer value. This is the product id that you want to associate the idea too. The product ids can be fetched using the GET /products endpoint

personas

array of hashes

No

Each hash contains one key “id” which has an integer value. This is the product id that you want to associate the idea too. The persona ids can be fetched using the GET /personas endpoint

tags

array of hashes

No

Each hash contains one key “id” which has an integer value. This is the tag id that you want to add to the idea. The tag ids can be fetched using GET /tags endpoint.

external_links

array of hashes

No

Each hash has three keys: “external_id” which has a string value, “title” which has a string value and “url” which has a string value.

status

hash

No

The hash contains the key “id” which has an integer value. This is the status id that you want added to the idea. The status ids can be fetched using GET /statues endpoint

state

hash

No

Can be used to set the idea to being “active” (default), “active_public” (shown on the CFP portal) or “archived”.