unsubscribe
/groups/{group}/unsubscribe [GET]
API Support | Available since | Last updated | Output |
---|---|---|---|
supported | 5.9300 | 5.9500 | xml, json |
Description
Returns a list of group and subgroup memberships for a member for the group specified so they can decide whether to change notification settings or remove themselves from one or more groups.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
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 |
Created on , last edited on