POST api/v2.0/Ideation/UpdateIdeaStatus
Update the status of an idea.
Request Information
URI Parameters
None.
Body Parameters
Update idea request object
UpdateIdeaStatusRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| IdeationKey |
Unique identifier for the idea to be updated. |
globally unique identifier |
Required |
| IdeationStatusKey |
Unique identifier of the status that will applied to the idea. |
globally unique identifier |
Required |
Request Formats
application/json, text/json
{
"IdeationKey": "d693f50d-86a1-43da-9637-fe956695d4bf",
"IdeationStatusKey": "559e1f15-6ca3-453f-b88d-2d399342f01e"
}
application/xml, text/xml
<UpdateIdeaStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Ideation"> <IdeationKey>d693f50d-86a1-43da-9637-fe956695d4bf</IdeationKey> <IdeationStatusKey>559e1f15-6ca3-453f-b88d-2d399342f01e</IdeationStatusKey> </UpdateIdeaStatusRequest>
Response Information
Resource Description
Idea updated
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. |
| Community |
The community the idea has been associated to. If null or doesn't exist (i.e. the idea is not associated to any community), the idea is considered to be a site-wide idea. |
Community |
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
{
"IdeationKey": "86be56d9-48e5-457c-80be-b3d38b464a65",
"Title": "sample string 2",
"Description": "sample string 3",
"LinkToViewIdea": "sample string 4",
"Status": null,
"Community": null,
"Categories": null,
"TotalUpvotes": 5,
"TotalDownvotes": 6,
"HasOfficialComment": true,
"Author": {
"LinkToProfile": "sample string 1",
"PictureUrl": "sample string 2",
"ContactKey": "0a05e452-318d-4947-9ea5-ab1a295d007d",
"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": "2025-11-06T06:15:35.860508Z",
"UpdatedByContactKey": "285f2743-623b-4c32-82d7-fdc9eeb736f4",
"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": "2025-11-06T06:15:35.860508Z"
},
"IsAnonymous": true,
"CreatedOn": "2025-11-06T06:15:35.860508Z",
"UpdatedOn": "2025-11-06T06:15:35.860508Z",
"AttachmentURLs": null
}
application/xml
Sample not available.
text/xml
Sample not available.