POST (Header:PUT) api.ashx/v2/groups/{id}.{json|xml}
UPDATE a group.
Request Parameters
| Name | Type | Location | Description | Required | Default | Options |
|---|---|---|---|---|---|---|
| Description | string | Default is an empty string. | Optional | |||
| EnableGroupMessages | bool? | Default is false. | Optional | |||
| ExtendedAttributes | RestExtendedAttributes | Extended Attributes | Optional | |||
| GroupType | string | GroupType should be one of: Joinless, PublicOpen, PublicClosed, PrivateUnlisted, PrivateListed. | Optional | |||
| Id | int? | Id | Required | |||
| Key | string | If not specified, the key will be generated. | Optional | |||
| Name | string | Name | Optional | |||
| ParentGroupId | int? | Parent Group Id | Optional |
Example Requests
Widget Javascript
Fullscreen
1
2
3
4
5
6
7
8
jQuery.telligent.evolution.put({
url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/groups/{id}.json',
data: {
'id': '6'
}
}).then(function(response) {
// use response
});
Example Responses
JSON
Fullscreen
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"Group": {
"AvatarUrl": "avatarurl",
"DateCreated": "2012-01-04T00:00:00",
"Description": "description",
"Key": "key",
"Name": "name",
"ParentGroupId": 6,
"Url": "url",
"TotalMembers": 25,
"HasGroups": true,
"GroupCount": 8,
"GroupType": "grouptype",
"EnableGroupMessages": true,
"EnableContact": true,
"SearchUniqueId": "searchuniqueid",
"IsEnabled": true,
"ExtendedAttributes": [
{
"Key": "key",
"Value": "value"
XML
Fullscreen
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?xml version="1.0" encoding="utf-16"?>
<Response>
<Info>
<Message>string</Message>
<Message>string</Message>
</Info>
<Warnings>
<Message>string</Message>
<Message>string</Message>
</Warnings>
<Errors>
<Message>string</Message>
<Message>string</Message>
</Errors>
<Group>
<Id>4</Id>
<AvatarUrl>avatarurl</AvatarUrl>
<DateCreated>2012-01-04T00:00:00</DateCreated>
<Description>description</Description>
<Key>key</Key>
<Name>name</Name>