POST api/Campaigns

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	None.
InternalName	string	None.
Description	string	None.
InternalNotes	string	None.
EmailHeader	string	None.
EmailText	string	None.
SmsText	string	None.
LandingText	string	None.
LandingTextMobile	string	None.
LandingTextPad	string	None.
IsSms	boolean	None.
IsEmail	boolean	None.
IsIncludingProductsInMarketing	boolean	None.
IsIncludingPersonInMarketing	boolean	None.
Price	decimal number	None.
Currency	string	None.
StartDate	date	None.
StopDate	date	None.
EmailSender	integer	None.
EmailSenderEmail	string	None.
IsFreePostage	boolean	None.
IsSourceEseco	boolean	None.
IsSourceParadise	boolean	None.
MaxCount	integer	None.
SpecialFilter	integer	None.
SmsSender	string	None.
CampaignCode	string	None.
IsRelativeSale	boolean	None.
RelativePercentageSale	decimal number	None.
SaleMaximumProducts	integer	None.
IsActive	boolean	None.
LandingUrl	string	None.
CountryCode	string	None.
RunningHoursStart	integer	None.
RunningHoursStop	integer	None.
IsOther	boolean	None.
IsOther2	boolean	None.
CampaignGroup	string	None.
EsecoCampaignCode	string	None.
Recurring	boolean	None.
RecurringPrices	string	None.
RecurringPostages	string	None.
IsRecurringFirstMonthFree	boolean	None.
IsRecurringDiscount	boolean	None.
RecurringDiscountMonthCount	integer	None.
RecurringDiscountPercentage	integer	None.
RecurringDiscountAmount	decimal number	None.
ValidDays	integer	None.
IsProductsDynamic	boolean	None.
IsAutomatic	boolean	None.
IsLocked	boolean	None.
CanCreatePersonalOffer	boolean	None.
LastOrderDaysAgo	integer	None.
LastOrderYearsAgo	integer	None.
LastCampaignDaysAgo	integer	None.
IsPassiveOnRelatedProducts	boolean	None.
IsAutorestart	boolean	None.
Shop	EntityDto	None.
PublishOrder	integer	None.
Weekdays	WeekdaysDto	None.
CampaignTemplateId	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "id": "25b207b2-f372-4a9f-a563-e42700bfbdfa",
  "name": "sample string 1",
  "internalName": "sample string 2",
  "description": "sample string 3",
  "internalNotes": "sample string 4",
  "emailHeader": "sample string 5",
  "emailText": "sample string 6",
  "smsText": "sample string 7",
  "landingText": "sample string 8",
  "landingTextMobile": "sample string 9",
  "landingTextPad": "sample string 10",
  "isSms": true,
  "isEmail": true,
  "isIncludingProductsInMarketing": true,
  "isIncludingPersonInMarketing": true,
  "price": 1.0,
  "currency": "sample string 11",
  "startDate": "2025-12-30T23:38:39.3051712+01:00",
  "stopDate": "2025-12-30T23:38:39.3051712+01:00",
  "emailSender": 1,
  "emailSenderEmail": "sample string 12",
  "isFreePostage": true,
  "isSourceEseco": true,
  "isSourceParadise": true,
  "maxCount": 1,
  "specialFilter": 1,
  "smsSender": "sample string 13",
  "campaignCode": "sample string 14",
  "isRelativeSale": true,
  "relativePercentageSale": 1.0,
  "saleMaximumProducts": 1,
  "isActive": true,
  "landingUrl": "sample string 15",
  "countryCode": "sample string 16",
  "runningHoursStart": 1,
  "runningHoursStop": 1,
  "isOther": true,
  "isOther2": true,
  "campaignGroup": "sample string 17",
  "esecoCampaignCode": "sample string 18",
  "recurring": true,
  "recurringPrices": "sample string 19",
  "recurringPostages": "sample string 20",
  "isRecurringFirstMonthFree": true,
  "isRecurringDiscount": true,
  "recurringDiscountMonthCount": 1,
  "recurringDiscountPercentage": 1,
  "recurringDiscountAmount": 1.0,
  "validDays": 1,
  "isProductsDynamic": true,
  "isAutomatic": true,
  "isLocked": true,
  "canCreatePersonalOffer": true,
  "lastOrderDaysAgo": 1,
  "lastOrderYearsAgo": 1,
  "lastCampaignDaysAgo": 1,
  "isPassiveOnRelatedProducts": true,
  "isAutorestart": true,
  "shop": {
    "id": "82bc8c75-fc96-432d-ae60-312229c472d5",
    "name": "sample string 2",
    "type": "sample string 3"
  },
  "publishOrder": 1,
  "weekdays": {
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": true,
    "sunday": true
  },
  "campaignTemplateId": "a89743dd-b598-4013-acba-557f05ad6a60"
}

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.