POST api/branch/createscheduledmailmerge

Save a scheduled mail merge.

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Events.ScheduledEvents.Command.MailMergeScheduledCommandDataContract
NameDescriptionTypeAdditional information
Name

string

None.

Description

string

None.

IncludeOfferAccepted

boolean

None.

MatchLimit

integer

None.

Grades

Collection of Dezrez.Core.DataContracts.External.Api.System.EnumDataContract

None.

IncludePriceChange

boolean

None.

ExcludeAlreadySent

boolean

None.

ExcludeAlreadySentInLastDays

integer

None.

Sales

boolean

None.

Lettings

boolean

None.

StartDate

date

None.

DailySchedule

Dezrez.Core.DataContracts.External.Api.Events.ScheduledEvents.Command.RecurringScheduleDataContract

None.

WeeklySchedule

Dezrez.Core.DataContracts.External.Api.Events.ScheduledEvents.Command.RecurringScheduleDataContract

None.

MonthlySchedule

Dezrez.Core.DataContracts.External.Api.Events.ScheduledEvents.Command.RecurringScheduleDataContract

None.

QuarterlySchedule

Dezrez.Core.DataContracts.External.Api.Events.ScheduledEvents.Command.RecurringScheduleDataContract

None.

YearlySchedule

Dezrez.Core.DataContracts.External.Api.Events.ScheduledEvents.Command.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": "2024-10-15T18:32:49.1617395Z",
  "DailySchedule": {
    "Frequency": 1,
    "StartDate": "2024-10-15T18:32:49.1617395Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "WeeklySchedule": {
    "Frequency": 1,
    "StartDate": "2024-10-15T18:32:49.1617395Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "MonthlySchedule": {
    "Frequency": 1,
    "StartDate": "2024-10-15T18:32:49.1617395Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "QuarterlySchedule": {
    "Frequency": 1,
    "StartDate": "2024-10-15T18:32:49.1617395Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  },
  "YearlySchedule": {
    "Frequency": 1,
    "StartDate": "2024-10-15T18:32:49.1617395Z",
    "DaysOfWeek": [
      1,
      1
    ],
    "DayOfMonth": 1,
    "Interval": 2,
    "IsSplit": true,
    "AnniversaryDay": 4,
    "AnniversaryMonth": 5,
    "IsNewTenancy": true
  }
}

Response Information

Resource Description

System.Net.Http.HttpResponseMessage
NameDescriptionTypeAdditional information
Version

System.Version

None.

Content

System.Net.Http.HttpContent

None.

StatusCode

System.Net.HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

System.Net.Http.HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.