Update Rolling Offer Design

curl -X PUT \
  'https://api.appcharge.com/components/v1/offer-design/rolling-offer-design' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  --data '{
    "offerUiType": "RollingOffer",
    "name": "Rolling Offer Design Updated",
    "externalId": "rolling-offer-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background-v2.png",
    "backgroundColor": "#272727",
    "backgroundOpacity": 80,
    "headerImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png",
    "arrowColor": "#ffffff",
    "enableScroll": true,
    "scrollArrowImageUrl": "https://media.appcharge.com/media/6a16acaaca88ed66dca87ea0/17823570__197c6854-d0af-4eba-8364-74bfb3c88e4f",
    "arrowImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/arrow.png",
    "borderColor": {
      "colorOne": "#ffffff",
      "colorTwo": "#ffffff",
      "gradientDirection": "to right"
    },
    "borderWidth": 2,
    "subRollingOffer": {
      "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
      "collectText": "FREE",
      "lockImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/lock.png",
      "backgroundColor": {
        "colorOne": "#ffffff",
        "colorTwo": "#ffffff",
        "gradientDirection": "to right"
      }
    }
  }'

{
  "id": "694a7c8e87f78fb36a931763",
  "offerUiType": "RollingOffer",
  "name": "Rolling Offer Design Updated",
  "externalId": "rolling-offer-design",
  "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background-v2.png",
  "externalBackgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background-v2.png",
  "backgroundColor": "#272727",
  "backgroundOpacity": 80,
  "headerImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png",
  "arrowColor": "#ffffff",
  "enableScroll": true,
  "scrollArrowImageUrl": "https://media.appcharge.com/media/6a16acaaca88ed66dca87ea0/17823570__197c6854-d0af-4eba-8364-74bfb3c88e4f",
  "arrowImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/arrow.png",
  "borderColor": {
    "colorOne": "#ffffff",
    "colorTwo": "#ffffff",
    "direction": "to right"
  },
  "borderWidth": 2,
  "subRollingOffer": {
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "collectText": "FREE",
    "lockImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/lock.png",
    "backgroundColor": {
      "colorOne": "#ffffff",
      "colorTwo": "#ffffff",
      "gradientDirection": "to right"
    }
  }
}

{
  "message": "Unauthorized"
}

PUT

components

offer-design

{externalId}

curl -X PUT \
  'https://api.appcharge.com/components/v1/offer-design/rolling-offer-design' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  --data '{
    "offerUiType": "RollingOffer",
    "name": "Rolling Offer Design Updated",
    "externalId": "rolling-offer-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background-v2.png",
    "backgroundColor": "#272727",
    "backgroundOpacity": 80,
    "headerImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png",
    "arrowColor": "#ffffff",
    "enableScroll": true,
    "scrollArrowImageUrl": "https://media.appcharge.com/media/6a16acaaca88ed66dca87ea0/17823570__197c6854-d0af-4eba-8364-74bfb3c88e4f",
    "arrowImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/arrow.png",
    "borderColor": {
      "colorOne": "#ffffff",
      "colorTwo": "#ffffff",
      "gradientDirection": "to right"
    },
    "borderWidth": 2,
    "subRollingOffer": {
      "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
      "collectText": "FREE",
      "lockImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/lock.png",
      "backgroundColor": {
        "colorOne": "#ffffff",
        "colorTwo": "#ffffff",
        "gradientDirection": "to right"
      }
    }
  }'

{
  "id": "694a7c8e87f78fb36a931763",
  "offerUiType": "RollingOffer",
  "name": "Rolling Offer Design Updated",
  "externalId": "rolling-offer-design",
  "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background-v2.png",
  "externalBackgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background-v2.png",
  "backgroundColor": "#272727",
  "backgroundOpacity": 80,
  "headerImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png",
  "arrowColor": "#ffffff",
  "enableScroll": true,
  "scrollArrowImageUrl": "https://media.appcharge.com/media/6a16acaaca88ed66dca87ea0/17823570__197c6854-d0af-4eba-8364-74bfb3c88e4f",
  "arrowImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/arrow.png",
  "borderColor": {
    "colorOne": "#ffffff",
    "colorTwo": "#ffffff",
    "direction": "to right"
  },
  "borderWidth": 2,
  "subRollingOffer": {
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "collectText": "FREE",
    "lockImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/lock.png",
    "backgroundColor": {
      "colorOne": "#ffffff",
      "colorTwo": "#ffffff",
      "gradientDirection": "to right"
    }
  }
}

{
  "message": "Unauthorized"
}

curl -X PUT \
  'https://api.appcharge.com/components/v1/offer-design/rolling-offer-design' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'x-publisher-token: <x-publisher-token>' \
  --data '{
    "offerUiType": "RollingOffer",
    "name": "Rolling Offer Design Updated",
    "externalId": "rolling-offer-design",
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background-v2.png",
    "backgroundColor": "#272727",
    "backgroundOpacity": 80,
    "headerImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png",
    "arrowColor": "#ffffff",
    "enableScroll": true,
    "scrollArrowImageUrl": "https://media.appcharge.com/media/6a16acaaca88ed66dca87ea0/17823570__197c6854-d0af-4eba-8364-74bfb3c88e4f",
    "arrowImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/arrow.png",
    "borderColor": {
      "colorOne": "#ffffff",
      "colorTwo": "#ffffff",
      "gradientDirection": "to right"
    },
    "borderWidth": 2,
    "subRollingOffer": {
      "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
      "collectText": "FREE",
      "lockImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/lock.png",
      "backgroundColor": {
        "colorOne": "#ffffff",
        "colorTwo": "#ffffff",
        "gradientDirection": "to right"
      }
    }
  }'

{
  "id": "694a7c8e87f78fb36a931763",
  "offerUiType": "RollingOffer",
  "name": "Rolling Offer Design Updated",
  "externalId": "rolling-offer-design",
  "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background-v2.png",
  "externalBackgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background-v2.png",
  "backgroundColor": "#272727",
  "backgroundOpacity": 80,
  "headerImage": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png",
  "arrowColor": "#ffffff",
  "enableScroll": true,
  "scrollArrowImageUrl": "https://media.appcharge.com/media/6a16acaaca88ed66dca87ea0/17823570__197c6854-d0af-4eba-8364-74bfb3c88e4f",
  "arrowImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/arrow.png",
  "borderColor": {
    "colorOne": "#ffffff",
    "colorTwo": "#ffffff",
    "direction": "to right"
  },
  "borderWidth": 2,
  "subRollingOffer": {
    "backgroundImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png",
    "collectText": "FREE",
    "lockImageUrl": "https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/lock.png",
    "backgroundColor": {
      "colorOne": "#ffffff",
      "colorTwo": "#ffffff",
      "gradientDirection": "to right"
    }
  }
}

{
  "message": "Unauthorized"
}

Headers

x-publisher-token

string

required

Publisher token, as displayed in the Publisher Dashboard.

Path Parameters

externalId

string

required

Design ID that you defined.

Body

application/json

Update a rolling offer design.

offerUiType

enum<string>

Type of offer design.

Available options:

RollingOffer

Example:

"RollingOffer"

name

string

Offer design name.

Example:

"Rolling Offer Design Updated"

externalId

string

Design ID that you define.

Example:

"rolling-offer-design"

backgroundImageUrl

string<url>

Background image URL for the offer design.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background-v2.png"

backgroundColor

string

Background color of the rolling offer.

Example:

"#272727"

backgroundOpacity

number

Background opacity value.

Example:

80

headerImage

string<url>

Header image URL for the rolling offer.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png"

arrowColor

string

Color of the arrow in the rolling offer.

Example:

"#ffffff"

enableScroll

boolean

default:false

Whether scrolling through sub offers is enabled. Scroll arrows appear only in the horizontal Rolling Offer layout on desktop. In the vertical layout on mobile, players scroll or swipe without arrows. When false, scrolling is off and scrollArrowImageUrl is ignored.

Example:

true

scrollArrowImageUrl

string<url>

Image URL for a custom square image with a right-pointing arrow for the scroll controls. Appcharge mirrors the image for the opposite direction. If omitted, Appcharge uses default scroll arrow icons. Only applies when enableScroll is true.

Example:

"https://media.appcharge.com/media/6a16acaaca88ed66dca87ea0/17823570__197c6854-d0af-4eba-8364-74bfb3c88e4f"

arrowImageUrl

string<url>

Image URL for the arrows between sub offers.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/arrow.png"

borderColor

object

Border color configuration with gradient support.

Show child attributes

borderWidth

number

Width of the border in pixels.

Example:

2

subRollingOffer

object

Information about the sub rolling offer configuration.

Show child attributes

Response

Offer design updated successfully.

string

Design ID

Example:

"694a7c8e87f78fb36a931763"

offerUiType

enum<string>

Type of offer design.

Available options:

RollingOffer

Example:

"RollingOffer"

name

string

Offer design name.

Example:

"Rolling Offer Design"

externalId

string

Design ID that you defined.

Example:

"rolling-offer-design"

backgroundImageUrl

string<url>

Background image URL for the offer design.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/background.png"

backgroundColor

string

Background color of the rolling offer.

Example:

"#272727"

backgroundOpacity

number

Background opacity value.

Example:

80

headerImage

string<url>

Header image URL for the rolling offer.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/header.png"

arrowColor

string

Color of the arrow in the rolling offer.

Example:

"#ffffff"

enableScroll

boolean

default:false

Example:

true

scrollArrowImageUrl

string<url>

Example:

"https://media.appcharge.com/media/6a16acaaca88ed66dca87ea0/17823570__197c6854-d0af-4eba-8364-74bfb3c88e4f"

arrowImageUrl

string<url>

Image URL for the arrows between sub offers.

Example:

"https://media.appcharge.com/media/65cb7861ec8924a6b69a0f59/arrow.png"

borderColor

object

Color details returned by offer designs.

Show child attributes

borderWidth

number

Width of the border in pixels.

Example:

2

subRollingOffer

object

Information about the sub rolling offer configuration.

Show child attributes

externalBackgroundImageUrl

string<url>

Original background image URL for rolling offer backgrounds when an external image URL is used.

Example:

"https://cdn.example.com/assets/background.png"

Overview

What's New

Web Store

Checkout

Game Portal

Media

Events Center

Translations

Headers

Path Parameters

Body

Response