unsubscribe
/groups/{group}/unsubscribe [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9300 | 5.9500 | xml, json |
Description
Unsubscribe a member from a group without logging in.
Optionally changes a member’s notification settings or removes them from one or more groups. Returns a list of group and subgroup memberships for a member for the group specified.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| deregister | If true, remove the user from the group or subgroups | no | boolean | false |
| notification | The members notification option for the group or subgroups ( immediate|daily|weekly|essential|none) | no | string | |
| token | Unsubscribe token for the group and member | yes | string |
Permission
A valid token for the group and member can invoke this service.
Response
The XML returned is one or more <membership> elements inside an <unsubscribe> element:
<unsubscribe email="[member's email]">
<membership id="[membership id]"
email-listed="[true|false]"
notification="[notification]"
flags="[flags]"
status="normal"
role="[role]"
[subgroups="[subgroups]"]
[override="[overridden attributes]"]>
<group|project id="[group id]"
name="[group name]"
description="[description]"
owner="[owner]"
[relatedurl="[url]"] />
</membership>
<membership ...> ... </membership>
...
</unsubscribe>
Error Handling
| 0x102A | Token is invalid |
|---|---|
| 0x102B | Token has expired |