|API Support||Available since||Last updated||Output|
Invite self to a group.
Allows a member to join themselves to a group in PageSeeder.
Group membership parameters
All group membership parameters are optional, and default to the group’s default values.
The notification parameter must be one of
The invitation behavior follows the value of Group Setting
Self Registration as follows:
- Normal – The member is joined immediately to the group.
- Moderated – A request is emailed to a moderator who must approve it.
- Confirmed – The member is sent an email with a link that they must follow.
Additional information specific to the group can also be attached to the user using the details fields field1 to field15.
|field1||Custom field #1||no||string|
|field10||Custom field #10||no||string|
|field11||Custom field #11||no||string|
|field12||Custom field #12||no||string|
|field13||Custom field #13||no||string|
|field14||Custom field #14||no||string|
|field15||Custom field #15||no||string|
|field2||Custom field #2||no||string|
|field3||Custom field #3||no||string|
|field4||Custom field #4||no||string|
|field5||Custom field #5||no||string|
|field6||Custom field #6||no||string|
|field7||Custom field #7||no||string|
|field8||Custom field #8||no||string|
|field9||Custom field #9||no||string|
|listed||Whether the member’s email address is listed in the group||no||boolean|
|notification||The member’s notification option in the group||no||string|
|notify-async||Whether to send emails asynchronously (for slow email servers)||no||boolean|
|welcome-email||Whether to send a welcome email to the member||no||boolean|
Anyone can invoke this service if the group visibility is defined as public.
If successful, the created membership is returned as a
<membership> element wrapped in a
If the service attempted but failed to send the email notification to the user, it is indicated using one of:
@welcome-email-failed– if unable to send the membership-new-member template.
@confirm-email-failed– if unable to send the membership-confirm template.
@moderate-email-failed– if unable to send the membership-accept template.
<membership-creation [welcome-email-failed="true"] [confirm-email-failed="true"] [moderate-email-failed="true"]> <membership id="[membership id]" email-listed="[true|false]" notification="[notification]" status="[self-invited|moderated|normal]" role="[role]"> <member id="[member id]" firstname="[first name]" surname="[surname]" username="[username]" status="[activated|unactivated|set-password]"> <fullname>[full name]</fullname> </member> <group id="[group id]" name="[name]" visibility="[visibility]" template="[template]"> <description>[description]</description> </group> </membership> </membership-creation>
|Code||Cause / Description|
|0x1003||If the specified group is a personal group|
|0x1023||Invite to admin group not allowed|
|0x1025||The member already belongs to the group|
|0x6004||If the member details have not been configured properly|
|0x6005||Group has no moderator with an email address (when Self Registration: Moderated)|