POST api/Email/SendEmail

Request Information

URI Parameters

None.

Body Parameters

EmailRequest
NameDescriptionTypeAdditional information
FromEmail

string

None.

ToEmail

string

None.

IsPrecheckinEmail

boolean

None.

GuestName

string

None.

Subject

string

None.

confirmationNumber

string

None.

displayFromEmail

string

None.

EmailType

EmailType

None.

AttchmentBase64

string

None.

ItemName

string

None.

TotalAmount

string

None.

AttachmentFileName

string

None.

ArrivalDate

string

None.

DepartureDate

string

None.

ReservationNumber

string

None.

Request Formats

application/json, text/json

Sample:
{
  "FromEmail": "sample string 1",
  "ToEmail": "sample string 2",
  "IsPrecheckinEmail": true,
  "GuestName": "sample string 4",
  "Subject": "sample string 5",
  "confirmationNumber": "sample string 6",
  "displayFromEmail": "sample string 7",
  "EmailType": 0,
  "AttchmentBase64": "sample string 8",
  "ItemName": "sample string 9",
  "TotalAmount": "sample string 10",
  "AttachmentFileName": "sample string 11",
  "ArrivalDate": "sample string 12",
  "DepartureDate": "sample string 13",
  "ReservationNumber": "sample string 14"
}

application/xml, text/xml

Sample:
<EmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CheckinPortalCloudAPI.Models.Email">
  <ArrivalDate>sample string 12</ArrivalDate>
  <AttachmentFileName>sample string 11</AttachmentFileName>
  <AttchmentBase64>sample string 8</AttchmentBase64>
  <DepartureDate>sample string 13</DepartureDate>
  <EmailType>Precheckedin</EmailType>
  <FromEmail>sample string 1</FromEmail>
  <GuestName>sample string 4</GuestName>
  <IsPrecheckinEmail>true</IsPrecheckinEmail>
  <ItemName>sample string 9</ItemName>
  <ReservationNumber>sample string 14</ReservationNumber>
  <Subject>sample string 5</Subject>
  <ToEmail>sample string 2</ToEmail>
  <TotalAmount>sample string 10</TotalAmount>
  <confirmationNumber>sample string 6</confirmationNumber>
  <displayFromEmail>sample string 7</displayFromEmail>
</EmailRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EmailResponse
NameDescriptionTypeAdditional information
responseData

Object

None.

result

boolean

None.

responseMessage

string

None.

statusCode

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "responseData": {},
  "result": true,
  "responseMessage": "sample string 3",
  "statusCode": 4
}

application/xml, text/xml

Sample:
<EmailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CheckinPortalCloudAPI.Models.Email">
  <responseData />
  <responseMessage>sample string 3</responseMessage>
  <result>true</result>
  <statusCode>4</statusCode>
</EmailResponse>