Skip to main content

Messages 1.1 API

Updated over 2 weeks ago

The Messages 1.1 API is our updated messages endpoint for delivering personalized push-style notifications when players complete a goal and earn a reward. These messages celebrate milestones and help drive engagement by:

  • Congratulating the player

  • Highlighting the reward earned

  • Linking back to the game app


Preparing to connect

Follow these steps to prepare to connect to Besitos APIs:

  1. Have your partner ID ready.

  2. Contact your Besitos Account Manager to request API access.

  3. Generate and save your bearer token for authentication.

Continue reading for a complete description of the API parameters and response attributes, or visit our Postman collection to start testing.


Endpoint

Endpoint URL

https://wall.besitos.ai/data/messages/{partner_id}

HTTP method

POST

Path parameter

Path parameter

Data type

Required

Description

partner_id

string

yes

Your Besitos partner ID.

Supported filters

To filter the response, you can include optional POST parameters in the request body. At a minimum, you must include the type parameter.

Parameter

Data type

Required

Description and example

type

string

yes

Message type

"earned_reward"

from_date

date

no

The start of the date range for filtering messages.
​"2025-07-01"

to_date

date

no

The end of the date range for filtering messages.
​"2025-09-11"

user_ids

array

no

The user IDs for which you want to retrieve messages.
​["tWAek9twniogX0e"]

offer_ids

array

no

The offer IDs for which you want to retrieve messages.
​["Q6BblkQBTzBy", "tU5z8PU5BIR9"]

message_template

string

no

The custom message format with dynamic variables. Include this to retrieve specific messages. For example: "Congrats, you cleared {level_description} in {game} and won {reward}!"

Examples

Request

{
"type": "earned_reward",
"from_date": "2025-07-01",
"to_date": "2025-09-11",
"user_ids": ["tWAek9twniogX0e"],
"offer_ids": ["Q6BblkQBTzBy", "tU5z8PU5BIR9"],
"message_template": "Congrats, you cleared {level_description} in {game} and won {reward}!"
}

Response

{
"messages": [
{
"date_time": "2025-08-12 02:40:46",
"user_id": "656565656",
"game": "Bingo Blitz - iOS",
"level_description": "TURBO EARNINGS: Finished Miami and made at least $10 in-app purchase",
"currency": "$",
"reward": "$ 87.50",
"image": "https://cdn.kashkick.com/offers/DCqsqY9PTwQX.jpg",
"square_image": "https://cdn.kashkick.com/offers/yq1666289580.png",
"large_image": "https://cdn.kashkick.com/offers/AZckEGjlFKIr.jpg",
"url": "https://wall.besitos.ai/redirect/pb1666289580/b-97lteghmjcadbpaz6i",
"message": "Congrats, you cleared TURBO EARNINGS: Finished Miami and made at least $10 in-app purchase in Bingo Blitz - iOS and won $ 87.50!"
}
],
"links": {
"prev": null,
"next": null
}
}

Response attributes

Attributes

Type

Description

Example

date_time

string

The message timestamp.

"2025-09-04 01:18:04"

user_id

string

The unique identifier of the user.

"tWAek9twniogX0e"

game

string

The name of the game.

"Found It!"

level_description

string

A description of the goal in the offer.

"River City Reached"

currency

string

Your currency symbol, if specified; otherwise, the currency symbol will be "$".

"$"

reward

string

The reward amount with the currency symbol.

"$ 4.80"

image

string

Primary image URL

"https://origin-production.kashkick.com/offers/VEsNEAN94HJR.jpg"

square_image

string

Square-format image URL

"https://origin-production.kashkick.com/offers/2y8X1Nbev4DJ.png"

large_image

string

Large-format image URL

"https://origin-production.kashkick.com/offers/tY8Eob7oCHZG.jpg"

url

string

This link checks whether the user has the app installed on their device.

If it's installed, the user is directed to the app; if not, they are directed to the app on the Google Play Store or the Apple App Store.

"https://besitos.loc/redirect/Q6BblkQBTzBy/b-nRUtXStszDXiqmxje3"

message

string

The message for the achieved goal and earned reward.

"Congrats, you cleared River City Reached in Found It! and won $ 4.80!"

prev

string or null

URL to previous page

--

next

string or null

URL to next page

--

Did this answer your question?