Promoting Shouts

Wiki ▸ API Reference ▸ Shoutit Credit ▸ Promoting Shouts

Intro

Shouts can be promoted to drag more attention while on search results. A shout can have a single Promotion Label for specific time. This label determines how the shout should look among other shouts. Promotion Labels are applied according to Promotion Options that can be purchased using Shoutit Credit.

Promotion Labels

Set of attributes that are added to promoted shouts.

Promotion Label

{
    "name": "PREMIUM",
    "description": "Your shout will be highlighted in all searches.",
    "color": "#FFFFD700",
    "bg_color": "#26FFD700"
}

• Listing Promotion Labels

Promotion Options

Properties of the purchased Promotion Label.

Promotion Option

{
    "id": "7395484f-c816-43a4-a290-f6af916706a9",
    "name": "TOP RESULTS",
    "description": "Your shout will appear on top of search results.",
    "label": {
        "name": "TOP",
        "description": "Your shout will appear on top of search results.",
        "color": "#FFC0C0C0",
        "bg_color": "#26C0C0C0"
    },
    "credits": 3,
    "days": 3
}

• Listing Promotion Options

Promoting Shouts

Shouts can be promoted once. promotion property determines whether the shout is currently promoted. It contains the Promotion Option if the shout is promoted or null if it isn't.

Shout Promotion

{
    "id": "06d3d8b5-57d8-445a-b1c9-a3374397fa00",
    "label": {
        "name": "TOP PREMIUM",
        "description": "Your shout will be highlighted and appear on top of all searches.",
        "color": "#FFFFD700",
        "bg_color": "#26FFD700"
    },
    "days": 5,
    "expires_at": 1466001251
}

• Promoting a shout