POST api/CampaignManagement/Delete

Request Information

URI Parameters

None.

Body Parameters

CampaignBindingModel
NameDescriptionTypeAdditional information
CampaignId

integer

None.

CampaignName

string

Required

String length: inclusive between 0 and 200

TrunkNumber1

string

Required

String length: inclusive between 0 and 15

TrunkNumber2

string

String length: inclusive between 0 and 15

Telephone1

string

String length: inclusive between 0 and 14

Telephone2

string

String length: inclusive between 0 and 14

MarketId

integer

None.

StartDate

date

Required

EndDate

date

Required

ActualEndDate

date

None.

ActiveYn

boolean

None.

DonationAmount

decimal number

Required

MonthlySuggested

boolean

Required

SpecialInstructions

string

String length: inclusive between 0 and 512

RadioStationName

string

String length: inclusive between 0 and 150

RadioStationName2

string

String length: inclusive between 0 and 150

CccUserId

integer

None.

CccTelephone

string

String length: inclusive between 0 and 14

CccEmail

string

String length: inclusive between 0 and 128

CampaignGoal

integer

Required

PreviousGoal

decimal number

Required

DayBegin

string

None.

DayEnd

string

None.

UpdateKey

integer

None.

DashboardUserId

string

String length: inclusive between 0 and 15

DashboardPassword

string

String length: inclusive between 0 and 25

LogoFileName

string

None.

DeletedYn

boolean

None.

PageScriptType

integer

Required

NoOfCsrSeats

integer

Required

ConversionRate

decimal number

None.

CountryIso

integer

Required

DjdashboardUserId

string

String length: inclusive between 0 and 15

DjdashboardPassword

string

String length: inclusive between 0 and 25

VerisignAccountId

integer

Required

FoundationName

string

Required

String length: inclusive between 0 and 100

HospitalId

integer

None.

CompanyId

integer

None.

SoftDescriptor

string

String length: inclusive between 0 and 256

VerisignComment1

string

String length: inclusive between 0 and 256

ScrollbarAmount

integer

Required

MailPrice

decimal number

None.

MailDate

date

None.

CampaignTypeId

integer

None.

AliasNameForHospital

string

String length: inclusive between 0 and 200

TwelveBy

boolean

None.

LanguageValue

string

Required

String length: inclusive between 0 and 20

CurrencyTypeId

integer

None.

CountryId

integer

None.

CkcCampaignId

integer

None.

DonotAllowRecurringPledges

boolean

None.

ProgramId

integer

Required

CanDelete

boolean

None.

NoOfHospitals

integer

None.

NoOfRadioStations

integer

None.

SplashPageUrl

string

None.

TimeZoneDiffHours

integer

None.

TimeZoneId

string

Required

DashboardStartDate

date

None.

DashboardEndDate

date

None.

EventStartDate

date

None.

EventEndDate

date

None.

DuplicateUserIdCampaignId

integer

None.

AdditionalSuggestedAmounts

string

None.

CmnCampaignId

integer

None.

ShowQuestionsObjections

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "campaignId": 1,
  "campaignName": "sample string 2",
  "trunkNumber1": "sample string 3",
  "trunkNumber2": "sample string 4",
  "telephone1": "sample string 5",
  "telephone2": "sample string 6",
  "marketId": 1,
  "startDate": "2023-01-21T22:25:53.2094281+00:00",
  "endDate": "2023-01-21T22:25:53.2094281+00:00",
  "actualEndDate": "2023-01-21T22:25:53.2094281+00:00",
  "activeYn": true,
  "donationAmount": 10.0,
  "monthlySuggested": true,
  "specialInstructions": "sample string 12",
  "radioStationName": "sample string 13",
  "radioStationName2": "sample string 14",
  "cccUserId": 15,
  "cccTelephone": "sample string 16",
  "cccEmail": "sample string 17",
  "campaignGoal": 18,
  "previousGoal": 19.0,
  "dayBegin": "sample string 20",
  "dayEnd": "sample string 21",
  "updateKey": 22,
  "dashboardUserId": "sample string 23",
  "dashboardPassword": "sample string 24",
  "logoFileName": "sample string 25",
  "deletedYn": true,
  "pageScriptType": 27,
  "noOfCsrSeats": 28,
  "conversionRate": 29.0,
  "countryIso": 30,
  "djdashboardUserId": "sample string 31",
  "djdashboardPassword": "sample string 32",
  "verisignAccountId": 33,
  "foundationName": "sample string 34",
  "hospitalId": 1,
  "companyId": 1,
  "softDescriptor": "sample string 35",
  "verisignComment1": "sample string 36",
  "scrollbarAmount": 37,
  "mailPrice": 38.0,
  "mailDate": "2023-01-21T22:25:53.2094281+00:00",
  "campaignTypeId": 39,
  "aliasNameForHospital": "sample string 40",
  "twelveBy": true,
  "languageValue": "sample string 42",
  "currencyTypeId": 1,
  "countryId": 43,
  "ckcCampaignId": 1,
  "donotAllowRecurringPledges": true,
  "programId": 1,
  "canDelete": true,
  "noOfHospitals": 45,
  "noOfRadioStations": 46,
  "splashPageUrl": "sample string 47",
  "timeZoneDiffHours": 1,
  "timeZoneId": "sample string 48",
  "dashboardStartDate": "2023-01-21T22:25:53.2094281+00:00",
  "dashboardEndDate": "2023-01-21T22:25:53.2094281+00:00",
  "eventStartDate": "2023-01-21T22:25:53.2094281+00:00",
  "eventEndDate": "2023-01-21T22:25:53.2094281+00:00",
  "duplicateUserIdCampaignId": 1,
  "additionalSuggestedAmounts": "sample string 49",
  "cmnCampaignId": 1,
  "showQuestionsObjections": true
}

application/xml, text/xml

Sample:
<CampaignBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CMN.DonorNet.V3.Binding.Models">
  <ActiveYn>true</ActiveYn>
  <ActualEndDate>2023-01-21T22:25:53.2094281+00:00</ActualEndDate>
  <AdditionalSuggestedAmounts>sample string 49</AdditionalSuggestedAmounts>
  <AliasNameForHospital>sample string 40</AliasNameForHospital>
  <CampaignGoal>18</CampaignGoal>
  <CampaignId>1</CampaignId>
  <CampaignName>sample string 2</CampaignName>
  <CampaignTypeId>39</CampaignTypeId>
  <CanDelete>true</CanDelete>
  <CccEmail>sample string 17</CccEmail>
  <CccTelephone>sample string 16</CccTelephone>
  <CccUserId>15</CccUserId>
  <CkcCampaignId>1</CkcCampaignId>
  <CmnCampaignId>1</CmnCampaignId>
  <CompanyId>1</CompanyId>
  <ConversionRate>29</ConversionRate>
  <CountryId>43</CountryId>
  <CountryIso>30</CountryIso>
  <CurrencyTypeId>1</CurrencyTypeId>
  <DashboardEndDate>2023-01-21T22:25:53.2094281+00:00</DashboardEndDate>
  <DashboardPassword>sample string 24</DashboardPassword>
  <DashboardStartDate>2023-01-21T22:25:53.2094281+00:00</DashboardStartDate>
  <DashboardUserId>sample string 23</DashboardUserId>
  <DayBegin>sample string 20</DayBegin>
  <DayEnd>sample string 21</DayEnd>
  <DeletedYn>true</DeletedYn>
  <DjdashboardPassword>sample string 32</DjdashboardPassword>
  <DjdashboardUserId>sample string 31</DjdashboardUserId>
  <DonationAmount>10</DonationAmount>
  <DonotAllowRecurringPledges>true</DonotAllowRecurringPledges>
  <DuplicateUserIdCampaignId>1</DuplicateUserIdCampaignId>
  <EndDate>2023-01-21T22:25:53.2094281+00:00</EndDate>
  <EventEndDate>2023-01-21T22:25:53.2094281+00:00</EventEndDate>
  <EventStartDate>2023-01-21T22:25:53.2094281+00:00</EventStartDate>
  <FoundationName>sample string 34</FoundationName>
  <HospitalId>1</HospitalId>
  <LanguageValue>sample string 42</LanguageValue>
  <LogoFileName>sample string 25</LogoFileName>
  <MailDate>2023-01-21T22:25:53.2094281+00:00</MailDate>
  <MailPrice>38</MailPrice>
  <MarketId>1</MarketId>
  <MonthlySuggested>true</MonthlySuggested>
  <NoOfCsrSeats>28</NoOfCsrSeats>
  <NoOfHospitals>45</NoOfHospitals>
  <NoOfRadioStations>46</NoOfRadioStations>
  <PageScriptType>27</PageScriptType>
  <PreviousGoal>19</PreviousGoal>
  <ProgramId>1</ProgramId>
  <RadioStationName>sample string 13</RadioStationName>
  <RadioStationName2>sample string 14</RadioStationName2>
  <ScrollbarAmount>37</ScrollbarAmount>
  <ShowQuestionsObjections>true</ShowQuestionsObjections>
  <SoftDescriptor>sample string 35</SoftDescriptor>
  <SpecialInstructions>sample string 12</SpecialInstructions>
  <SplashPageUrl>sample string 47</SplashPageUrl>
  <StartDate>2023-01-21T22:25:53.2094281+00:00</StartDate>
  <Telephone1>sample string 5</Telephone1>
  <Telephone2>sample string 6</Telephone2>
  <TimeZoneDiffHours>1</TimeZoneDiffHours>
  <TimeZoneId>sample string 48</TimeZoneId>
  <TrunkNumber1>sample string 3</TrunkNumber1>
  <TrunkNumber2>sample string 4</TrunkNumber2>
  <TwelveBy>true</TwelveBy>
  <UpdateKey>22</UpdateKey>
  <VerisignAccountId>33</VerisignAccountId>
  <VerisignComment1>sample string 36</VerisignComment1>
</CampaignBindingModel>

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.