copy and move
Both operations use the same parameters. The copy operation creates a duplicate of an entry (i.e., the recipient). The move operation creates a duplicate of an entry and then removes the original entry.
The copy and move operations are available in the mail and the form service. If you are using the mail service, we recommend using the system parameter bmUrl to avoid having a white page with a status message displayed to the recipient.
Parameters
Name | Mandatory | Default value | Description |
|---|---|---|---|
bmRecipientId | yes/no | – | The ID of the recipient (usually the email address). If used in the mail service, this parameter is not mandatory (the email address is sent anyway). If used in the form service, the parameter is mandatory. |
bmListId | yes | – | The ID of the recipient list to which the recipient is copied or moved. |
Return values
Value | Description |
|---|---|
ok | Entry successfully moved/copied |
ok: already_exist | Only with bmVerbose=true: Recipient already exists in the target list |
wrong_tag | Authorization failed. Error codes:
|
wrong_id | The transmitted bmListId is incorrect. |
not_found | Only when using the form service: The bmRecipientId was not found in the source recipient list nor in the target recipient list. |
missing_id |
|
system_error | A general error has occurred |
Example 1
.../mail/.../copy?bmListId=12345&bmUrl=http://www.example.comThe recipient of the email is copied from the current recipient list to the recipient list with the ID 12345. Then, the recipient is forwarded to www.example.com.
Example 2
.../form/.../move?bmListId=12345&bmRecipientId=john.smith%40example.comThe recipient with the ID [email protected]_ is moved to the recipient list with the ID 12345 and removed from the current recipient list.