The groupmembership object representation and fields are described below.
groupmembership was introduced in API version V1
groupmembership has not been marked for deprecation
Representation of a group membership configuration. Note that the presence of a membership does not imply that the membership is active. Review the state for details of the current state. To support opt out and other negative preferences the state includes options for opt out of a group either by the member or the owner.
{
"group" : {
"urn" : "822ff206-f4f8-412e-a648-2b4fab3fea10",
"url" : "/n/v1/group/822ff206-f4f8-412e-a648-2b4fab3fea10"
},
"identity" : {
"urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
"url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
},
"status" : "ACTIVE",
"enrollment" : "BY_MEMBER_WITH_CONSENT",
"emailNotification" : "SUBSCRIBED",
"smsNotification" : "UNSUBSCRIBED",
"inAppNotification" : "UNSUBSCRIBED"
}{
"urn" : "b4850841-7e6b-4aea-bae6-39b3a2854324",
"url" : "/n/v1/groupmembership/b4850841-7e6b-4aea-bae6-39b3a2854324",
"group" : {
"urn" : "822ff206-f4f8-412e-a648-2b4fab3fea10",
"url" : "/n/v1/group/822ff206-f4f8-412e-a648-2b4fab3fea10"
},
"identity" : {
"urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
"url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
},
"status" : "ACTIVE",
"enrollment" : "BY_MEMBER_WITH_CONSENT",
"emailNotification" : "SUBSCRIBED",
"smsNotification" : "UNSUBSCRIBED",
"inAppNotification" : "UNSUBSCRIBED"
}| Name | Type | Description | Constraints |
|---|---|---|---|
| urn | String representation of a Unique Resource Name. Typically a UUID with 36 characters. | The URN for the membership configuration | |
| url | URL represented as a string | The URL for accessing this membership configuration | |
| group | group | The membership group this subscription configuration is associated with | Required on create. Ignored on update. |
| identity | identity | The identity this group membership configuration is provided for | Required on create. Ignored on update. |
| status | A string representation of a enumeration name restricted to the documented values | The state of the membership | Required on create. Allowed values:
|
| enrollment | A string representation of a enumeration name restricted to the documented values | The enrollment criteria actor. This field is intended to be used for compliance reporting to record that a member was enrolled in a group by their own consent for compliance reasons. This may be of importance when connecting to email or other communications channel where explicit consent must be recorded for compliance. | Required on create. Allowed values:
|
| emailNotification | A string representation of a enumeration name restricted to the documented values | Email notification preference for group notifications | Required on create. Allowed values:
|
| smsNotification | A string representation of a enumeration name restricted to the documented values | SMS notification preference for group notifications | Required on create. Allowed values:
|
| inAppNotification | A string representation of a enumeration name restricted to the documented values | In APP notification preference for group notifications | Required on create. Allowed values:
|