Loading...
Area: Episerver Campaign
Applies to versions: Not applicable

blacklist and unblacklist

These operations generate or remove a blacklist entry in Episerver Campaign.

Blacklist entries can be individual recipients (i.e., an email address) or wildcards, which block all recipients that match a defined pattern (e.g., a whole domain). Use a question mark (?) for a single character and an asterisk (*) for several characters.

These operations are available in the form service.

Parameters

Name Mandatory Default value Description

bmPattern

yes

If the blacklist entry refers to a single recipient, the email address can be set here. To blacklist multiple recipients, use wildcards as described above.

bmReason

no

http-api

The reason for blacklisting.

Return values

Value Description
ok

blacklist: Entry successfully added to the blacklist.
unblacklist: Entry successfully removed from blacklist.

ok: already_blacklisted

Only with bmVerbose=true: The entry already exists in the blacklist.

wrong_tag

Authorization 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

Note: If a verification of the authentication tag does not solve the problem, contact customer support.

missing_id

No bmRecipientId was transmitted when using the form service.

system_error

A general error occurred.

Example 1

.../form/.../blacklist?bmPattern=john.smith%40example.com

The recipient with the ID "john.smith@example.com" is blacklisted.

Example 2

.../form/.../unblacklist?bmPattern=john.smith%40example.com

The recipient with the ID "john.smith@example.com" is removed from the blacklist.

Example 3

.../form/.../blacklist?bmPattern=%2A%40example.com

All recipients with an email address containing the domain "example.com" are blacklisted.

Last updated: Apr 25, 2018