Adds a domain or subject to the mail block list.

PUT /api/mail/general/block

Adds a domain or subject to the mail block list.

cURL

curl --request PUT \
  --url https://{install}/api/mail/general/block \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "block": "<string>",
  "data": "<string>"
}
'

import requests

url = "https://{install}/api/mail/general/block"

payload = {
    "block": "<string>",
    "data": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({block: '<string>', data: '<string>'})
};

fetch('https://{install}/api/mail/general/block', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://{install}/api/mail/general/block");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"block\": \"<string>\",\n  \"data\": \"<string>\"\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{install}/api/mail/general/block",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'block' => '<string>',
    'data' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{install}/api/mail/general/block"

	payload := strings.NewReader("{\n  \"block\": \"<string>\",\n  \"data\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{install}/api/mail/general/block")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"block\": \"<string>\",\n  \"data\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{install}/api/mail/general/block")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"block\": \"<string>\",\n  \"data\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

Authorizations

Authorization · string · header · required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Body

application/jsonapplication/*+json

The block type ("subject" or "domain") and the value to block.

block · string

data · string

Response

200

application/json

Block list entry added successfully.