POST api/v2.0/Ideation/Post

Create a new idea.

Request Information

URI Parameters

None.

Body Parameters

New idea to submit

NewIdeaRequest
NameDescriptionTypeAdditional information
Title

Title of the idea. Maximum length is 100 characters.

string

Required

Description

Description of the idea.

string

Required

IdeationStatusKey

Key for the status of the idea. Statuses are configurable on a per-site basis, the list of available statuses can be retrieved from the getStatuses endpoint.

globally unique identifier

Required

IdeationCategoryKeys

Keys for the categories the idea is associated to. Categories are configurable on a per-site basis, the list of available categories can be retrieved from the getCategories endpoint.

Collection of globally unique identifier

None.

IsAnonymous

True if the idea is being submitted anonymously.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Title": "sample string 1",
  "Description": "sample string 2",
  "IdeationStatusKey": "201e78dc-5232-43d0-8f85-3e96f09daca6",
  "IdeationCategoryKeys": [
    "6d27ea2a-fb91-4188-bcab-994565de6901",
    "cccdab0d-32ba-44c5-8b5d-e7cfdaf1908e"
  ],
  "IsAnonymous": true
}

application/xml, text/xml

Sample:
<NewIdeaRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Ideation">
  <Description>sample string 2</Description>
  <IdeationCategoryKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>6d27ea2a-fb91-4188-bcab-994565de6901</d2p1:guid>
    <d2p1:guid>cccdab0d-32ba-44c5-8b5d-e7cfdaf1908e</d2p1:guid>
  </IdeationCategoryKeys>
  <IdeationStatusKey>201e78dc-5232-43d0-8f85-3e96f09daca6</IdeationStatusKey>
  <IsAnonymous>true</IsAnonymous>
  <Title>sample string 1</Title>
</NewIdeaRequest>

Response Information

Resource Description

Submitted idea

IdeaDetails
NameDescriptionTypeAdditional information
Title

Title of the idea.

string

None.

Description

Description of the idea.

string

None.

LinkToViewIdea

Direct link to view the idea on the main microsite.

string

None.

Status

Object containing information about the status of the idea.

IdeaStatus

None.

Categories

All categories the idea has been associated to.

Collection of IdeaCategory

None.

TotalUpvotes

Number of upvotes.

integer

None.

TotalDownvotes

Number of downvotes.

integer

None.

HasOfficialComment

True if this idea has an official comment from an admin.

boolean

None.

Author

Information about the author of the idea.

ContactConcise

None.

IsAnonymous

True if the idea was submitted anonymously.

boolean

None.

CreatedOn

DateTime the idea was created.

date

None.

UpdatedOn

Most recent DateTime the idea was updated.

date

None.

AttachmentURLs

Temporary URLs to view or download any attachments associated with the idea.

Collection of IdeaAttachment

None.

Response Formats

application/json, text/json

Sample:
{
  "Title": "sample string 1",
  "Description": "sample string 2",
  "LinkToViewIdea": "sample string 3",
  "Status": null,
  "Categories": null,
  "TotalUpvotes": 4,
  "TotalDownvotes": 5,
  "HasOfficialComment": true,
  "Author": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "b60848bb-b804-4860-98f8-f3d90a1a564e",
    "FirstName": "sample string 4",
    "LastName": "sample string 5",
    "DisplayName": "sample string 6",
    "EmailAddress": "sample string 7",
    "ContactStatusCode": "sample string 8",
    "PrefixCode": "sample string 9",
    "UpdatedOn": "2024-05-23T22:51:49.3806857Z",
    "UpdatedByContactKey": "3ed1c328-e285-4968-8ab8-4f1885783eb7",
    "CompanyName": "sample string 12",
    "CompanyTitle": "sample string 13",
    "SuffixCode": "sample string 14",
    "Designation": "sample string 15",
    "LegacyContactKey": "sample string 16",
    "InformalName": "sample string 17",
    "MiddleName": "sample string 18",
    "IsCompany": true,
    "CompanyLegacyContactKey": "sample string 20",
    "AMSDirectoryOptOut": true,
    "HLDirectoryOptOut": true,
    "HLContactMeOptOut": true,
    "LargePictureUrl": "sample string 24",
    "AgreedToTermsDateTime": "2024-05-23T22:51:49.3806857Z"
  },
  "IsAnonymous": true,
  "CreatedOn": "2024-05-23T22:51:49.3806857Z",
  "UpdatedOn": "2024-05-23T22:51:49.3806857Z",
  "AttachmentURLs": null
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.