Skip to main content
PUT
/
components
/
v1
/
offer-design
/
{externalId}
cURL
curl --request PUT \
  --url https://api-sandbox.appcharge.com/components/v1/offer-design/{externalId} \
  --header 'Content-Type: application/json' \
  --header 'x-publisher-token: <api-key>' \
  --data '
{
  "offerUiType": "SpecialOffer",
  "name": "Summer Special Edition",
  "externalId": "summer_special_offer",
  "backgroundImageUrl": "https://media.appcharge.com/media/69133d595af23405d8e843a5",
  "title": {
    "text": "Hot New Deal",
    "fontColor": "#FFFF00",
    "fontSize": 18,
    "fontWeight": "bolder"
  }
}
'
{
  "id": "507f1f77bcf86cd799439011",
  "offerUiType": "SpecialOffer",
  "name": "Summer Special",
  "externalId": "summer_special_offer",
  "backgroundImageUrl": "https://media.appcharge.com/media/69133d595af23405d8e843a5",
  "title": {
    "text": "Limited Time Offer",
    "fontColor": "#FFFFFF",
    "fontSize": 16,
    "fontWeight": "bold"
  },
  "externalBackgroundImageUrl": "https://example.com/images/summer-special.png"
}

Documentation Index

Fetch the complete documentation index at: https://docs.appcharge.com/llms.txt

Use this file to discover all available pages before exploring further.

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"

Body

application/json

Update a special offer design.

​
offerUiType
enum<string>
required

Type of offer design.

Available options:
SpecialOffer
Example:

"SpecialOffer"

​
name
string

Offer design name.

Example:

"Summer Special Edition"

​
externalId
string

Design ID that you define.

Example:

"summer_special_offer"

​
backgroundImageUrl
string<url>

Background image URL in PNG or JPEG format.

For uploaded files, this is the Appcharge-hosted CDN URL. For external image URLs, this is the original image URL served from the provided URL. External image URLs are saved and used as-is, and Appcharge doesn't download, copy, upload, or host them. Images must remain available at the provided URLs.

We recommend uploading image files instead of using external URLs when possible.

Example:

"https://media.appcharge.com/media/69133d595af23405d8e843a5"

​
title
object

Offer title details.

Example:
{
  "text": "Hot New Deal",
  "fontColor": "#FFFF00",
  "fontSize": 18,
  "fontWeight": "bolder"
}

Response

Offer design updated successfully.

Response schema for a special offer design.

​
id
string

Design ID.

Example:

"507f1f77bcf86cd799439011"

​
offerUiType
enum<string>

Type of offer design.

Available options:
SpecialOffer
Example:

"SpecialOffer"

​
name
string

Offer design name.

Example:

"Summer Special"

​
externalId
string

Design ID that you defined.

Example:

"summer_special_offer"

​
backgroundImageUrl
string<url>

Background image URL. For uploaded files, this is the Appcharge-hosted CDN URL. For external image URLs, this is the original image URL served from the provided URL.

Example:

"https://media.appcharge.com/media/69133d595af23405d8e843a5"

​
title
object

Offer title details.

Example:
{
  "text": "Limited Time Offer",
  "fontColor": "#FFFFFF",
  "fontSize": 16,
  "fontWeight": "bold"
}
​
externalBackgroundImageUrl
string<url>

Original background image URL when the design uses an external image URL. This URL is used as provided to serve the image.

Example:

"https://example.com/images/summer-special.png"