POST api/Campaign/SaveCampaignScheduling

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CampaignName	string	None.
AccountId	string	None.
CampaignId	string	None.
CampaignScheduleType	ScheduleType	None.
ScheduleDate	date	None.
CampaignScheduleDate	date	None.
RecurringStopDate	date	None.
IntervalLength	integer	None.
RecurringSendIntervalType	IntervalType	None.
RecurringSendIntervalLength	integer	None.
IsLimitMessageSendToContactOnEachRecurrance	boolean	None.
NumberOfSendToEachContact	integer	None.
ResetCampaignContactLimit	ResetCampaignContactLimit	None.
ResetCampaignContactLimitIntervalType	ResetCampaignContactLimitIntervalType	None.
ResetCampaignContactLimitAfterIntervalLength	integer	None.
IsLockContacts	boolean	None.
LockContactDate	date	None.
IsRandomDelivery	boolean	None.
RandomDeliveryCriteria	RandomDeliveryCriteria	None.
RandomDeliveryValue	integer	None.
ChooseRandomContactsInPriorityOrder	boolean	None.
IsSendOnSpecificDays	boolean	None.
IsBatchSplitIntoBatches	boolean	None.
SendOnSpecificDays	DaysOfWeekViewModel	None.
RecurringStopType	RecurringStopType	None.
RecurringStopAfterNumberOfSend	integer	None.
RecurringStopAfterIntervalLength	integer	None.
NumberOfBatches	integer	None.
BatchIntervalLength	integer	None.
BatchIntervalType	IntervalType	None.
TimeZoneId	string	None.
CampaignStatus	CampaignOrRemidnerStatus	None.
IsEnableSmartReminder	boolean	None.
ReminderIntervalType	IntervalType	None.
ReminderSendType	ReminderSendType	None.
ReminderIntervalLength	integer	None.
TemplateHtml	string	None.
ReminderSliderRange	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CampaignName": "sample string 1",
  "AccountId": "sample string 2",
  "CampaignId": "sample string 3",
  "CampaignScheduleType": "SendCampaignNow",
  "ScheduleDate": "2024-11-21T08:36:25.5337435+00:00",
  "CampaignScheduleDate": "2024-11-21T08:36:25.5337435+00:00",
  "RecurringStopDate": "2024-11-21T08:36:25.5337435+00:00",
  "IntervalLength": 4,
  "RecurringSendIntervalType": "Minute",
  "RecurringSendIntervalLength": 5,
  "IsLimitMessageSendToContactOnEachRecurrance": true,
  "NumberOfSendToEachContact": 7,
  "ResetCampaignContactLimit": "Never",
  "ResetCampaignContactLimitIntervalType": "Days",
  "ResetCampaignContactLimitAfterIntervalLength": 8,
  "IsLockContacts": true,
  "LockContactDate": "2024-11-21T08:36:25.5337435+00:00",
  "IsRandomDelivery": true,
  "RandomDeliveryCriteria": "ContactPercentage",
  "RandomDeliveryValue": 11,
  "ChooseRandomContactsInPriorityOrder": true,
  "IsSendOnSpecificDays": true,
  "IsBatchSplitIntoBatches": true,
  "SendOnSpecificDays": {
    "Day": [
      "Sunday",
      "Sunday"
    ]
  },
  "RecurringStopType": "Never",
  "RecurringStopAfterNumberOfSend": 15,
  "RecurringStopAfterIntervalLength": 16,
  "NumberOfBatches": 17,
  "BatchIntervalLength": 18,
  "BatchIntervalType": "Minute",
  "TimeZoneId": "sample string 19",
  "CampaignStatus": "Draft",
  "IsEnableSmartReminder": true,
  "ReminderIntervalType": "Minute",
  "ReminderSendType": "Text",
  "ReminderIntervalLength": 21,
  "TemplateHtml": "sample string 22",
  "ReminderSliderRange": 23
}

application/xml, text/xml

Sample:

<CampaignScheduleInformationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">
  <AccountId>sample string 2</AccountId>
  <BatchIntervalLength>18</BatchIntervalLength>
  <BatchIntervalType>Minute</BatchIntervalType>
  <CampaignId>sample string 3</CampaignId>
  <CampaignName>sample string 1</CampaignName>
  <CampaignScheduleDate>2024-11-21T08:36:25.5337435+00:00</CampaignScheduleDate>
  <CampaignScheduleType>SendCampaignNow</CampaignScheduleType>
  <CampaignStatus>Draft</CampaignStatus>
  <ChooseRandomContactsInPriorityOrder>true</ChooseRandomContactsInPriorityOrder>
  <IntervalLength>4</IntervalLength>
  <IsBatchSplitIntoBatches>true</IsBatchSplitIntoBatches>
  <IsEnableSmartReminder>true</IsEnableSmartReminder>
  <IsLimitMessageSendToContactOnEachRecurrance>true</IsLimitMessageSendToContactOnEachRecurrance>
  <IsLockContacts>true</IsLockContacts>
  <IsRandomDelivery>true</IsRandomDelivery>
  <IsSendOnSpecificDays>true</IsSendOnSpecificDays>
  <LockContactDate>2024-11-21T08:36:25.5337435+00:00</LockContactDate>
  <NumberOfBatches>17</NumberOfBatches>
  <NumberOfSendToEachContact>7</NumberOfSendToEachContact>
  <RandomDeliveryCriteria>ContactPercentage</RandomDeliveryCriteria>
  <RandomDeliveryValue>11</RandomDeliveryValue>
  <RecurringSendIntervalLength>5</RecurringSendIntervalLength>
  <RecurringSendIntervalType>Minute</RecurringSendIntervalType>
  <RecurringStopAfterIntervalLength>16</RecurringStopAfterIntervalLength>
  <RecurringStopAfterNumberOfSend>15</RecurringStopAfterNumberOfSend>
  <RecurringStopDate>2024-11-21T08:36:25.5337435+00:00</RecurringStopDate>
  <RecurringStopType>Never</RecurringStopType>
  <ReminderIntervalLength>21</ReminderIntervalLength>
  <ReminderIntervalType>Minute</ReminderIntervalType>
  <ReminderSendType>Text</ReminderSendType>
  <ReminderSliderRange>23</ReminderSliderRange>
  <ResetCampaignContactLimit>Never</ResetCampaignContactLimit>
  <ResetCampaignContactLimitAfterIntervalLength>8</ResetCampaignContactLimitAfterIntervalLength>
  <ResetCampaignContactLimitIntervalType>Days</ResetCampaignContactLimitIntervalType>
  <ScheduleDate>2024-11-21T08:36:25.5337435+00:00</ScheduleDate>
  <SendOnSpecificDays xmlns:d2p1="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
    <d2p1:Day xmlns:d3p1="http://schemas.datacontract.org/2004/07/MindMe.Shared.Common">
      <d3p1:DaysOfWeek>Sunday</d3p1:DaysOfWeek>
      <d3p1:DaysOfWeek>Sunday</d3p1:DaysOfWeek>
    </d2p1:Day>
  </SendOnSpecificDays>
  <TemplateHtml>sample string 22</TemplateHtml>
  <TimeZoneId>sample string 19</TimeZoneId>
</CampaignScheduleInformationViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.