POST rest/coupons/share/{couponId}/{shared}
Update shared propery of a coupon.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
couponId |
Coupon id. |
globally unique identifier |
Required |
shared |
Coupon id. |
boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
CouponName | Description | Type | Additional information |
---|---|---|---|
id |
Id of coupon, must be unique. |
globally unique identifier |
None. |
Version |
Coupon version. Default is 0. Use version 2 for the new html template engine. |
byte |
None. |
PartnerId |
Id of Link partner from Partner API. |
integer |
None. |
Type |
COUPON or COUPON_BOOK |
string |
None. |
Username |
Username from login. |
string |
None. |
Name |
Name of coupon. |
string |
None. |
Description |
Description of coupon. |
string |
None. |
start |
When the coupon should start being active. |
date |
None. |
stop |
When the coupon should stop being active. |
date |
None. |
ReceiveOnce |
If coupon codes should be limited to one pr user. |
boolean |
None. |
Usages |
[Version 2 Only] Gets or sets the usages for a coupon. Valid values in the array are: * 1\. Bulk sending. * 2\. Opt-in message. |
Collection of CouponUsage |
None. |
HeaderText |
[Version 2 Only] Coupon header text. |
string |
None. |
HeaderBackgroundColor |
[Version 2 Only] Coupon header background color. |
string |
None. |
ThumbnailButtonText |
[Version 2 Only] Coupon thumbnail button text. |
string |
None. |
MainText |
[Version 2 Only] Main text. |
string |
None. |
ImageText |
[Version 2 Only] Coupon image overlay text. |
string |
None. |
ConditionsText |
[Version 2 Only] Coupon conditions text. |
string |
None. |
RedeemButtonText |
[Version 2 Only] Coupon redeem button text. |
string |
None. |
RedeemButtonTextColor |
[Version 2 Only] Coupon redeem button text color. |
string |
None. |
RedeemButtonBackgroundColor |
[Version 2 Only] Coupon redeem button background color. |
string |
None. |
RedeemWarningMessage |
[Version 2 Only] Coupon redeem-popup warning message. |
string |
None. |
RedeemOkButtonText |
[Version 2 Only] Coupon redeem-popup ok button text. |
string |
None. |
RedeemCancelButtonText |
[Version 2 Only] Coupon redeem-popup cancel button text. |
string |
None. |
RedeemOverlayText |
[Version 2 Only] Overlay text shown when coupon is redeemed. |
string |
None. |
BackgroundColor |
[Version 2 Only] Coupon background color. |
string |
None. |
MainTextOpacityBackgroundColor |
[Version 2 Only] Coupon bottom text background color. |
string |
None. |
MainTextOpacityValue |
[Version 2 Only] Coupon bottom text background color opacity value. |
string |
None. |
HeaderTextOpacityBackgroundColor |
[Version 2 Only] Coupon middle text background color. |
string |
None. |
HeaderTextOpacityValue |
[Version 2 Only] Coupon middle text background color opacity value. |
string |
None. |
TextOnImageOpacityBackgroundColor |
[Version 2 Only] Coupon top text background color. |
string |
None. |
TextOnImageOpacityValue |
[Version 2 Only] Coupon top text background color opacity value. |
string |
None. |
MainTextBorderRadius |
[Version 2 Only] Coupon bottom text border radius. |
string |
None. |
HeaderTextBorderRadius |
[Version 2 Only] Coupon middle text border radius. |
string |
None. |
TextOnImageBorderRadius |
[Version 2 Only] Coupon top text border radius. |
string |
None. |
MainTextFontFamily |
[Version 2 Only] Coupon bottom text font family. |
string |
None. |
HeaderTextFontFamily |
[Version 2 Only] Coupon middle text font family. |
string |
None. |
TextOnImageFontFamily |
[Version 2 Only] Coupon top text font family. |
string |
None. |
ImageTextColor |
[Version 2 Only] Coupon image text color |
string |
None. |
ValidText |
[Version 2 Only] Valid text |
string |
None. |
ActiveSoonStatusText |
[Version 2 Only] Active soon status text |
string |
None. |
ActiveStatusText |
[Version 2 Only] Active status text |
string |
None. |
ActivationTimeText |
[Version 2 Only] Activation time text |
string |
None. |
ExpiredStatusText |
[Version 2 Only] Expired status text |
string |
None. |
ExpirationTimeText |
[Version 2 Only] Expiration time text |
string |
None. |
IsInCouponBook |
WARNING! This property is obsolete. Please use ThumbnailButtonText instead. This field will be removed in a future version of the API. [Version 2 Only] Whether coupon is in a coupon book (read-only property). |
boolean |
None. |
CouponBookId |
[Version 2 Only] Gets or sets the Ids of the connected coupon books. |
globally unique identifier |
None. |
UsageCount |
How many times user has used coupon. |
integer |
None. |
validityPeriodMinutes |
How many minutes the coupon is valid. |
integer |
None. |
SiteTemplateId |
Site template id for coupon. |
globally unique identifier |
None. |
CodeGeneratorConfiguration |
Type of codes generated. |
CodeGeneratorConfiguration |
None. |
Site |
Coupon web site. |
Site |
None. |
StoreName |
[Version 2 Only] Gets or sets the store name that is sending this coupon. |
string |
None. |
DiscountType |
[Version 2 Only] Gets or sets the type of discount that the property represents. Valid values are: * 1\. The discount is given in percentages of the sales price. * 2\. The discount is given price discount subtracted from the sales price. * 3\. Some other type of discount (free, 3 for 2 and so on). |
DiscountType |
None. |
DiscountValue |
[Version 2 Only] Gets or sets the value of the discount, as described by . |
decimal number |
None. |
DynamicFields |
A list of dynamic fields. The key is used in the HTML template and replaced with the corresponding value when the actual coupon is served. |
Dictionary of string [key] and string [value] |
None. |
Images |
[Version 2] Coupon images. |
Collection of CouponImage |
None. |
created |
When the coupon was created. |
date |
None. |
lastModified |
When the coupon was last modified. |
date |
None. |
BatchIds |
Collection of batch ids (equivalent of SendingId in Sender). |
Collection of string |
None. |
MaxRedeemedCount |
Max redeemed count |
byte |
None. |
Shared |
Flag to indicate if a coupun is shared with partner children |
boolean |
None. |
Response Formats
application/json, text/json
{ "id": "e90c9773-172d-41d2-8c06-e60ff1cc325c", "version": 64, "partnerId": 4, "type": "sample string 5", "username": "sample string 6", "name": "sample string 7", "description": "sample string 8", "start": 1653039544089, "stop": 1653039544089, "receiveOnce": true, "usages": [ 1, 1 ], "headerText": "sample string 10", "headerBackgroundColor": "sample string 11", "thumbnailButtonText": "sample string 12", "mainText": "sample string 13", "imageText": "sample string 14", "conditionsText": "sample string 15", "redeemButtonText": "sample string 16", "redeemButtonTextColor": "sample string 17", "redeemButtonBackgroundColor": "sample string 18", "redeemWarningMessage": "sample string 19", "redeemOkButtonText": "sample string 20", "redeemCancelButtonText": "sample string 21", "redeemOverlayText": "sample string 22", "backgroundColor": "sample string 23", "mainTextOpacityBackgroundColor": "sample string 24", "mainTextOpacityValue": "sample string 25", "headerTextOpacityBackgroundColor": "sample string 26", "headerTextOpacityValue": "sample string 27", "textOnImageOpacityBackgroundColor": "sample string 28", "textOnImageOpacityValue": "sample string 29", "mainTextBorderRadius": "sample string 30", "headerTextBorderRadius": "sample string 31", "textOnImageBorderRadius": "sample string 32", "mainTextFontFamily": "sample string 33", "headerTextFontFamily": "sample string 34", "textOnImageFontFamily": "sample string 35", "imageTextColor": "sample string 36", "validText": "sample string 37", "activeSoonStatusText": "sample string 38", "activeStatusText": "sample string 39", "activationTimeText": "sample string 40", "expiredStatusText": "sample string 41", "expirationTimeText": "sample string 42", "isInCouponBook": true, "couponBookId": "ca4c603e-7362-465a-ab36-d22233c9f85a", "usageCount": 44, "validityPeriodMinutes": 1, "siteTemplateId": "aa5cab02-d6ed-44ab-9bfa-4aaa890b9d8a", "codeGeneratorConfiguration": { "type": "sample string 1", "length": "sample string 2" }, "site": { "pages": [ { "type": "sample string 2", "name": "sample string 3", "content": "sample string 4", "partial": true }, { "type": "sample string 2", "name": "sample string 3", "content": "sample string 4", "partial": true } ], "properties": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }, "storeName": "sample string 45", "discountType": 1, "discountValue": 1.0, "dynamicFields": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "images": [ { "name": "sample string 3", "resizeWidth": 1, "resizeHeight": 1, "cropLeft": 1, "cropTop": 1, "cropWidth": 1, "cropHeight": 1, "lastModifiedUtc": "2022-05-20T09:39:04.1049177Z", "createdUtc": "2022-05-20T09:39:04.1049177Z", "data": "sample string 6" }, { "name": "sample string 3", "resizeWidth": 1, "resizeHeight": 1, "cropLeft": 1, "cropTop": 1, "cropWidth": 1, "cropHeight": 1, "lastModifiedUtc": "2022-05-20T09:39:04.1049177Z", "createdUtc": "2022-05-20T09:39:04.1049177Z", "data": "sample string 6" } ], "created": 1653039544104, "lastModified": 1653039544104, "batchIds": [ "sample string 1", "sample string 2" ], "maxRedeemedCount": 64, "shared": true }
application/xml, text/xml
<Coupon xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.linkmobility.com/common/coupons"> <ActivationTimeText>sample string 40</ActivationTimeText> <ActiveSoonStatusText>sample string 38</ActiveSoonStatusText> <ActiveStatusText>sample string 39</ActiveStatusText> <BackgroundColor>sample string 23</BackgroundColor> <BatchIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </BatchIds> <CodeGeneratorConfiguration> <Length>sample string 2</Length> <Type>sample string 1</Type> </CodeGeneratorConfiguration> <ConditionsText>sample string 15</ConditionsText> <CouponBookId>ca4c603e-7362-465a-ab36-d22233c9f85a</CouponBookId> <Description>sample string 8</Description> <DiscountType>Percentage</DiscountType> <DiscountValue>1</DiscountValue> <DynamicFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 1</d2p1:Key> <d2p1:Value>sample string 2</d2p1:Value> </d2p1:KeyValueOfstringstring> <d2p1:KeyValueOfstringstring> <d2p1:Key>sample string 3</d2p1:Key> <d2p1:Value>sample string 4</d2p1:Value> </d2p1:KeyValueOfstringstring> </DynamicFields> <ExpirationTimeText>sample string 42</ExpirationTimeText> <ExpiredStatusText>sample string 41</ExpiredStatusText> <HeaderBackgroundColor>sample string 11</HeaderBackgroundColor> <HeaderText>sample string 10</HeaderText> <HeaderTextBorderRadius>sample string 31</HeaderTextBorderRadius> <HeaderTextFontFamily>sample string 34</HeaderTextFontFamily> <HeaderTextOpacityBackgroundColor>sample string 26</HeaderTextOpacityBackgroundColor> <HeaderTextOpacityValue>sample string 27</HeaderTextOpacityValue> <ImageText>sample string 14</ImageText> <ImageTextColor>sample string 36</ImageTextColor> <Images> <CouponImage> <Data>sample string 6</Data> <CreatedUtc>2022-05-20T09:39:04.1049177+00:00</CreatedUtc> <CropHeight>1</CropHeight> <CropLeft>1</CropLeft> <CropTop>1</CropTop> <CropWidth>1</CropWidth> <LastModifiedUtc>2022-05-20T09:39:04.1049177+00:00</LastModifiedUtc> <Name>sample string 3</Name> <ResizeHeight>1</ResizeHeight> <ResizeWidth>1</ResizeWidth> </CouponImage> <CouponImage> <Data>sample string 6</Data> <CreatedUtc>2022-05-20T09:39:04.1049177+00:00</CreatedUtc> <CropHeight>1</CropHeight> <CropLeft>1</CropLeft> <CropTop>1</CropTop> <CropWidth>1</CropWidth> <LastModifiedUtc>2022-05-20T09:39:04.1049177+00:00</LastModifiedUtc> <Name>sample string 3</Name> <ResizeHeight>1</ResizeHeight> <ResizeWidth>1</ResizeWidth> </CouponImage> </Images> <IsInCouponBook>true</IsInCouponBook> <MainText>sample string 13</MainText> <MainTextBorderRadius>sample string 30</MainTextBorderRadius> <MainTextFontFamily>sample string 33</MainTextFontFamily> <MainTextOpacityBackgroundColor>sample string 24</MainTextOpacityBackgroundColor> <MainTextOpacityValue>sample string 25</MainTextOpacityValue> <MaxRedeemedCount>64</MaxRedeemedCount> <Name>sample string 7</Name> <PartnerId>4</PartnerId> <ReceiveOnce>true</ReceiveOnce> <RedeemButtonBackgroundColor>sample string 18</RedeemButtonBackgroundColor> <RedeemButtonText>sample string 16</RedeemButtonText> <RedeemButtonTextColor>sample string 17</RedeemButtonTextColor> <RedeemCancelButtonText>sample string 21</RedeemCancelButtonText> <RedeemOkButtonText>sample string 20</RedeemOkButtonText> <RedeemOverlayText>sample string 22</RedeemOverlayText> <RedeemWarningMessage>sample string 19</RedeemWarningMessage> <Shared>true</Shared> <Site> <Pages> <SitePage> <Content>sample string 4</Content> <Name>sample string 3</Name> <Partial>true</Partial> <Type>sample string 2</Type> </SitePage> <SitePage> <Content>sample string 4</Content> <Name>sample string 3</Name> <Partial>true</Partial> <Type>sample string 2</Type> </SitePage> </Pages> <Properties xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </Properties> </Site> <SiteTemplateId>aa5cab02-d6ed-44ab-9bfa-4aaa890b9d8a</SiteTemplateId> <StoreName>sample string 45</StoreName> <TextOnImageBorderRadius>sample string 32</TextOnImageBorderRadius> <TextOnImageFontFamily>sample string 35</TextOnImageFontFamily> <TextOnImageOpacityBackgroundColor>sample string 28</TextOnImageOpacityBackgroundColor> <TextOnImageOpacityValue>sample string 29</TextOnImageOpacityValue> <ThumbnailButtonText>sample string 12</ThumbnailButtonText> <Type>sample string 5</Type> <UsageCount>44</UsageCount> <Usages xmlns:d2p1="http://schemas.datacontract.org/2004/07/Common.Coupons.Model.Enums"> <d2p1:CouponUsage>BulkSending</d2p1:CouponUsage> <d2p1:CouponUsage>BulkSending</d2p1:CouponUsage> </Usages> <Username>sample string 6</Username> <ValidText>sample string 37</ValidText> <Version>64</Version> <created>2022-05-20T09:39:04.1049177+00:00</created> <id>e90c9773-172d-41d2-8c06-e60ff1cc325c</id> <lastModified>2022-05-20T09:39:04.1049177+00:00</lastModified> <start>2022-05-20T09:39:04.0893015+00:00</start> <stop>2022-05-20T09:39:04.0893015+00:00</stop> <validityPeriodMinutes>1</validityPeriodMinutes> </Coupon>