Create a group subscription
POST {{baseUrl}}/.api/api.svc/groupsubscriptions/add?objectId={{$randomUUID}}&groupId={{$randomUUID}}&frequency=Instant
Create a subscription for a group to an object given an objectId, groupId and frequency, on your digital workplace.
The object can be anything in your digital workplace, excluding pages and spaces. The group can be any system, member, or space group within the digital workplace.
Request Params
| Key | Datatype | Required | Description |
| objectId | string | | (Required) - GUID
The ID of the object being subscribed to in your digital workplace. Only one object can be subscribed at a time. |
| groupId | string | | (Required) - GUID
The ID of the group subscribing to the object. The group subcsribing can be a system, member, or space group on your digital workplace.
Only one group can subscribe at a time. |
| frequency | string | | String
The subscription frequency of the object. The avaliable options are: Never, Instant, Daily, Weekly, Monthly. The default value is Instant.
Note: For microblogs, the only avaliable option is Instant. |
HEADERS
| Key | Datatype | Required | Description |
| Accept | string | | The type of response data to request. By default this endpoint will respond with XML.
The options are:
- application/json
- application/xml |
RESPONSES
status: OK
{"minRequestPeriod":0,"requestSupportCode":637793238683502685,"dictionary":null,"response":{"__type":"Model.GroupSubscriptionDefinition:http://schemas.iglooplatform.com/Igloo.Old.Common","id":"{{$randomInt}}{{$randomInt}}","href":"","navType":0,"communityId":"{{$randomUUID}}","created":{"userId":"","date":"/Date(1643727020870-0500)/","user":null},"forObjectId":"{{$randomUUID}}","frequency":1,"groupId":"{{$randomUUID}}","isGroupSubscription":true,"modified":{"userId":"","date":"/Date(1643727020870-0500)/","user":null},"overridesGroupSubscription":false,"userId":""}}