GET idea

Get data of one idea object.

Parameters

Parameters	Detail
with optional	Returns sub-object or count of sub-objects relating to the idea. If sub-object is requested, response will return the first 20 records Accepted value: "additional_questions", "tag_count", "tags", "promote_count", "promotes", "demote_count", "demotes", "comment_count", "comments", "admin_fields"
format optional	Specifies returned data format Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for GET idea

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/idea/{id}

Access Permission

Access to data varies base on system setting and requester roles. See Authentication for details on authentication.

Private WebStorms: Requester must authenticate to get data.

Public WebStorms: No authentication required to get data.

Requster Role: Some response attributes are accessible base on the requester's role.

Hidden idea: Returns for Admin only
Hidden comment: Returns for Admin only
Hidden comment count: hidden comments are included in count for Admin only
Anonymous idea: Submitter data returns for authorized requester. Authoriztion is defined in WebStorm setting.

Errors

Invalid object ID or you don't have access to this object

Example Request

Method: GET
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

URL: https://example.brightidea.com/api3/idea/E62DB922-55EE-419D-9CB9-4C4DD8243ADA?with=additional_questions

{
"idea": {
    "id": "E62DB922-55EE-419D-9CB9-4C4DD8243ADA",
    "date_created": "2013-04-15 15:42:39.360",
    "date_modified": "2013-04-16 15:05:03.773",
    "title": "Test Idea Title",
    "description": "Test Idea Description.",
    "visible": true,
    "anonymous": false,
    "idea_code": "D629",
    "score": 1,
    "member": {
        "id": "866144B1-E302-42EF-AF80-75DE988885AE",
        "email": "jdoe@example.com",
        "screen_name": "John Doe",
        "first_name": "John",
        "last_name": "Doe",
        "job_title": "Sales",
        "address": "123 fake street",
        "phone": "(123) 456-789",
        "mobile_phone": "(987) 654-3210",
        "external_user_id": "",
        "skills": "Selling Software",
        "work_history": "Worked at sales.com",
        "photo_url": null,
        "date_created": "2013-03-07 19:09:54.563",
        "date_modified": "2013-04-16 14:36:57.613",
        "active": true
    },
    "category": {
        "id": "C893B9AF-0622-4568-B56F-77600DE1EFAC",
        "name": "Category 2"
    },
    "status": {
        "id": "D329EF01-D051-40AB-BB18-F13C03F3BE9C",
        "name": "Status 1"
    },
    "campaign": {
        "id": "0A140858-AD8A-4F97-9926-D80AD156A130",
        "name": "Sample Campaign",
        "description": "Sample Campaign Description",
        "date_created": "2013-03-07 17:10:38.107"
    },
    "attachments": [
        {
            "id": "551EDEC7-339B-4A61-BC21-3C6F5A03AD30",
            "reference_id": "D0B723EB-4C9E-48D5-A227-A092D4B7C932",
            "extension": "jpg",
            "original_filename": "example.JPG",
            "grouping": "IDEA",
            "url": "https://example.brightideatest.com/api3/file/551EDEC7-339B-4A61-BC21-3C6F5A03AD30?format=binary",
            "type": "image/jpeg"
        }
    ],
    "additional_questions": [
        {
            "id": "BD6EC5D5-28D3-4BAF-B73F-35C0BD8E6513",
            "description": "Radio question 1?",
            "required": true,
            "type": "radio",
            "response_text": " Radio answer C",
            "options": [
                {
                    "id": "B68AED9A-4528-402B-B297-5152CB592639",
                    "description": "Radio answer A",
                    "order": "1",
                    "selected": false
                },
                {
                    "id": "47D3F670-4F6F-4E8F-8EB5-693FDFA39A4F",
                    "description": "Radio answer B",
                    "order": "2",
                    "selected": false
                },
                {
                    "id": "1C725C5D-6E30-4B16-B35C-4E280FC8E36C",
                    "description": "Radio answer C",
                    "order": "3",
                    "selected": false
                }
            ]
        },
        {
            "id": "FF644DF7-A8FA-4795-8F59-003F4AE0981A",
            "description": "Checkbox question 2",
            "required": false,
            "type": "checkbox",
            "response_text": "Checkbox answer B ,Checkbox answer A",
            "options": [
                {
                    "id": "131A27BB-0131-4081-BCA0-F3CE92C6A7A0",
                    "description": "Checkbox answer A",
                    "order": "1",
                    "selected": true
                },
                {
                    "id": "976603C0-A84B-48BD-AFFC-9D5413BF5CD0",
                    "description": "Checkbox answer B",
                    "order": "2",
                    "selected": true
                },
                {
                    "id": "91F7529F-291C-4812-98C4-B9F3275635A5",
                    "description": "Checkbox answer C",
                    "order": "3",
                    "selected": false
                }
            ]
        },
        {
            "id": "ACDB0D67-987E-4D90-A022-D1336E4DD1AF",
            "description": "Short answer question 3",
            "required": false,
            "type": "text",
            "response_text": "Test short answer"
        },
        {
            "id": "2C28E088-D7F8-4E7A-8BA4-8E104CDAE4E9",
            "description": "Long text question 4",
            "required": false,
            "type": "textarea",
            "response_text": "Test long answer"
        },
        {
            "id": "53EF3BEA-90BF-446B-800C-9F7E60CD8555",
            "description": "Dropdown question 5",
            "required": true,
            "type": "select",
            "response_text": "Dropdown answer D",
            "options": [
                {
                    "id": "912EE8FC-57C8-4A88-AA85-48627639E9C4",
                    "description": "Dropdown answer A",
                    "order": "1",
                    "selected": false
                },
                {
                    "id": "9F332A68-9396-4411-9D6C-1C9986320654",
                    "description": "Dropdown answer B",
                    "order": "2",
                    "selected": false
                },
                {
                    "id": "4C3FEECD-469F-4830-BD4F-49FEE484CE31",
                    "description": "Dropdown answer C",
                    "order": "3",
                    "selected": false
                },
                {
                    "id": "5D431D0E-7453-4783-8257-3F96B2F0E6F0",
                    "description": "Dropdown answer D",
                    "order": "4",
                    "selected": true
                }
            ]
        }
    ]
}
}

LIST idea

Get data on a list of idea objects. Objects are order by created date descending by default.

On retrieving large set of data, requester should use pagination parameters such as page and page_size to manage multiple requests.

Parameters

Parameters	Detail
id optional	Filter return by idea ID Sample value: "11111111-1111-1111-1111-111111111111"
idea_code optional	Filter return by idea code Sample value: "D123"
title optional	Filter return by idea title Sample value: "Great Idea Title"
date_created optional	Filter return by idea created date. Response contains all ideas created within the 24 hours of the specified date Sample value: "12/06/2009"
date_modified optional	Filter return by member last modified date. Response contains all ideas modified within the 24 hours of the specified date Sample value: "12/06/2009"
category_id optional	Filter return by ID of category Sample value: "11111111-1111-1111-1111-111111111111"
status_id optional	Filter return by ID of status Sample value: "11111111-1111-1111-1111-111111111111"
member_id optional	Filter return by ID of idea submitter Sample value: "11111111-1111-1111-1111-111111111111"
tag_id optional	Filter return by ID of a tag Sample value: "11111111-1111-1111-1111-111111111111"
campaign_id optional	Filter return by ID of a campaign Sample value: "11111111-1111-1111-1111-111111111111"
visible optional	Filter return by idea visibility state. Parameter is for Admin only Accepted Value: 1: For shown, 0: For hidden
anonymous optional	Filter return by anonymous submission Accepted Value: 1: For anonymous, 0: For not anonymous
page_size optional	Specifies number of records returns per page. Default: 20. Minimum: 1. Maximum: 100 Sample value: 50
page optional	Specifies which page of records to return. Default: 1. Minimum: 1. Maximum: {page_count} Sample value: 5
order optional	A SQL style string that specifies the order the records should return in Sample value: "date_created ASC, idea_code DESC" Accepted attributes: "id", "idea_code", "title", "date_created", "date_modified", "visible", "anonymous", "score", "random"
with optional	Returns sub-object or count of sub-objects relating to the member. If sub-object is requested, response will return the first 20 records Accepted value: "tags", "tag_count", "promote_count", "demote_count", "comment_count"
format optional	Specifies returned data format Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for LIST idea

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/idea

Access Permission

Access to data varies base on system setting and requester roles. See Authentication for detail on authentication.

Private WebStorms: Requester must authenticate to get data.

Public WebStorms: No authentication required to get data.

Requster Role: Some response attributes are accessible base on the requester's role.

Hidden idea: Returns for Admin only
Hidden comment count: hidden comments are included in count for Admin only
Anonymous idea: Submitter data returns for authorized requester. Authoriztion is defined in WebStorm setting.

Errors

Invalid object ID or you don't have access to this object

Example Request

Method: GET
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

URL: https://example.brightidea.com/api3/idea?page_size=2&page=4&order=date_created&with=comment_count

{
"idea_list": [
    {
        "id": "E62DB922-55EE-419D-9CB9-4C4DD8243ADA",
        "date_created": "2013-04-15 15:42:39.360",
        "date_modified": "2013-04-16 15:05:03.773",
        "title": "Test Idea Title",
        "description": "Test Idea Description.",
        "visible": true,
        "anonymous": false,
        "idea_code": "D629",
        "score": 1,
        "member": {
            "id": "866144B1-E302-42EF-AF80-75DE988885AE",
            "email": "jdoe@example.com",
            "screen_name": "John Doe",
            "first_name": "John",
            "last_name": "Doe",
            "job_title": "Sales",
            "address": "123 fake street",
            "phone": "(123) 456-789",
            "mobile_phone": "(987) 654-3210",
            "external_user_id": "",
            "skills": "Selling Software",
            "work_history": "Worked at sales.com",
            "photo_url": null,
            "date_created": "2013-03-07 19:09:54.563",
            "date_modified": "2013-04-16 14:36:57.613",
            "active": true
        },
        "category": {
            "id": "C893B9AF-0622-4568-B56F-77600DE1EFAC",
            "name": "Category 2"
        },
        "status": {
            "id": "D329EF01-D051-40AB-BB18-F13C03F3BE9C",
            "name": "Status 1"
        },
        "campaign": {
            "id": "0A140858-AD8A-4F97-9926-D80AD156A130",
            "name": "Sample Campaign",
            "description": "Sample Campaign Description",
            "date_created": "2013-03-07 17:10:38.107"
        },
        "comment_count": 0
    },
    {
        "id": "FBC03CC3-8B53-4BC9-A312-D91C8BA4388E",
        "date_created": "2011-01-18 19:36:00.000",
        "date_modified": "2011-01-18 19:36:00.000",
        "title": "Another Test Idea Title",
        "description": "Another test idea description",
        "visible": true,
        "anonymous": false,
        "idea_code": "D629",
        "score": 1,
        "member": {
            "id": "8FA49B96-3693-4282-8919-014618D7B3B8",
            "email": "mpower@example.com",
            "screen_name": "Max Power",
            "first_name": "Max",
            "last_name": "Power",
            "job_title": "Safety Inspector",
            "address": "742 Evergreen Terrace, Springfield, IL",
            "phone": "(123)456-7890",
            "mobile_phone": "(987)654-3210",
            "external_user_id": "0072",
            "skills": "Boxer, Mascot, Astronaut, Baby proofer, Truck driver, Hippie, Plow Driver, Food Critic",
            "work_history": "Conceptual Artist, Mayor, Country Western Manager, Garbage Commissioner, Mountain Climber",
            "photo_url": "https://example.brightideatest.com/api3/file/CCBCC6A7-98C9-48E1-92F3-0C05AAC78863?format=binary&thumb_size=100",
            "date_created": "2013-03-07 17:10:13.627",
            "date_modified": "2013-03-29 15:25:51.207",
            "active": true,
            "photo_file_id": "CCBCC6A7-98C9-48E1-92F3-0C05AAC78863",
        },
        "category": {
            "id": "C893B9AF-0622-4568-B56F-77600DE1EFAC",
            "name": "Category 2"
        },
        "status": {
            "id": "D329EF01-D051-40AB-BB18-F13C03F3BE9C",
            "name": "Status 1"
        },
        "campaign": {
            "id": "0A140858-AD8A-4F97-9926-D80AD156A130",
            "name": "Sample Campaign",
            "description": "Sample Campaign Description",
            "date_created": "2013-03-07 17:10:38.107"
        },
        "comment_count": 0
    }
],
"stats": {
    "total": "518",
    "page_count": 259,
    "current_page": 4
}
}

CREATE idea

Create a idea object. Make request to the GET postIdea widget function to get all information for idea submission.

Requester must have access to the Campaign in order to create an idea in it.

Parameters

Parameters	Detail
title required	This is the title of the idea. Minimum 1 character, maximum 100 characters. String will be truncated if length exceeds maximum Sample value: "Test idea title"
description required	This is the description of the idea. It's a long text field. Minimum 1 character Sample value: "Test idea description"
campaign_id required	This is the ID of the campaign the idea belongs to Sample value: "11111111-1111-1111-1111-111111111111"
category_id required	This is the ID of the idea category Sample value: "11111111-1111-1111-1111-111111111111"
additional_question see detail	This is the entries for additional questions of the idea. Request accepts question ID as the parameter name, and anwser ID or answer text as value depending on the question type. Parameter is required if answer is required by idea submission form. radio: Radio button choice question. It accepts one answer. Format: {question_id}={answer_id} select: Dropdown choice question. It accepts one answer. Format: {question_id}={answer_id} checkbox: Checkbox choice question. For multiple answers, pass one parameter for each answer. Add "[]" behind each parameter name. Format: {question_id[]}={answer_id_1}, {question_id[]}={answer_id_2}... text: Short answer question. Format: {question_id}={short_answer} textarea: Long text question. Format: {question_id}={long_answer}
status_id optional	This is the ID of the idea status. If not passed, idea will be created with default status Sample value: "11111111-1111-1111-1111-111111111111"
member_id optional	This is the ID of the submitter. Admin only parameter. Admin can create idea on behalf of others Sample value: "11111111-1111-1111-1111-111111111111"
tags optional	This is the tag of the idea. Available if tags is enabled in the campaign. Multiple tags can be passed seperated by comma Sample value: "innovation, technology"
attachment optional	This is the attachment of the idea. Request accepts file object. Maximum 7 MB. To pass multiple attachments, name parameter: attachment1, attachment2... Accepted format: jpg, gif, bmp, png, jpeg, doc, docx, xls, xlsx, ppt, pptx, pdf, avi, wmv, mov, flv, csv, zip
anonymous optional	This is the anonymous state of the idea. It's a long text field Accepted Value: 1: For anonymous, 0: For not anonymous
format optional	Specifies returned data format Accepted value: "json", "xml"

Resource Information

Authentication: Required. See Authentication for details on authentication.

HTTP Methods: POST

Request URL Format: https://{api_domain}/api3/idea

Access Permission

Requester must have access to the Campaign in order to create an idea in it. See Authentication for detail on authentication.

Errors

Campaign ID is required for creating idea
You don't have permission for this campaign
{parameter} must be more than {minimum_length} characters
{parameter} must be less than {maximum_length} characters
Invalid {parameter} received
Missing required parameter
Additional question {question_id} is required

Example Request

Method: POST
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
URL: https://example.brightidea.com/api3/idea

Form data:

title=Test Idea 233
description=Description of test idea 233
campaign_id=0A140858-AD8A-4F97-9926-D80AD156A130
category_id=36E5A3B1-ECD9-48E4-8F43-FB6296F8A2E1
BD6EC5D5-28D3-4BAF-B73F-35C0BD8E6513=1C725C5D-6E30-4B16-B35C-4E280FC8E36C
FF644DF7-A8FA-4795-8F59-003F4AE0981A[]=131A27BB-0131-4081-BCA0-F3CE92C6A7A0
FF644DF7-A8FA-4795-8F59-003F4AE0981A[]=976603C0-A84B-48BD-AFFC-9D5413BF5CD0
ACDB0D67-987E-4D90-A022-D1336E4DD1AF=Short answer of test idea 233
2C28E088-D7F8-4E7A-8BA4-8E104CDAE4E9=Long answer of test idea 233
53EF3BEA-90BF-446B-800C-9F7E60CD8555=5D431D0E-7453-4783-8257-3F96B2F0E6F0

{
"idea": {
    "id": "2666DAB1-1125-4393-8AF7-753FBEFBA148",
    "date_created": "2013-04-16 15:42:39.050",
    "date_modified": "2013-04-16 15:42:39.050",
    "title": "Test Idea #3",
    "description": "Description of test idea #3",
    "visible": true,
    "anonymous": false,
    "idea_code": "D632",
    "score": 0,
    "member": {
        "id": "8FA49B96-3693-4282-8919-014618D7B3B8",
        "email": "lsmith@example.com",
        "screen_name": "Lillian Smith",
        "first_name": "Lillian",
        "last_name": "Smith",
        "job_title": "",
        "address": "",
        "phone": "",
        "mobile_phone": "",
        "external_user_id": "",
        "skills": "",
        "work_history": "",
        "photo_url": "",
        "date_created": "2013-03-07 17:10:13.627",
        "date_modified": "2013-04-16 15:42:16.430",
        "active": true
    },
    "category": {
        "id": "36E5A3B1-ECD9-48E4-8F43-FB6296F8A2E1",
        "name": "Category 5"
    },
    "status": {
        "id": "D329EF01-D051-40AB-BB18-F13C03F3BE9C",
        "name": "Status 1"
    },
    "campaign": {
        "id": "0A140858-AD8A-4F97-9926-D80AD156A130",
        "name": "Sample Campaign",
        "description": "Sample Campaign Description",
        "date_created": "2013-03-07 17:10:38.107"
    },
    "additional_questions": [
        {
            "id": "BD6EC5D5-28D3-4BAF-B73F-35C0BD8E6513",
            "description": "Radio question 1?",
            "required": true,
            "type": "radio",
            "response_text": "Radio answer C",
            "options": [
                {
                    "id": "B68AED9A-4528-402B-B297-5152CB592639",
                    "description": "Radio answer A",
                    "order": "1",
                    "selected": false
                },
                {
                    "id": "47D3F670-4F6F-4E8F-8EB5-693FDFA39A4F",
                    "description": "Radio answer B",
                    "order": "2",
                    "selected": false
                },
                {
                    "id": "1C725C5D-6E30-4B16-B35C-4E280FC8E36C",
                    "description": "Radio answer C",
                    "order": "3",
                    "selected": true
                }
            ]
        },
        {
            "id": "FF644DF7-A8FA-4795-8F59-003F4AE0981A",
            "description": "Checkbox question 2",
            "required": false,
            "type": "checkbox",
            "response_text": "Checkbox answer A ,Checkbox answer B",
            "options": [
                {
                    "id": "131A27BB-0131-4081-BCA0-F3CE92C6A7A0",
                    "description": "Checkbox answer A",
                    "order": "1",
                    "selected": true
                },
                {
                    "id": "976603C0-A84B-48BD-AFFC-9D5413BF5CD0",
                    "description": "Checkbox answer B",
                    "order": "2",
                    "selected": true
                },
                {
                    "id": "91F7529F-291C-4812-98C4-B9F3275635A5",
                    "description": "Checkbox answer C",
                    "order": "3",
                    "selected": false
                }
            ]
        },
        {
            "id": "ACDB0D67-987E-4D90-A022-D1336E4DD1AF",
            "description": "Short answer question 3",
            "required": false,
            "type": "text",
            "response_text": "Short answer of test idea #3"
        },
        {
            "id": "2C28E088-D7F8-4E7A-8BA4-8E104CDAE4E9",
            "description": "Long text question 4",
            "required": false,
            "type": "textarea",
            "response_text": "Long answer of test idea #3"
        },
        {
            "id": "53EF3BEA-90BF-446B-800C-9F7E60CD8555",
            "description": "Dropdown question 5",
            "required": true,
            "type": "select",
            "response_text": "Dropdown answer D",
            "options": [
                {
                    "id": "912EE8FC-57C8-4A88-AA85-48627639E9C4",
                    "description": "Dropdown answer A",
                    "order": "1",
                    "selected": false
                },
                {
                    "id": "9F332A68-9396-4411-9D6C-1C9986320654",
                    "description": "Dropdown answer B",
                    "order": "2",
                    "selected": false
                },
                {
                    "id": "4C3FEECD-469F-4830-BD4F-49FEE484CE31",
                    "description": "Dropdown answer C",
                    "order": "3",
                    "selected": false
                },
                {
                    "id": "5D431D0E-7453-4783-8257-3F96B2F0E6F0",
                    "description": "Dropdown answer D",
                    "order": "4",
                    "selected": true
                }
            ]
        }
    ]
}
}

UPDATE idea

Update an idea. Make request to the GET postIdea widget function to get all information for idea submission.

Function updates only value of parameters passed through request. To empty out an attribute, pass parameter with blank value.

Parameters

Parameters	Detail
title optional	This is the title of the idea. Minimum 1 character, maximum 100 characters. String will be truncated if length exceeds maximum Sample value: "Test idea title"
description optional	This is the description of the idea. It's a long text field. Minimum 1 character
category_id optional	This is the ID of the idea category Sample value: "11111111-1111-1111-1111-111111111111"
additional_question see detail	This is the entries for additional questions of the idea. Request accepts question ID as the parameter name, and anwser ID or answer text as value depending on the question type. Parameter is required if answer is required by idea submission form. radio: Radio button choice question. It accepts one answer. Format: {question_id}={answer_id} select: Dropdown choice question. It accepts one answer. Format: {question_id}={answer_id} checkbox: Checkbox choice question. For multiple answers, pass one parameter for each answer. Add "[]" behind each parameter name. Format: {question_id[]}={answer_id_1}, {question_id[]}={answer_id_2}... text: Short answer question. Format: {question_id}={short_answer} textarea: Long text question. Format: {question_id}={long_answer}
status_id optional	This is the ID of the idea status. If not passed, idea will be created with default status Sample value: "11111111-1111-1111-1111-111111111111"
tags optional	This is the tag of the idea. Available if tags is enabled in the campaign. Multiple tags can be passed seperated by comma Sample value: "innovation, technology"
visible optional	This is shown/hidden state of the idea. Parameter available for Admin requester only Sample value: 1: For shown, 0: For hidden
anonymous optional	This is the anonymous state of the idea. It's a long text field. Accepted Value: 1: For anonymous, 0: For not anonymous
format optional	Specifies returned data format Accepted value: "json", "xml"

Resource Information

Authentication: Required. See Authentication for details on authentication.

HTTP Methods: PUT

Request URL Format: https://{api_domain}/api3/idea/{id}

Access Permission

Authentication is required for UPDATE memeber request. See Authentication for detail on authentication.

Requster's ability to update an idea is dependent on campaign edit idea setting.

Errors

You don't have permission for this campaign
{parameter} must be more than {minimum_length} characters
{parameter} must be less than {maximum_length} characters
Invalid {parameter} received
Missing required parameter
Additional question {question_id} is required

Example Request

Method: PUT
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
URL: https://example.brightidea.com/api3/idea/2666DAB1-1125-4393-8AF7-753FBEFBA148

Form data:

title=Updated Test Idea Title
description=Updated Test Idea Description
FF644DF7-A8FA-4795-8F59-003F4AE0981A[]=

{
    "idea": {
        "id": "2666DAB1-1125-4393-8AF7-753FBEFBA148",
        "date_created": "2013-04-16 15:42:39.050",
        "date_modified": "2013-04-16 15:49:30.873",
        "title": "UPDATED Test Idea #3",
        "description": "UPDATED Description of test idea #3",
        "visible": true,
        "anonymous": false,
        "idea_code": "D632",
        "score": 1,
        "member": {
            "id": "8FA49B96-3693-4282-8919-014618D7B3B8",
            "email": "lsmith@example.com",
            "screen_name": "Lillian Smith",
            "first_name": "Lillian",
            "last_name": "Smith",
            "job_title": "",
            "address": "",
            "phone": "",
            "mobile_phone": "",
            "external_user_id": "",
            "skills": "",
            "work_history": "",
            "photo_url": "",
            "date_created": "2013-03-07 17:10:13.627",
            "date_modified": "2013-04-16 15:42:16.430",
            "active": true
        },
        "category": {
            "id": "36E5A3B1-ECD9-48E4-8F43-FB6296F8A2E1",
            "name": "Category 5"
        },
        "status": {
            "id": "D329EF01-D051-40AB-BB18-F13C03F3BE9C",
            "name": "Status 1"
        },
        "campaign": {
            "id": "0A140858-AD8A-4F97-9926-D80AD156A130",
            "name": "Sample Campaign",
            "description": "Sample Campaign Description",
            "date_created": "2013-03-07 17:10:38.107"
        },
        "additional_questions": [
            {
                "id": "BD6EC5D5-28D3-4BAF-B73F-35C0BD8E6513",
                "description": "Radio question 1?",
                "required": true,
                "type": "radio",
                "response_text": "Radio answer C",
                "options": [
                    {
                        "id": "B68AED9A-4528-402B-B297-5152CB592639",
                        "description": "Radio answer A",
                        "order": "1",
                        "selected": false
                    },
                    {
                        "id": "47D3F670-4F6F-4E8F-8EB5-693FDFA39A4F",
                        "description": "Radio answer B",
                        "order": "2",
                        "selected": false
                    },
                    {
                        "id": "1C725C5D-6E30-4B16-B35C-4E280FC8E36C",
                        "description": "Radio answer C",
                        "order": "3",
                        "selected": true
                    }
                ]
            },
            {
                "id": "FF644DF7-A8FA-4795-8F59-003F4AE0981A",
                "description": "Checkbox question 2",
                "required": false,
                "type": "checkbox",
                "options": [
                    {
                        "id": "131A27BB-0131-4081-BCA0-F3CE92C6A7A0",
                        "description": "Checkbox answer A",
                        "order": "1"
                    },
                    {
                        "id": "976603C0-A84B-48BD-AFFC-9D5413BF5CD0",
                        "description": "Checkbox answer B",
                        "order": "2"
                    },
                    {
                        "id": "91F7529F-291C-4812-98C4-B9F3275635A5",
                        "description": "Checkbox answer C",
                        "order": "3"
                    }
                ]
            },
            {
                "id": "ACDB0D67-987E-4D90-A022-D1336E4DD1AF",
                "description": "Short answer question 3",
                "required": false,
                "type": "text",
                "response_text": "Short answer of test idea #3"
            },
            {
                "id": "2C28E088-D7F8-4E7A-8BA4-8E104CDAE4E9",
                "description": "Long text question 4",
                "required": false,
                "type": "textarea",
                "response_text": "Long answer of test idea #3"
            },
            {
                "id": "53EF3BEA-90BF-446B-800C-9F7E60CD8555",
                "description": "Dropdown question 5",
                "required": true,
                "type": "select",
                "response_text": "Dropdown answer D",
                "options": [
                    {
                        "id": "912EE8FC-57C8-4A88-AA85-48627639E9C4",
                        "description": "Dropdown answer A",
                        "order": "1",
                        "selected": false
                    },
                    {
                        "id": "9F332A68-9396-4411-9D6C-1C9986320654",
                        "description": "Dropdown answer B",
                        "order": "2",
                        "selected": false
                    },
                    {
                        "id": "4C3FEECD-469F-4830-BD4F-49FEE484CE31",
                        "description": "Dropdown answer C",
                        "order": "3",
                        "selected": false
                    },
                    {
                        "id": "5D431D0E-7453-4783-8257-3F96B2F0E6F0",
                        "description": "Dropdown answer D",
                        "order": "4",
                        "selected": true
                    }
                ]
            }
        ]
    }
}

DELETE idea

Delete a idea object. Requester must be an Admin.

Parameters

Parameters	Detail
format optional	Specifies returned data format Accepted value: "json", "xml"

Resource Information

Authentication: Required
HTTP Methods: DELETE
Request URL Format: https://{api_domain}/api3/idea/{id}

Access Permission

Requester must be an Admin.

Errors

Invalid GUID received

Example Request

Method: DELETE
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c
URL: https://example.brightidea.com/api3/idea/2666DAB1-1125-4393-8AF7-753FBEFBA148
```
{
    "message": "success",
    "code": 200
}
```

FAQ

Question: I understand passing the "with=comments" parameter on GET idea request can get me the first 20 comments of the idea. But what if there are 30 comments? How do I get the other 10?

Answer: Make request to the LIST comment function filter by idea_id will get you list of comments of the given idea. Refine result by passing page_size, page, order_by parameters.

Question: LIST idea only return 100 objects maximum per request. How do I retrieve more results.

Answer: LIST idea response is automatically paginated. If you got 100 idea objects in the initial request, pass "page_size=100&page=2" to get the next 100. page_count is returned with every LIST request so your application can figure out when it hits the last page.

Question: How do I delete an idea from an Affiliate?

Answer: DELETE idea is not currently an available functionality. However, if the goal is to hide the idea from regular user, the recommended approach is to make request to the UPDATE idea function passing "visible=0". This will hide the idea from regular user.

Question: How do I get all category_id, question_id... all the IDs to the required parameter to create an idea?

Answer: Make request to the GET postIdea widget function to get all information for idea submission.

Question: How do I get the attachments that return with the idea?

Answer: An URL is returned with each attachment. Make GET request to the URL to get attachment in binary format.

Question: How do I update the idea attachment?

Answer: See ideaAttachment functions on creating and deleting idea attachment.