POST v1/schedule/email
Sends the tenant email.
Request Information
URI Parameters
None.
Body Parameters
The parameters.
ScheduledEmailParametersName | Description | Type | Additional information |
---|---|---|---|
FromAddress | string |
None. |
|
To | string |
None. |
|
SubjectLine | string |
None. |
|
CC | string |
None. |
|
BCC | string |
None. |
|
Body | string |
None. |
|
BodyIsHtml | boolean |
None. |
|
Priority | integer |
None. |
|
ScheduledDateTime | date |
None. |
|
FromName | string |
None. |
|
SenderAddress | string |
None. |
|
ReplyToAddress | string |
None. |
|
AttachedFiles | string |
None. |
|
AttachmentDocumentId | Collection of globally unique identifier |
None. |
|
FacilityId | globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "FromAddress": "sample string 1", "To": "sample string 2", "SubjectLine": "sample string 3", "CC": "sample string 4", "BCC": "sample string 5", "Body": "sample string 6", "BodyIsHtml": true, "Priority": 1, "ScheduledDateTime": "2025-06-30T21:21:08.9199293-07:00", "FromName": "sample string 7", "SenderAddress": "sample string 8", "ReplyToAddress": "sample string 9", "AttachedFiles": "sample string 10", "AttachmentDocumentId": [ "98f7235c-ef17-4a52-a1a2-a91c1542761a", "ef99683f-61f1-48b6-ab48-ce4533c91c8c" ], "FacilityId": "b0862385-25e2-4d32-9ed1-f3c46ff8c727" }
application/xml, text/xml
Sample:
<ScheduledEmailParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels"> <AttachedFiles>sample string 10</AttachedFiles> <AttachmentDocumentId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>98f7235c-ef17-4a52-a1a2-a91c1542761a</d2p1:guid> <d2p1:guid>ef99683f-61f1-48b6-ab48-ce4533c91c8c</d2p1:guid> </AttachmentDocumentId> <BCC>sample string 5</BCC> <Body>sample string 6</Body> <BodyIsHtml>true</BodyIsHtml> <CC>sample string 4</CC> <FacilityId>b0862385-25e2-4d32-9ed1-f3c46ff8c727</FacilityId> <FromAddress>sample string 1</FromAddress> <FromName>sample string 7</FromName> <Priority>1</Priority> <ReplyToAddress>sample string 9</ReplyToAddress> <ScheduledDateTime>2025-06-30T21:21:08.9199293-07:00</ScheduledDateTime> <SenderAddress>sample string 8</SenderAddress> <SubjectLine>sample string 3</SubjectLine> <To>sample string 2</To> </ScheduledEmailParameters>
Response Information
Resource Description
ScheduledMessageBindingModelName | Description | Type | Additional information |
---|---|---|---|
Errors | Collection of Exception |
None. |
|
IsSuccess | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Errors": [ { "ClassName": "System.Exception", "Message": null, "Data": null, "InnerException": null, "HelpURL": "sample string 1", "StackTraceString": null, "RemoteStackTraceString": null, "RemoteStackIndex": 0, "ExceptionMethod": null, "HResult": 3, "Source": "sample string 2", "WatsonBuckets": null }, { "ClassName": "System.Exception", "Message": null, "Data": null, "InnerException": null, "HelpURL": "sample string 1", "StackTraceString": null, "RemoteStackTraceString": null, "RemoteStackIndex": 0, "ExceptionMethod": null, "HResult": 3, "Source": "sample string 2", "WatsonBuckets": null } ], "IsSuccess": true }
application/xml, text/xml
Sample:
<ScheduledMessageBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenTech.IssnWebApi.Web.Models.BindingModels"> <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:Exception> <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName> <Message i:nil="true" xmlns="" /> <Data i:nil="true" xmlns="" /> <InnerException i:nil="true" xmlns="" /> <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL> <StackTraceString i:nil="true" xmlns="" /> <RemoteStackTraceString i:nil="true" xmlns="" /> <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex> <ExceptionMethod i:nil="true" xmlns="" /> <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult> <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source> <WatsonBuckets i:nil="true" xmlns="" /> </d2p1:Exception> <d2p1:Exception> <ClassName xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">System.Exception</ClassName> <Message i:nil="true" xmlns="" /> <Data i:nil="true" xmlns="" /> <InnerException i:nil="true" xmlns="" /> <HelpURL xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 1</HelpURL> <StackTraceString i:nil="true" xmlns="" /> <RemoteStackTraceString i:nil="true" xmlns="" /> <RemoteStackIndex xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">0</RemoteStackIndex> <ExceptionMethod i:nil="true" xmlns="" /> <HResult xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:int" xmlns="">3</HResult> <Source xmlns:d4p1="http://www.w3.org/2001/XMLSchema" i:type="d4p1:string" xmlns="">sample string 2</Source> <WatsonBuckets i:nil="true" xmlns="" /> </d2p1:Exception> </Errors> <IsSuccess>true</IsSuccess> </ScheduledMessageBindingModel>