POST 17.0/app/correspondence/sms/preview

Description

Process merge fields in the sms body

URI Parameters

None.

SmsPreviewRequest
Name Description Type Additional information
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: 
{
  "body": "sample string 1",
  "contactId": 2,
  "propertyId": 3,
  "propertyOfferId": 4,
  "appointmentId": 5,
  "workOrderId": 6,
  "certificateId": 7,
  "tenancyId": 8
}

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

application/x-www-form-urlencoded
Sample:

Sample not available.

SmsPreviewResponse
Name Description Type Additional information
Body

string

None.

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

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