Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunityDoc feedbackLog In

remove

Removes a recipient from a recipient list in Optimizely Campaign.

πŸ‘

Tip

This operation does not unsubscribe a recipient. To do that, use the unsubscribe operation.

This operation is available in the mail and the form service.

Parameters

NameMandatoryDefault valueDescription
bmRecipientIdyes/no–The ID of the new 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.

Return values

ValueDescription
okRecipient successfully removed from the recipient list
ok: not_foundOnly with bmVerbose=true: The recipient could not be found in the recipient list.
wrong_tagAuthorization failed.
Error codes:

- 501=wrong authentication tag
- 502=wrong request IP
- 503=wrong request method
- 504=wrong protocol
- 505=wrong recipient list
- 506=wrong action
- 507=action not found
If a verification of the authentication tag does not solve the problem, contact customer support.
missing_idWhen using the form service: No bmRecipientId was transmitted.
system_errorA general error occurred.

Example 1

.../form/.../remove?bmRecipientId=john.smith%40example.com

The recipient with the ID [email protected] is removed from the recipient list. This recipient list is identified by the authorization code.

Example 2

.../mail/.../remove?bmUrl=http://www.example.com

The recipient of the email is removed from the recipient list to which the mailing was sent. Then, the recipient is forwarded to www.example.com.


What’s Next