Add an email destination

post

{scheme}://{host}:{port}/api/SingleSchedule/AddEmailDestination

Add an email destination to an existing single-report schedule. ParentId is the report identifier. clearExisting=true deletes only existing email destinations for that report before insertion; it does not delete disk or other destination types. Retain the returned DestinationId for subsequent changes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

clearExisting

boolean

Defaults to false

Delete existing email destinations for ParentId before adding this one. Other destination types are preserved.

Body Params

Send application/json or application/x-www-form-urlencoded. Use JSON to represent nested objects, arrays and explicit null values. For form requests, send individual bracketed fields; do not serialize the entire schedule into a field named model.

DestinationName

string | null

DestinationType

string | null

OutputFormat

string

CustomOutputFileName

string

CustomOutputExtension

string

Enabled

boolean

Defaults to true

ParentId

int64

required

Defaults to 0

PowerBIDataOnlyExportSettings

array of objects | null

PowerBIDataOnlyExportSettings

array of strings

required

length ≥ 1

To*

array of strings

Defaults to []

Copy recipients. Send the complete intended list on update; an empty list clears stored recipients.

Bcc

array of strings

Defaults to []

Blind-copy recipients. Send the complete intended list on update; an empty list clears stored recipients.

Bcc

Subject

string

Body

string

BodyFormat

string

enum

Defaults to TEXT

Message body format.

Allowed:

EmbedReport

boolean

Defaults to false

Creation can alter the output format and disable the normal report attachment. Do not assume this field is changed by the dedicated email-update operation.

EmbedFormat

string

enum

Defaults to IMAGE

Embedding representation when embedding is enabled.

Allowed:

CustomSenderName

string

CustomerSenderAddress

string

Custom sender email address. The wire spelling is CustomerSenderAddress; this is not a reply-to field.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200Successful operation.

500The operation raised an exception. Authentication, permission, input, database or reporting failures can take this path. Exception details vary.