Create Iteration Mails

post

https://example.com/test/api/web/report-tasks/{ReportTaskId}/iterations/{IterationId}/mails

api/web/report-tasks/{ReportTaskId}/iterations/{IterationId}/mails

Creates one mail for the iteration.

Path Params

ReportTaskId

int32

required

≥ 1

The ID of the report task the iteration belongs to (ReportTaskId >= 1)

IterationId

int32

required

≥ 1

The ID of the iteration that the mail belongs to (IterationId >= 1)

Body Params

The model containing the details of the mail to create.

Mail configuration for a report task

LayoutId

int32 | null

The unique database ID of the layout that the mail will use.

FromAddress

string | null

The From address for the mail.

ToAddress

string | null

The To address for the mail.

CCAddress

string | null

Gets or sets the CC address for the mail.

BCCAddress

string | null

Gets or sets the BCC address for the mail.

ZipEnabled

boolean

Definies if the result should be zipped.

ZipPasswordValue

string | null

The password for the zipped file. Write-only in practice: reads return
the masked value SkySparc.Web.Backend.API.Models.WebAccess.ReportTaskMailModel.DUMMY_PASSWORD when a password is set.
On update, sending the masked value back leaves the stored password
unchanged, sending an empty value clears it, and sending any other
value replaces it. On create the masked value is rejected.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK