POST api/branch/createscheduledmailmerge

Save a scheduled mail merge. Processes this branch API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The mail merge scheduled command data contract supplied with the request.

MailMergeScheduledCommandDataContract

Name	Description	Type	Additional information
Name	The name value.	string	None.
Description	The description value.	string	None.
IncludeOfferAccepted	Indicates whether include offer accepted is true.	boolean	None.
MatchLimit	The match limit value.	integer	None.
Grades	The collection of grades.	Collection of EnumDataContract	None.
IncludePriceChange	Indicates whether include price change is true.	boolean	None.
ExcludeAlreadySent	Indicates whether exclude already sent is true.	boolean	None.
ExcludeAlreadySentInLastDays	The exclude already sent in last days value.	integer	None.
Sales	Indicates whether sales is true.	boolean	None.
Lettings	Indicates whether lettings is true.	boolean	None.
StartDate	The start date, expressed as a date and time.	date	None.
DailySchedule	The daily schedule value.	RecurringScheduleDataContract	None.
WeeklySchedule	The weekly schedule value.	RecurringScheduleDataContract	None.
MonthlySchedule	The monthly schedule value.	RecurringScheduleDataContract	None.
QuarterlySchedule	The quarterly schedule value.	RecurringScheduleDataContract	None.
YearlySchedule	The yearly schedule value.	RecurringScheduleDataContract	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "IncludeOfferAccepted": true,
  "MatchLimit": 4,
  "Grades": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    }
  ],
  "IncludePriceChange": true,
  "ExcludeAlreadySent": true,
  "ExcludeAlreadySentInLastDays": 7,
  "Sales": true,
  "Lettings": true,
  "StartDate": "2026-07-23T08:22:02.8140815Z",
  "DailySchedule": {
    "Frequency": 1,
    "StartDate": "2026-07-23T08:22:02.8140815Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "WeeklySchedule": {
    "Frequency": 1,
    "StartDate": "2026-07-23T08:22:02.8140815Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "MonthlySchedule": {
    "Frequency": 1,
    "StartDate": "2026-07-23T08:22:02.8140815Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "QuarterlySchedule": {
    "Frequency": 1,
    "StartDate": "2026-07-23T08:22:02.8140815Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "YearlySchedule": {
    "Frequency": 1,
    "StartDate": "2026-07-23T08:22:02.8140815Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  }
}

Response Information

Resource Description

The response returned after the operation completes.

HttpResponseMessage

Name	Description	Type	Additional information
Version	The version value.	Version	None.
Content	The content value.	HttpContent	None.
StatusCode	The status code classification.	HttpStatusCode	None.
ReasonPhrase	The reason phrase value.	string	None.
Headers	The collection of headers.	Collection of Object	None.
RequestMessage	The request message value.	HttpRequestMessage	None.
IsSuccessStatusCode	Indicates whether this item is success status code.	boolean	None.