POST 17.0/app/correspondence/letter

Description

Creates a new merged letter using the passed mail merge ids

URI Parameters

None.

MailMergeIds
Name Description Type Additional information
ContactId

integer

None.
PropertyId

integer

None.
WorkOrderId

integer

None.
CertificateId

integer

None.
AppointmentId

integer

None.
TenancyId

integer

None.
OfferId

integer

None.
TemplateId

integer

None.
UserId

integer

None.

application/json, text/json
Sample: 
{
  "contactId": 1,
  "propertyId": 2,
  "workOrderId": 3,
  "certificateId": 4,
  "appointmentId": 5,
  "tenancyId": 6,
  "offerId": 7,
  "templateId": 8,
  "userId": 9
}

application/xml, text/xml
Sample: 
<MailMergeIds xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactId>1</ContactId>
  <PropertyId>2</PropertyId>
  <WorkOrderId>3</WorkOrderId>
  <CertificateId>4</CertificateId>
  <AppointmentId>5</AppointmentId>
  <TenancyId>6</TenancyId>
  <OfferId>7</OfferId>
  <TemplateId>8</TemplateId>
  <UserId>9</UserId>
</MailMergeIds>

application/x-www-form-urlencoded
Sample:

Sample not available.

MergedDocument
Name Description Type Additional information
Id

integer

None.
FileName

string

None.

application/json, text/json
Sample: 
{
  "id": 1,
  "fileName": "sample string 2"
}

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