import group members
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 6.0000 | 6.0000 | json, xml |
Description
Imports members into a PageSeeder group.
The data parameter uses comma-separated values as:
[firstname],[surname],[email],[username?],[password?],[field1?], ... ,[field15?]
The first three fields are always required. Password is also required for new members. The fields are for Custom member details.
If a value contains a comma, it should be wrapped by double quotes ". It is not possible to include a line delimiter in a value, line delimiters are automatically interpreted as a separate member.
Error handling
If a user already exist, the existing details are returned instead of the original details sent in the request. The details sent in the import data do NOT overwrite the existing data.
If the data is incomplete or the email or username is invalid, it will return status="error" for that member.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| createpersonal | Whether to create a personal group for each member | no | string |
false
|
| data | the members to be imported in CSV format | yes | string | |
| listed | Whether to list the member's email address in the group | no | string |
false
|
| notification | The notification for the member (none, immediate, daily, weekly, essential) | no | string |
[the group's default]
|
| role | The role for the member (guest, reviewer, contributor, manager, approver) | no | string |
[the group's default]
|
Permission
This service requires Administrator.
Response
The returned XML is as follows:
<members-import>
<import firstname="[first name]"
surname="[surname]"
email="[email]"
username="[username]"
status="[created|existing|error]"
[id="[member id]"]
[personal-group-created="true"]
[added-to-group="true"]
[error=""] />
...
</members-import>
Error Handling
No specific errors expected for this generator.