curl --request POST \
--url https://api-sandbox.appcharge.com/components/v1/offer-design \
--header 'Content-Type: application/json' \
--header 'x-publisher-token: <api-key>' \
--data '{
"offerUiType": "SpecialOffer",
"name": "Summer Special",
"externalId": "summer_special_offer",
"backgroundImageUrl": "https://example.com/images/summer-special.png",
"title": {
"text": "Limited Time Offer",
"fontColor": "#FFFFFF",
"fontSize": 16,
"fontWeight": "bold"
}
}'
{
"id": "507f1f77bcf86cd799439011",
"offerUiType": "SpecialOffer",
"name": "Summer Special",
"externalId": "summer_special_offer",
"backgroundImageUrl": "https://cdn.appcharge.com/507f1f77bcf86cd799439011_background.png",
"title": {
"text": "Limited Time Offer",
"fontColor": "#FFFFFF",
"fontSize": 16,
"fontWeight": "bold"
},
"externalBackgroundImageUrl": "https://example.com/images/summer-special.png"
}
Creates an offer design.
curl --request POST \
--url https://api-sandbox.appcharge.com/components/v1/offer-design \
--header 'Content-Type: application/json' \
--header 'x-publisher-token: <api-key>' \
--data '{
"offerUiType": "SpecialOffer",
"name": "Summer Special",
"externalId": "summer_special_offer",
"backgroundImageUrl": "https://example.com/images/summer-special.png",
"title": {
"text": "Limited Time Offer",
"fontColor": "#FFFFFF",
"fontSize": 16,
"fontWeight": "bold"
}
}'
{
"id": "507f1f77bcf86cd799439011",
"offerUiType": "SpecialOffer",
"name": "Summer Special",
"externalId": "summer_special_offer",
"backgroundImageUrl": "https://cdn.appcharge.com/507f1f77bcf86cd799439011_background.png",
"title": {
"text": "Limited Time Offer",
"fontColor": "#FFFFFF",
"fontSize": 16,
"fontWeight": "bold"
},
"externalBackgroundImageUrl": "https://example.com/images/summer-special.png"
}
Publisher token, as displayed in the Publisher Dashboard.
Design a special offer.
Offer design created successfully.
Response schema for a special offer design.
Was this page helpful?