POST api/branch/createscheduledmailmerge

Save a scheduled mail merge.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Name	string	None.
Description	string	None.
IncludeOfferAccepted	boolean	None.
MatchLimit	integer	None.
Grades	Collection of EnumDataContract	None.
IncludePriceChange	boolean	None.
ExcludeAlreadySent	boolean	None.
ExcludeAlreadySentInLastDays	integer	None.
Sales	boolean	None.
Lettings	boolean	None.
StartDate	date	None.
DailySchedule	RecurringScheduleDataContract	None.
WeeklySchedule	RecurringScheduleDataContract	None.
MonthlySchedule	RecurringScheduleDataContract	None.
QuarterlySchedule	RecurringScheduleDataContract	None.
YearlySchedule	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": "2025-11-18T14:06:53.0876731Z",
  "DailySchedule": {
    "Frequency": 1,
    "StartDate": "2025-11-18T14:06:53.0876731Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "WeeklySchedule": {
    "Frequency": 1,
    "StartDate": "2025-11-18T14:06:53.0876731Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "MonthlySchedule": {
    "Frequency": 1,
    "StartDate": "2025-11-18T14:06:53.0876731Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "QuarterlySchedule": {
    "Frequency": 1,
    "StartDate": "2025-11-18T14:06:53.0876731Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "YearlySchedule": {
    "Frequency": 1,
    "StartDate": "2025-11-18T14:06:53.0876731Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  }
}

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.