Remove recipients from a saved report's e-mails

Removes one e-mail address from the saved report's recipients, or every recipient when no email is given.

Reference

DELETE https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/{id}/recipients.do

Removes one e-mail address from the saved report's recipients, or every recipient when no email is given. With no recipients left, the scheduled report is mailed to nobody.

Path Params

id integer required

Saved report id

42

Form Params

email string

E-mail address

reports@northwind.example

Responses

200

The saved report with its recipients, in the shape of the GET

400

Bad request — invalid or missing parameters

401

Authentication error

403

Forbidden — insufficient permissions

404

No saved report of the caller has this id, or the email is not one of its recipients

Language

cURL Request

curl --request DELETE \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/recipients.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'email=reports@northwind.example'

Python Request

import requests

response = requests.request("DELETE", "https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/recipients.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"email": "reports@northwind.example"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/recipients.do', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"email":"reports@northwind.example"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/recipients.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("DELETE", HttpRequest.BodyPublishers.ofString("email=reports%40northwind.example"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("DELETE"), "https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/recipients.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["email"] = "reports@northwind.example" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/recipients.do", strings.NewReader(`email=reports%40northwind.example`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

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

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/recipients.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'email=reports%40northwind.example');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/recipients.do")
request = Net::HTTP::Delete.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('email' => "reports@northwind.example")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body