POST 17.0/app/correspondence/email/preview/mergefields

Description

Process merge fields in the email subject and body

URI Parameters

None.

EmailPreviewRequest
Name Description Type Additional information
Subject

string

None.
Body

string

None.
ContactId

integer

None.
PropertyId

integer

None.
PropertyOfferId

integer

None.
AppointmentId

integer

None.
WorkOrderId

integer

None.
CertificateId

integer

None.
TenancyId

integer

None.

application/json, text/json
Sample: 
{
  "subject": "sample string 1",
  "body": "sample string 2",
  "contactId": 3,
  "propertyId": 4,
  "propertyOfferId": 5,
  "appointmentId": 6,
  "workOrderId": 7,
  "certificateId": 8,
  "tenancyId": 9
}

application/xml, text/xml
Sample: 
<EmailPreviewRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Subject>sample string 1</Subject>
  <Body>sample string 2</Body>
  <ContactId>3</ContactId>
  <PropertyId>4</PropertyId>
  <PropertyOfferId>5</PropertyOfferId>
  <AppointmentId>6</AppointmentId>
  <WorkOrderId>7</WorkOrderId>
  <CertificateId>8</CertificateId>
  <TenancyId>9</TenancyId>
</EmailPreviewRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

EmailPreviewResponse
Name Description Type Additional information
Subject

string

None.
Body

string

None.

application/json, text/json
Sample: 
{
  "subject": "sample string 1",
  "body": "sample string 2"
}

application/xml, text/xml
Sample: 
<EmailPreviewResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Subject>sample string 1</Subject>
  <Body>sample string 2</Body>
</EmailPreviewResponse>