PUT
/
offering
/
offer
/
popup
/
{offerSKU}
curl --request PUT \
  --url https://api-sandbox.appcharge.com/offering/offer/popup/{offerSKU} \
  --header 'Content-Type: application/json' \
  --header 'x-publisher-token: <x-publisher-token>' \
  --data '{
  "publisherOfferId": "Test_Popup_New",
  "name": "Test_Popup",
  "displayName": "<string>",
  "description": "Best offer ever.",
  "offerUiId": "64a55b82e06998282d3d9b59",
  "offerExternalUiId": "b9c1e7a3d1f8b2a4c6e5d8f3",
  "dynamicOfferUi": {
    "badges": [
      {
        "publisherBadgeId": "badge1",
        "badge": {
          "badgeId": "6548afb2ed7ec741ac8deeff",
          "publisherBadgeId": "badge1",
          "position": "right",
          "name": "test_badge",
          "type": "emblem",
          "emblem": {
            "imageUrl": "<string>"
          },
          "ribbon": {
            "text": "<string>",
            "backgroundColor": {
              "gradientDirection": "<string>",
              "colorOne": "<string>",
              "colorTwo": "<string>"
            },
            "textColor": {
              "gradientDirection": "<string>",
              "colorOne": "<string>",
              "colorTwo": "<string>"
            }
          }
        }
      }
    ],
    "salePercentage": 123,
    "salePercentageDisplayType": "<string>"
  },
  "active": "true",
  "startOver": true,
  "showAfter": "<string>",
  "triggers": [
    {
      "type": "event",
      "eventName": "purchase",
      "every": 123,
      "rules": [
        {
          "fieldName": "publisherOfferId",
          "operator": "in",
          "value": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "segments": "NewUser",
  "productsSequence": [
    {
      "index": 1,
      "playerAvailability": 2,
      "priceInUsdCents": 300,
      "products": [
        {
          "quantity": 500,
          "publisherProductId": "product1"
        }
      ]
    }
  ]
}'
{
  "offerId": "655dc8a546822b3e7586b7b7",
  "publisherOfferId": "offer1",
  "name": "Test_popup",
  "displayName": "<string>",
  "description": "N/A",
  "type": "Popup",
  "createdBy": "API",
  "offerUi": {
    "offerUiId": "6548afb2ed7ec741ac8dee3a",
    "externalId": "<string>",
    "active": "true",
    "offerUiType": "Popup",
    "name": "test_offerUi",
    "description": "Best Offer UI",
    "backgroundImage": "https://media.appcharge.com/defaults/background.png",
    "specialOffer": {
      "templateType": "Single",
      "presentOfferEndTimer": "false",
      "title": "",
      "fontSize": 18,
      "fontWeight": "normal",
      "fontColor": {
        "colorOne": "black",
        "colorTwo": "black",
        "direction": "to right"
      },
      "backgroundColor": {
        "colorOne": "black",
        "colorTwo": "black",
        "direction": "to right"
      }
    }
  },
  "dynamicOfferUi": {
    "badges": [
      {
        "publisherBadgeId": "badge1",
        "badge": {
          "badgeId": "6548afb2ed7ec741ac8deeff",
          "publisherBadgeId": "badge1",
          "position": "right",
          "name": "test_badge",
          "type": "emblem",
          "emblem": {
            "imageUrl": "<string>"
          },
          "ribbon": {
            "text": "<string>",
            "backgroundColor": {
              "gradientDirection": "<string>",
              "colorOne": "<string>",
              "colorTwo": "<string>"
            },
            "textColor": {
              "gradientDirection": "<string>",
              "colorOne": "<string>",
              "colorTwo": "<string>"
            }
          }
        }
      }
    ],
    "salePercentage": 123,
    "salePercentageDisplayType": "<string>"
  },
  "active": "true",
  "coolDownInHours": "1",
  "segments": "[NewUser]",
  "productsSequence": [
    {
      "index": 1,
      "playerAvailability": 2,
      "priceInUsdCents": 300,
      "products": [
        {
          "quantity": 500,
          "product": {
            "publisherProductId": "product1",
            "name": "test_product",
            "textFontColorHex": "#FFFF",
            "type": "Time",
            "prefix": "100",
            "suffix": "500",
            "priority": "Main",
            "images": [
              {
                "type": "<string>",
                "url": "<string>"
              }
            ],
            "createdAt": "2023-07-05T12:01:06.113Z",
            "updatedAt": "2023-07-05T12:01:06.113Z",
            "productId": "655dc8a546822b3e7586b7b7"
          }
        }
      ]
    }
  ],
  "startOver": true,
  "priority": 123,
  "showAfter": "<string>",
  "triggers": [
    {
      "type": "<string>",
      "eventName": "<string>",
      "every": 123,
      "rules": [
        "<any>"
      ]
    }
  ],
  "createdAt": "2023-07-05T12:01:06.113Z",
  "updatedAt": "2023-07-05T12:01:06.113Z"
}

Headers

x-publisher-token
string
required

The publisher token

Path Parameters

offerSKU
string
required

The publisher Id of the offer.

Body

application/json

Response

200
application/json

Update Offer by Id

The response is of type object.