Skip to main content

PUT Turn on/off Block spam

PUT /v3/relay/addresses/:address_id/block_spam

You can use this API to turn on or turn off the block spam feature. It does not require any body data.

Request Headers​

Accept: application/json
Authorization: Bearer {{api_key}}

Path params​

ParamDescriptionExample value
address_idThe private email id1

Body data​

This API does not require any body data

Return​

Return HTTP status code 200 with:

  • id (int) The id of the private email object

  • block_spam (bool) The current value of the block spam feature

Example​

Request​

curl --location --request PUT '{{host}}/v3/relay/addresses/1/block_spam' \
--header 'Authorization: Bearer {{api_key}}' \
--data-raw ''

Response​

{
    "id": 1,
    "block_spam": true
}