POST api/Incentives/SaveIncentiveDetail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AdminUserId	string	None.
Type	IncentiveType	Required
Name	string	Required
Description	string	None.
IsActive	boolean	None.
DiscountPrice	DiscountPriceSettingsViewModel	None.
IntroductoryPrice	IntroductoryPriceSettingsViewModel	None.
FreeAccount	FreeAccountSettingsViewModel	None.
UpgradeFeature	UpgradeFeatureSettingsViewModel	None.
Users	UserSettingsViewModel	None.
MobilePages	MobilePageSettingsViewModel	None.
AutomationSequences	AutomationSequenceSettingsViewModel	None.
WebForms	WebformSettingsViewModel	None.
Keywords	KeywordSettingsViewModel	None.
SubAccounts	SubAccountSettingsViewModel	None.
Contacts	ContactSettingsViewModel	None.
Credits	CreditSettingsViewModel	None.
CreditRollOver	CreditRollOverSettingsViewModel	None.
CreditMultiplier	CreditMultiplierSettingsViewModel	None.
TrialExtension	TrialExtensionSettingsViewModel	None.
Numbers	NumberSettingsViewModel	None.
Training	TrainingSettingsViewModel	None.
LibraryStorage	LibraryStorageSettingsViewModel	None.
Visits	VisitSettingsViewModel	None.
Id	string	None.
CreatedDate	date	None.
UpdatedDate	date	None.
CreatedBy	string	None.
UpdatedBy	string	None.
CreatedByUserId	string	None.
UpdatedByUserId	string	None.
IsDeleted	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "AdminUserId": "sample string 1",
  "Type": "DiscountPrice",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "IsActive": true,
  "DiscountPrice": {
    "DiscountValue": 1.0,
    "DiscountPriceApplicableOn": "Plan",
    "IsExpirationSet": true,
    "ExpireAfter": "Months",
    "ExpireAfterValue": 3,
    "DiscountPriceBasedOn": "Amount"
  },
  "IntroductoryPrice": {
    "Amount": 1.0,
    "ExpireAfterMonths": 2
  },
  "FreeAccount": {
    "Amount": 1.0,
    "IsExpirationSet": true,
    "ExpireAfterValue": 3,
    "ExpireAfter": "Days"
  },
  "UpgradeFeature": {
    "PlanId": "sample string 1",
    "PlanName": "sample string 2",
    "Type": "Plan",
    "Level": "IncreaseLevel1",
    "IsExpirationSet": true,
    "ExpireAfterValue": 4,
    "ExpireAfter": "Days"
  },
  "Users": {
    "AdditionalUserType": "IncreaseUser",
    "IsSetAdditionalUsers": true,
    "IsSetMaxUsers": true,
    "IsSetUserPrice": true,
    "PricePerUser": 4.0,
    "NumberOfMaxUsers": 5,
    "AdditionalUsers": 6
  },
  "MobilePages": {
    "AdditionalType": "IncreaseMobilePage",
    "AdditionalMobilePages": 1
  },
  "AutomationSequences": {
    "AdditionalType": "IncreaseAutomationSequence",
    "AdditionalAutomationSequences": 1
  },
  "WebForms": {
    "AdditionalType": "IncreaseWebform",
    "AdditionalWebforms": 1
  },
  "Keywords": {
    "AdditionalType": "IncreaseKeyword",
    "AdditionalKeywords": 1
  },
  "SubAccounts": {
    "AdditionalSubAccountType": "IncreaseSubAccounts",
    "IsSetAdditionalSubAccounts": true,
    "IsSetMaxSubAccounts": true,
    "IsSetSubAccountPrice": true,
    "PricePerSubAccount": 4.0,
    "NumberOfMaxSubAccounts": 5,
    "AdditionalSubAccounts": 6
  },
  "Contacts": {
    "AdditionalContactType": "IncreaseNumberOfContacts",
    "IsSetAdditionalContacts": true,
    "IsSetMaxContacts": true,
    "IsSetContactPrice": true,
    "PricePerContact": 4.0,
    "NumberOfMaxContacts": 5,
    "AdditionalContacts": 6,
    "IsExpirationSet": true,
    "ExpireAfterValue": 8,
    "ExpireAfter": "Days"
  },
  "Credits": {
    "AdditionalCreditType": "IncreaseNumberOfCredits",
    "IsSetAdditionalCredits": true,
    "IsSetMaxCredits": true,
    "IsSetCreditPrice": true,
    "PricePerCredit": 4.0,
    "PricePerExtraCredit": 5.0,
    "NumberOfMaxCredits": 6,
    "AdditionalCredits": 7,
    "IsExpirationSet": true,
    "ExpireAfterValue": 9,
    "ExpireAfter": "Days"
  },
  "CreditRollOver": {
    "RollOverMonths": 1,
    "IsExpirationSet": true,
    "ExpireAfterValue": 3,
    "ExpireAfter": "Days"
  },
  "CreditMultiplier": {
    "IsSetForEmailRoute": true,
    "IsSetForSmsRoute": true,
    "IsSetForMMSRoute": true,
    "CreditsPerEmail": 4.0,
    "CreditsPerSms": 5.0,
    "CreditsPerMMS": 6.0,
    "IsExpirationSet": true,
    "ExpireAfterValue": 8,
    "ExpireAfter": "Days"
  },
  "TrialExtension": {
    "Type": "ExtendTrialLength",
    "NumberOfTrialDays": 1
  },
  "Numbers": {
    "IsSetForTollFreeNumber": true,
    "IsSetForLocalNumber": true,
    "TotalTFNIncluded": 3,
    "TotalLocalNumberIncluded": 4,
    "AdditionalTFNPrice": 5.0,
    "AdditionalLocalNumberPrice": 6.0
  },
  "Training": {
    "TotalSessionsIncluded": 1,
    "PricePerAdditionalSession": 2.0
  },
  "LibraryStorage": {
    "Type": "UnlimitedStorage",
    "StorageValue": 1,
    "StorageUnit": "MB",
    "IsExpirationSet": true,
    "ExpireAfterValue": 3,
    "ExpireAfter": "Days"
  },
  "Visits": {
    "Type": "UnlimitedVists",
    "NumberOfVisits": 1,
    "IsExpirationSet": true,
    "ExpireAfterValue": 3,
    "ExpireAfter": "Days"
  },
  "Id": "sample string 5",
  "CreatedDate": "2024-11-21T08:40:20.1881279+00:00",
  "UpdatedDate": "2024-11-21T08:40:20.1881279+00:00",
  "CreatedBy": "sample string 8",
  "UpdatedBy": "sample string 9",
  "CreatedByUserId": "sample string 10",
  "UpdatedByUserId": "sample string 11",
  "IsDeleted": true
}

application/xml, text/xml

Sample:

<SaveUpdateIncentivesRequestViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Business.Service.Services.RequestViewModels.IncentivesAndPromos">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">sample string 8</CreatedBy>
  <CreatedByUserId xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">sample string 10</CreatedByUserId>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">2024-11-21T08:40:20.1881279+00:00</CreatedDate>
  <Id xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">sample string 5</Id>
  <IsDeleted xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">true</IsDeleted>
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">sample string 9</UpdatedBy>
  <UpdatedByUserId xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">sample string 11</UpdatedByUserId>
  <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">2024-11-21T08:40:20.1881279+00:00</UpdatedDate>
  <AutomationSequences xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <AdditionalAutomationSequences>1</AdditionalAutomationSequences>
    <AdditionalType>IncreaseAutomationSequence</AdditionalType>
  </AutomationSequences>
  <Contacts xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <AdditionalContactType>IncreaseNumberOfContacts</AdditionalContactType>
    <AdditionalContacts>6</AdditionalContacts>
    <ExpireAfter>Days</ExpireAfter>
    <ExpireAfterValue>8</ExpireAfterValue>
    <IsExpirationSet>true</IsExpirationSet>
    <IsSetAdditionalContacts>true</IsSetAdditionalContacts>
    <IsSetContactPrice>true</IsSetContactPrice>
    <IsSetMaxContacts>true</IsSetMaxContacts>
    <NumberOfMaxContacts>5</NumberOfMaxContacts>
    <PricePerContact>4</PricePerContact>
  </Contacts>
  <CreditMultiplier xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <CreditsPerEmail>4</CreditsPerEmail>
    <CreditsPerMMS>6</CreditsPerMMS>
    <CreditsPerSms>5</CreditsPerSms>
    <ExpireAfter>Days</ExpireAfter>
    <ExpireAfterValue>8</ExpireAfterValue>
    <IsExpirationSet>true</IsExpirationSet>
    <IsSetForEmailRoute>true</IsSetForEmailRoute>
    <IsSetForMMSRoute>true</IsSetForMMSRoute>
    <IsSetForSmsRoute>true</IsSetForSmsRoute>
  </CreditMultiplier>
  <CreditRollOver xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <ExpireAfter>Days</ExpireAfter>
    <ExpireAfterValue>3</ExpireAfterValue>
    <IsExpirationSet>true</IsExpirationSet>
    <RollOverMonths>1</RollOverMonths>
  </CreditRollOver>
  <Credits xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <AdditionalCreditType>IncreaseNumberOfCredits</AdditionalCreditType>
    <AdditionalCredits>7</AdditionalCredits>
    <ExpireAfter>Days</ExpireAfter>
    <ExpireAfterValue>9</ExpireAfterValue>
    <IsExpirationSet>true</IsExpirationSet>
    <IsSetAdditionalCredits>true</IsSetAdditionalCredits>
    <IsSetCreditPrice>true</IsSetCreditPrice>
    <IsSetMaxCredits>true</IsSetMaxCredits>
    <NumberOfMaxCredits>6</NumberOfMaxCredits>
    <PricePerCredit>4</PricePerCredit>
    <PricePerExtraCredit>5</PricePerExtraCredit>
  </Credits>
  <Description xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">sample string 3</Description>
  <DiscountPrice xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <DiscountPriceApplicableOn>Plan</DiscountPriceApplicableOn>
    <DiscountPriceBasedOn>Amount</DiscountPriceBasedOn>
    <DiscountValue>1</DiscountValue>
    <ExpireAfter>Months</ExpireAfter>
    <ExpireAfterValue>3</ExpireAfterValue>
    <IsExpirationSet>true</IsExpirationSet>
  </DiscountPrice>
  <FreeAccount xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <Amount>1</Amount>
    <ExpireAfter>Days</ExpireAfter>
    <ExpireAfterValue>3</ExpireAfterValue>
    <IsExpirationSet>true</IsExpirationSet>
  </FreeAccount>
  <IntroductoryPrice xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <Amount>1</Amount>
    <ExpireAfterMonths>2</ExpireAfterMonths>
  </IntroductoryPrice>
  <IsActive xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">true</IsActive>
  <Keywords xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <AdditionalKeywords>1</AdditionalKeywords>
    <AdditionalType>IncreaseKeyword</AdditionalType>
  </Keywords>
  <LibraryStorage xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <ExpireAfter>Days</ExpireAfter>
    <ExpireAfterValue>3</ExpireAfterValue>
    <IsExpirationSet>true</IsExpirationSet>
    <StorageUnit>MB</StorageUnit>
    <StorageValue>1</StorageValue>
    <Type>UnlimitedStorage</Type>
  </LibraryStorage>
  <MobilePages xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <AdditionalMobilePages>1</AdditionalMobilePages>
    <AdditionalType>IncreaseMobilePage</AdditionalType>
  </MobilePages>
  <Name xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">sample string 2</Name>
  <Numbers xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <AdditionalLocalNumberPrice>6</AdditionalLocalNumberPrice>
    <AdditionalTFNPrice>5</AdditionalTFNPrice>
    <IsSetForLocalNumber>true</IsSetForLocalNumber>
    <IsSetForTollFreeNumber>true</IsSetForTollFreeNumber>
    <TotalLocalNumberIncluded>4</TotalLocalNumberIncluded>
    <TotalTFNIncluded>3</TotalTFNIncluded>
  </Numbers>
  <SubAccounts xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <AdditionalSubAccountType>IncreaseSubAccounts</AdditionalSubAccountType>
    <AdditionalSubAccounts>6</AdditionalSubAccounts>
    <IsSetAdditionalSubAccounts>true</IsSetAdditionalSubAccounts>
    <IsSetMaxSubAccounts>true</IsSetMaxSubAccounts>
    <IsSetSubAccountPrice>true</IsSetSubAccountPrice>
    <NumberOfMaxSubAccounts>5</NumberOfMaxSubAccounts>
    <PricePerSubAccount>4</PricePerSubAccount>
  </SubAccounts>
  <Training xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <PricePerAdditionalSession>2</PricePerAdditionalSession>
    <TotalSessionsIncluded>1</TotalSessionsIncluded>
  </Training>
  <TrialExtension xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <NumberOfTrialDays>1</NumberOfTrialDays>
    <Type>ExtendTrialLength</Type>
  </TrialExtension>
  <Type xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">DiscountPrice</Type>
  <UpgradeFeature xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <ExpireAfter>Days</ExpireAfter>
    <ExpireAfterValue>4</ExpireAfterValue>
    <IsExpirationSet>true</IsExpirationSet>
    <Level>IncreaseLevel1</Level>
    <PlanId>sample string 1</PlanId>
    <PlanName>sample string 2</PlanName>
    <Type>Plan</Type>
  </UpgradeFeature>
  <Users xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <AdditionalUserType>IncreaseUser</AdditionalUserType>
    <AdditionalUsers>6</AdditionalUsers>
    <IsSetAdditionalUsers>true</IsSetAdditionalUsers>
    <IsSetMaxUsers>true</IsSetMaxUsers>
    <IsSetUserPrice>true</IsSetUserPrice>
    <NumberOfMaxUsers>5</NumberOfMaxUsers>
    <PricePerUser>4</PricePerUser>
  </Users>
  <Visits xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <ExpireAfter>Days</ExpireAfter>
    <ExpireAfterValue>3</ExpireAfterValue>
    <IsExpirationSet>true</IsExpirationSet>
    <NumberOfVisits>1</NumberOfVisits>
    <Type>UnlimitedVists</Type>
  </Visits>
  <WebForms xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel.IncentivesAndPromo">
    <AdditionalType>IncreaseWebform</AdditionalType>
    <AdditionalWebforms>1</AdditionalWebforms>
  </WebForms>
  <AdminUserId>sample string 1</AdminUserId>
</SaveUpdateIncentivesRequestViewModel>

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.