Skip to main content

 Web service API

How to use PageSeeder's Web service API

unsubscribe

/groups/{group}/unsubscribe [POST]

com.pageseeder.membership.Unsubscribe

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

NameDescriptionRequiredTypeDefault value
deregisterIf true, remove the user from the group or subgroupsnobooleanfalse
notificationThe members notification option for the group or subgroups
(immediate|daily|weekly|essential|none)
nostring
tokenUnsubscribe token for the group and memberyesstring

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