GET
/
components
/
v1
/
offer-design
/
{externalId}
cURL
curl --request GET \
  --url https://api-sandbox.appcharge.com/components/v1/offer-design/{externalId} \
  --header 'x-publisher-token: <api-key>'
{
  "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"
}

Authorizations

​
x-publisher-token
string
header
required

Publisher token, as displayed in the Publisher Dashboard.

Path Parameters

​
externalId
string
required

Design ID that you defined.

Example:

"summer_special_offer"

Response

200
application/json

Offer design details retrieved successfully.

Response schema for a special offer design.