Create Special Offer Design

Creates a special offer design.

POST /components/v1/offer-design

Create Special Offer Design

curl -X POST \
  'https://api.appcharge.com/components/v1/offer-design' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  --data '{
    "offerUiType": "SpecialOffer",
    "name": "Summer Special Design",
    "externalId": "summer-special-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "title": {
      "text": "Limited Time Offer",
      "fontColor": "#ffffff",
      "fontSize": 20,
      "fontWeight": "bold"
    },
    "buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix.png",
    "buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix-animation.json"
  }'

Create Special Offer Design

{
  "id": "68b3f37f3a2852af1a154fae",
  "offerUiType": "SpecialOffer",
  "name": "Summer Special Design",
  "externalId": "summer-special-design",
  "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
  "title": {
    "text": "Limited Time Offer",
    "fontColor": {
      "colorOne": "#ffffff"
    },
    "fontSize": 20,
    "fontWeight": "bold"
  },
  "buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix.png",
  "buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix-animation.json"
}

Create Special Offer Design

curl -X POST \
  'https://api.appcharge.com/components/v1/offer-design' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  --data '{
    "offerUiType": "SpecialOffer",
    "name": "Summer Special Design",
    "externalId": "summer-special-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "title": {
      "text": "Limited Time Offer",
      "fontColor": "#ffffff",
      "fontSize": 20,
      "fontWeight": "bold"
    },
    "buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix.png",
    "buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix-animation.json"
  }'

Create Special Offer Design

{
  "id": "68b3f37f3a2852af1a154fae",
  "offerUiType": "SpecialOffer",
  "name": "Summer Special Design",
  "externalId": "summer-special-design",
  "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
  "title": {
    "text": "Limited Time Offer",
    "fontColor": {
      "colorOne": "#ffffff"
    },
    "fontSize": 20,
    "fontWeight": "bold"
  },
  "buttonSuffixImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix.png",
  "buttonSuffixAnimation": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix-animation.json"
}

Authorizations

x-publisher-token · string · header · required

Publisher token, as displayed in the Publisher Dashboard.

Body

application/json

Design a special offer.

offerUiType · enum<string> · required

Type of offer design.

Available options: SpecialOffer

Example:

"SpecialOffer"

name · string · required

Offer design name.

Example:

"Summer Special Design"

externalId · string · required

Design ID that you define.

Example:

"summer-special-design"

backgroundImageUrl · string<url> · required

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/65cb7861ec8924a6b69a0f59/background.png"

title · object

Show child attributes

buttonSuffixImage · string

Button asset suffix for the promotion offer design.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix.png"

buttonSuffixAnimation · string

Button asset suffix animation for the promotion offer design.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix-animation.json"

Response

200

application/json

Offer design created successfully.

id · string

Design ID.

Example:

"68b3f37f3a2852af1a154fae"

offerUiType · enum<string>

Type of offer design.

Available options: SpecialOffer

Example:

"SpecialOffer"

name · string

Offer design name.

Example:

"Summer Special Design"

externalId · string

Design ID that you defined.

Example:

"summer-special-design"

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/65cb7861ec8924a6b69a0f59/background.png"

title · object

Show child attributes

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://cdn.example.com/assets/background.png"

buttonSuffixImage · string

Button asset suffix for the promotion offer design.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix.png"

buttonSuffixAnimation · string

Button asset suffix animation for the promotion offer design.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/button-suffix-animation.json"