curl -X POST \
'https://api.appcharge.com/v2/offer/special-offer-1' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
"name": "My New Special Offer Name",
"type": "SpecialOffer",
"active": true,
"segments": [
"New User"
],
"productsSequence": [
{
"index": 1,
"playerAvailability": 12,
"hidePlayerAvailability": true,
"products": [
{
"priority": "Sub",
"publisherProductId": "6cb43621ccf1",
"quantity": "100",
}
]
"priceInUsdCents": 1000
}
],
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"displayName": "My Special Offer",
"description": "This is my special offer description.",
"offerUiId": "2bc77ff889b",
"offerExternalUiId": "2bc22377ff889cc",
"badges": [
{
"publisherBadgeId": "12ac77ff889b"
}
]
}'
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"offerId": "226cff96123a8717",
"publisherOfferId": "special-offer-1",
"displayName": "My Special Offer",
"description": "This is my special offer description.",
"name": "My New Special Offer Name",
"type": "SpecialOffer",
"active": true,
"segments": [
"New User"
],
"publisherTabId": "tab-1",
"offerUi": {
"offerUiId": "2bc77ff889b",
"active": true,
"offerUiType": "SpecialOffer",
"name": "specialOffer1",
"description": "description",
"backgroundImage": "https://media.appcharge.com/media/65cb7182__4dc30c81-e4aa-40e8-9033-84cb05721bd0",
"borderColor": {
"colorOne": "#ffffff",
"colorTwo": "",
"direction": ""
},
"borderWidth": 2,
"externalId": "specialOffer1"
},
"productsSequence": [
{
"index": 1,
"playerAvailability": 12,
"hidePlayerAvailability": true,
"products": [
{
"product": {
"publisherProductId": "6cb43621ccf1",
"name": "Coins",
"textFontColorHex": "#FFFFFF",
"type": "Quantity",
"prefix": "",
"suffix": "",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/45cb7861ec8924a6b69a0f59/download.jpeg"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-02-14T10:08:17.061Z",
"updatedAt": "2024-09-27T13:41:55.775Z",
"displayName": "coins",
"productId": "75cc91114cf653a9cc2dce2c"
},
"publisherProductId": "6cb43621ccf1",
"quantity": 1000,
"priority": "Main"
}
],
"priceInUsdCents": 980,
"badges": [],
"id": "68b4092c7a895e559a3ac8d9"
}
],
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"offerExternalUiId": "2bc22377ff889cc",
"badges": [
{
"publisherBadgeId": "12ac77ff889b"
}
],
"createdAt": "2025-04-06T10:00:44.528Z",
"updatedAt": "2025-06-06T10:00:44.528Z"
}
Update Special Offer
Updates a special offer.
curl -X POST \
'https://api.appcharge.com/v2/offer/special-offer-1' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
"name": "My New Special Offer Name",
"type": "SpecialOffer",
"active": true,
"segments": [
"New User"
],
"productsSequence": [
{
"index": 1,
"playerAvailability": 12,
"hidePlayerAvailability": true,
"products": [
{
"priority": "Sub",
"publisherProductId": "6cb43621ccf1",
"quantity": "100",
}
]
"priceInUsdCents": 1000
}
],
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"displayName": "My Special Offer",
"description": "This is my special offer description.",
"offerUiId": "2bc77ff889b",
"offerExternalUiId": "2bc22377ff889cc",
"badges": [
{
"publisherBadgeId": "12ac77ff889b"
}
]
}'
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"offerId": "226cff96123a8717",
"publisherOfferId": "special-offer-1",
"displayName": "My Special Offer",
"description": "This is my special offer description.",
"name": "My New Special Offer Name",
"type": "SpecialOffer",
"active": true,
"segments": [
"New User"
],
"publisherTabId": "tab-1",
"offerUi": {
"offerUiId": "2bc77ff889b",
"active": true,
"offerUiType": "SpecialOffer",
"name": "specialOffer1",
"description": "description",
"backgroundImage": "https://media.appcharge.com/media/65cb7182__4dc30c81-e4aa-40e8-9033-84cb05721bd0",
"borderColor": {
"colorOne": "#ffffff",
"colorTwo": "",
"direction": ""
},
"borderWidth": 2,
"externalId": "specialOffer1"
},
"productsSequence": [
{
"index": 1,
"playerAvailability": 12,
"hidePlayerAvailability": true,
"products": [
{
"product": {
"publisherProductId": "6cb43621ccf1",
"name": "Coins",
"textFontColorHex": "#FFFFFF",
"type": "Quantity",
"prefix": "",
"suffix": "",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/45cb7861ec8924a6b69a0f59/download.jpeg"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-02-14T10:08:17.061Z",
"updatedAt": "2024-09-27T13:41:55.775Z",
"displayName": "coins",
"productId": "75cc91114cf653a9cc2dce2c"
},
"publisherProductId": "6cb43621ccf1",
"quantity": 1000,
"priority": "Main"
}
],
"priceInUsdCents": 980,
"badges": [],
"id": "68b4092c7a895e559a3ac8d9"
}
],
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"offerExternalUiId": "2bc22377ff889cc",
"badges": [
{
"publisherBadgeId": "12ac77ff889b"
}
],
"createdAt": "2025-04-06T10:00:44.528Z",
"updatedAt": "2025-06-06T10:00:44.528Z"
}
curl -X POST \
'https://api.appcharge.com/v2/offer/special-offer-1' \
-H 'Content-Type: application/json' \
-H 'x-publisher-token: <x-publisher-token>' \
-d '{
"name": "My New Special Offer Name",
"type": "SpecialOffer",
"active": true,
"segments": [
"New User"
],
"productsSequence": [
{
"index": 1,
"playerAvailability": 12,
"hidePlayerAvailability": true,
"products": [
{
"priority": "Sub",
"publisherProductId": "6cb43621ccf1",
"quantity": "100",
}
]
"priceInUsdCents": 1000
}
],
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"displayName": "My Special Offer",
"description": "This is my special offer description.",
"offerUiId": "2bc77ff889b",
"offerExternalUiId": "2bc22377ff889cc",
"badges": [
{
"publisherBadgeId": "12ac77ff889b"
}
]
}'
{
"publisherId": "35nb7861ec9924a6b69a0fe59",
"offerId": "226cff96123a8717",
"publisherOfferId": "special-offer-1",
"displayName": "My Special Offer",
"description": "This is my special offer description.",
"name": "My New Special Offer Name",
"type": "SpecialOffer",
"active": true,
"segments": [
"New User"
],
"publisherTabId": "tab-1",
"offerUi": {
"offerUiId": "2bc77ff889b",
"active": true,
"offerUiType": "SpecialOffer",
"name": "specialOffer1",
"description": "description",
"backgroundImage": "https://media.appcharge.com/media/65cb7182__4dc30c81-e4aa-40e8-9033-84cb05721bd0",
"borderColor": {
"colorOne": "#ffffff",
"colorTwo": "",
"direction": ""
},
"borderWidth": 2,
"externalId": "specialOffer1"
},
"productsSequence": [
{
"index": 1,
"playerAvailability": 12,
"hidePlayerAvailability": true,
"products": [
{
"product": {
"publisherProductId": "6cb43621ccf1",
"name": "Coins",
"textFontColorHex": "#FFFFFF",
"type": "Quantity",
"prefix": "",
"suffix": "",
"priority": "Sub",
"images": [
{
"type": "product",
"url": "https://media.appcharge.com/media/45cb7861ec8924a6b69a0f59/download.jpeg"
},
{
"type": "productPrefix",
"url": ""
}
],
"createdAt": "2024-02-14T10:08:17.061Z",
"updatedAt": "2024-09-27T13:41:55.775Z",
"displayName": "coins",
"productId": "75cc91114cf653a9cc2dce2c"
},
"publisherProductId": "6cb43621ccf1",
"quantity": 1000,
"priority": "Main"
}
],
"priceInUsdCents": 980,
"badges": [],
"id": "68b4092c7a895e559a3ac8d9"
}
],
"productSale": {
"type": "percentage",
"sale": 100
},
"priceDiscount": {
"type": "percentage",
"discount": 20
},
"offerExternalUiId": "2bc22377ff889cc",
"badges": [
{
"publisherBadgeId": "12ac77ff889b"
}
],
"createdAt": "2025-04-06T10:00:44.528Z",
"updatedAt": "2025-06-06T10:00:44.528Z"
}
Headers
The publisher token used for authentication.
Path Parameters
The special offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.
Body
The type of offer - In this case 'SpecialOffer'.
SpecialOffer The name of the special offer (at least 3 characters).
If not specified, the special offer name will be used.
The description of the offer (conditionally returned).
Whether the special offer is active.
Internal ID for the Offer UI (required if offerExternalUiId not provided).
The offer UI ID as configured by the publisher (if provided, offerUiId is not required).
List of player segments that this special offer applies to (e.g., ["NewUser", "BigSpender"]). This is empty by default.
Tab ID in the web store.
List of badges associated with the special offer.
Show child attributes
Show child attributes
Sale details for products in the special offer. The sale will only be applied on the first offer.
Show child attributes
Show child attributes
Discount applied to the special offer price.
Show child attributes
Show child attributes
The sequence of products included in the special offer. Only one Products Sequence is allowed.
Show child attributes
Show child attributes
The schedule for when the special offer is available.
Show child attributes
Show child attributes
The publisher section ID.
Response
Special offer updated successfully.
Publisher ID.
The unique identifier of the special offer.
The special offer ID provided by the publisher. This is the offer's External ID value in the Publisher Dashboard.
The name of the special offer.
The display name of the special offer. If not provided, the name will be used.
The description of the offer (conditionally returned)
The type of special offer.
Whether the special offer is active.
List of player segments that this special offer applies to (e.g., ["NewUser", "BigSpender"]). This is empty by default.
Tab ID in the web store.
UI configuration for the special offer.
Show child attributes
Show child attributes
A sequence of products in the special offer.
Show child attributes
Show child attributes
List of badges associated with the special offer.
Show child attributes
Show child attributes
Sale details for products in the special offer. The sale will only be applied on the first offer.
Show child attributes
Show child attributes
Discount applied to the special offer price.
Show child attributes
Show child attributes
The schedule for when the special offer is available.
Show child attributes
Show child attributes
Date the special offer was created.
Date the special offer was updated.
Was this page helpful?