Interface InngageInAppScratch

Scratch card in-app.

Example

{
  "type": "Scratch",
  "style": {
    "position": "center",
    "backgroundColor": "#553f3f",
    "backgroundImage": null,
    "borderColor": "#083287",
    "shadow": true,
    "titleColor": "#d04949",
    "bodyColor": "#d04949"
  },
  "expiration": { "date": "", "hours": "", "minutes": "" },
  "content": { "title": "Scratch card", "body": "Scratch to reveal your prize" },
  "result": {
    "winTitle": "You won!",
    "loseTitle": "Not this time",
    "body": "Keep shopping with us",
    "winEmoji": "🤫",
    "loseEmoji": "🤨",
    "style": { "gradient": true, "bgFrom": "#11385f", "bgTo": "#0da593", "textColor": "#957f0e" }
  },
  "scratch": {
    "coverColor": "#1d56b9",
    "instruction": "Scratch here",
    "revealPercent": 34,
    "maxRepetitions": 1,
    "prizes": [
      { "label": "15% off", "code": "CUMPOM15", "weight": 2, "stock": 9 }
    ]
  },
  "notId": "bafdc1c30bdd7f9f7f0855f1"
}
interface InngageInAppScratch {
    content: InngageInAppContent;
    expiration: InngageInAppExpiration;
    notId: string;
    result: InngageInAppResult;
    scratch: {
        coverColor: string;
        instruction: string;
        maxRepetitions: number;
        prizes: InngageInAppPrize[];
        revealPercent: number;
    };
    style: InngageInAppStyle;
    type: "Scratch";
}

Hierarchy (View Summary)

Properties

content expiration notId result scratch style type

Properties

content

content: InngageInAppContent

Title and body shown above the card.

expiration

expiration: InngageInAppExpiration

Expiration of the in-app.

notId

notId: string

Identifier of this delivery in Inngage.

result

result: InngageInAppResult

Screen shown once the card is revealed.

scratch

scratch: {
    coverColor: string;
    instruction: string;
    maxRepetitions: number;
    prizes: InngageInAppPrize[];
    revealPercent: number;
}

Type declaration

  • coverColor: string

    Color of the layer the user scratches.

  • instruction: string

    Hint text shown on the card.

  • maxRepetitions: number

    How many times the user may play.

  • prizes: InngageInAppPrize[]

    Prizes available in the draw.

  • revealPercent: number

    Percentage of the area that must be scratched before the result is revealed.

style

style: InngageInAppStyle

Style of the in-app container.

type

type: "Scratch"

Settings

Member Visibility

On This Page

Properties