Blocklists

Add to blocklist

Add an email address to a suppression list. Sending with this listId skips the address

post/v1/blocklist/{listId}

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/blocklist/{listId}
  • Auth: HTTP bearer

Path parameters

listIdstring required

List ID. Must use a subdomain name format. Lists are registered ad-hoc, so a new identifier defines a new list.

Example:test-list

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Request body

accountstring required

Unique identifier for the email account

recipientstring required

Email address to add to the list

reasonstring

Identifier for the blocking reason

Example request

{
  "account": "user123",
  "recipient": "user@example.com",
  "reason": "unsubscribe"
}

Response

Returns whether the address was added or was already listed.

successboolean

Was the request successful

addedboolean

Was the address added to the list

Example response

{
  "success": true,
  "added": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.