POST api/v2.0/Ideation/AddIdeaCategories
Add categories to an idea.
Request Information
URI Parameters
None.
Body Parameters
SetIdeaCategoriesRequestName | Description | Type | Additional information |
---|---|---|---|
IdeationKey |
Key of the idea. |
globally unique identifier |
Required |
IdeationCategoryKeys |
Category keys to add to the idea. |
Collection of globally unique identifier |
Required |
Request Formats
application/json, text/json
{ "IdeationKey": "59bd220d-5127-4789-b510-6b9c47be6019", "IdeationCategoryKeys": [ "ec80ce4f-c090-4124-9f02-0d07ae83f0bf", "1dc3c7e6-f3df-438f-9b82-68750b7ecdc9" ] }
application/xml, text/xml
<SetIdeaCategoriesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Ideation"> <IdeationCategoryKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>ec80ce4f-c090-4124-9f02-0d07ae83f0bf</d2p1:guid> <d2p1:guid>1dc3c7e6-f3df-438f-9b82-68750b7ecdc9</d2p1:guid> </IdeationCategoryKeys> <IdeationKey>59bd220d-5127-4789-b510-6b9c47be6019</IdeationKey> </SetIdeaCategoriesRequest>
Response Information
Resource Description
Idea updated
IdeaDetailsName | 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": "4c28d784-be58-4142-9a11-9d3bd41cd709", "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": "c88b8dcc-796f-45f0-9021-713c454394d1", "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-07-09T07:28:22.1878517Z", "UpdatedByContactKey": "2ea38a30-3466-4580-8b7b-9f4e7b12a521", "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-07-09T07:28:22.1878517Z" }, "IsAnonymous": true, "CreatedOn": "2025-07-09T07:28:22.1878517Z", "UpdatedOn": "2025-07-09T07:28:22.1878517Z", "AttachmentURLs": null }
application/xml
Sample not available.
text/xml
Sample not available.