POST api/v2.0/Ideation/AddIdeaCategories
Add categories to an idea.
Request Information
URI Parameters
None.
Body Parameters
SetIdeaCategoriesRequest| Name | 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": "1a383d37-1a37-4e2a-81e4-b2a6c1fa3905",
"IdeationCategoryKeys": [
"fd97b903-5ee2-41fe-beee-0490ddd7e285",
"2bdf2bdd-185a-4f35-9e5c-4ee4aa25a3cf"
]
}
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>fd97b903-5ee2-41fe-beee-0490ddd7e285</d2p1:guid>
<d2p1:guid>2bdf2bdd-185a-4f35-9e5c-4ee4aa25a3cf</d2p1:guid>
</IdeationCategoryKeys>
<IdeationKey>1a383d37-1a37-4e2a-81e4-b2a6c1fa3905</IdeationKey>
</SetIdeaCategoriesRequest>
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": "3f42a931-8824-47c2-b22d-90186803dd50",
"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": "e78ee2e7-0baa-4427-8ae6-27a49cf0bbb9",
"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-12-26T15:08:39.4531907Z",
"UpdatedByContactKey": "bc853c1d-7499-4951-a756-4922b2d5701d",
"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-12-26T15:08:39.4531907Z"
},
"IsAnonymous": true,
"CreatedOn": "2025-12-26T15:08:39.4531907Z",
"UpdatedOn": "2025-12-26T15:08:39.4531907Z",
"AttachmentURLs": null
}
application/xml
Sample not available.
text/xml
Sample not available.