POST 17.0/app/correspondence/letter/bulk

Description

Creates a new merged bulk letter using the passed mail merge ids

URI Parameters

None.

Collection of 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
  },
  {
    "contactId": 1,
    "propertyId": 2,
    "workOrderId": 3,
    "certificateId": 4,
    "appointmentId": 5,
    "tenancyId": 6,
    "offerId": 7,
    "templateId": 8,
    "userId": 9
  }
]

application/xml, text/xml
Sample: 
<ArrayOfMailMergeIds xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MailMergeIds>
    <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>
  <MailMergeIds>
    <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>
</ArrayOfMailMergeIds>

application/x-www-form-urlencoded
Sample:

Sample not available.

MergedBulkDocument
Name Description Type Additional information
FileContents

string

None.
ContentType

string

None.
FileDownloadName

string

None.

application/json, text/json
Sample: 
{
  "fileContents": "sample string 1",
  "contentType": "sample string 2",
  "fileDownloadName": "sample string 3"
}

application/xml, text/xml
Sample: 
<MergedBulkDocument xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <FileContents>sample string 1</FileContents>
  <ContentType>sample string 2</ContentType>
  <FileDownloadName>sample string 3</FileDownloadName>
</MergedBulkDocument>