Group Membership – Baack docs
Group Membership
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.
Endpoints
GET/n/v1/groupmembership/{urn}
Endpoint for managing group membership for specific identities including opt in and out support
Parameters
urn(path, required)- String representation of a Unique Resource Name. Typically a UUID with 36 characters.
Responses
- 200 OK
- returns Group Membership
READ_SUCCESS - 404 Not found
- returns Error
NOT_FOUND
curl -H "Authorization: Bearer $BAACK_API_TOKEN" \ https://api.baack.co/n/v1/groupmembership/{urn}
Fields
| Field | Type | Description |
|---|---|---|
| urn | string (uuid) | |
| emailNotification | string | Required on create. One of: |
| smsNotification | string | Required on create. One of: |
| identity | Identity | Required on create.Ignored on update. |
| inAppNotification | string | Required on create. One of: |
| url | string (uri) | |
| group | Group | Required on create.Ignored on update. |
| status | string | Required on create. One of: |
| enrollment | string | Required on create. One of: |
Used by: Search Item