POST api/v2.0/Ideation/Post

Create a new idea.

Request Information

URI Parameters

None.

Body Parameters

New idea to submit

Name	Description	Type	Additional 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": "ac977a52-af98-496c-af9b-3e10b8f72ce3",
  "IdeationCategoryKeys": [
    "5ebb0f01-14fa-4fa1-a74d-3a7c2009b0ff",
    "4bab7168-fdd0-47a0-a3ee-f461c98d4f7b"
  ],
  "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>5ebb0f01-14fa-4fa1-a74d-3a7c2009b0ff</d2p1:guid>
    <d2p1:guid>4bab7168-fdd0-47a0-a3ee-f461c98d4f7b</d2p1:guid>
  </IdeationCategoryKeys>
  <IdeationStatusKey>ac977a52-af98-496c-af9b-3e10b8f72ce3</IdeationStatusKey>
  <IsAnonymous>true</IsAnonymous>
  <Title>sample string 1</Title>
</NewIdeaRequest>

Response Information

Resource Description

Submitted idea

IdeaDetails

Name	Description	Type	Additional information
IdeationKey	Unique identifier of the idea.	globally unique identifier	None.
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:

{
  "IdeationKey": "526f0781-272e-40c3-897b-cfadd22dbc8b",
  "Title": "sample string 2",
  "Description": "sample string 3",
  "LinkToViewIdea": "sample string 4",
  "Status": null,
  "Categories": null,
  "TotalUpvotes": 5,
  "TotalDownvotes": 6,
  "HasOfficialComment": true,
  "Author": {
    "LinkToProfile": "sample string 1",
    "PictureUrl": "sample string 2",
    "ContactKey": "56240c5d-59e3-45f4-a989-69e06ffa83ee",
    "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-09-19T18:34:01.594171Z",
    "UpdatedByContactKey": "765a975e-8428-49ec-b0dc-fcb96c68bc6d",
    "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-09-19T18:34:01.594171Z"
  },
  "IsAnonymous": true,
  "CreatedOn": "2024-09-19T18:34:01.594171Z",
  "UpdatedOn": "2024-09-19T18:34:01.594171Z",
  "AttachmentURLs": null
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.