API Objects

JSON objects used in Cardsmobile Push API requests

Documentation has moved

The information on this page is no longer updated and may be obsolete. The most current Koshelek documentation is now available at the new address:

https://developers.koshelek.app/en/

1. Payload Object

The object contains information on a transmitted message. The object consists of the following fields:

Field	Type	Mandatory	Description
title	String	Yes	Message title (max 50 characters).
message	String	Yes	Message body (max 150 characters).
image	String	No	URL of image attached to the message (size 1024×512 px, JPG or PNG format). Non-mandatory. If specified for transactional and service messages, it will be ignored.
deeplink	Object	Yes	Internal application link ("deep link") for transferring to a certain screen in the Koshelek app. Presented by JSON object DeepLink.

2. DeepLink Object

The object contains information on a deep link. Consists of the following fields:

Field	Type	Mandatory	Description
target	String	Yes	Determines the Koshelek app screen to open when a user taps on the message: card — to the screen of the issued card; campaign — to the screen of the certain promotional action related to the issued card; campaigns — to the screen with the full list of actions related to the issued card.
campaignId	String	No	ID of the promotional action to display. Mandatory, if target=campaign. ID of the promotional action from partner's CRM or from partner's Personal account in Koshelek for Business must be specified here.

3. QoS Object

The object contains information on settings of message delivery. Consists of the following fields:

Field	Type	Mandatory	Description
deliveryStatusNotifications	Boolean	No	Determines whether or not the sender will be notified about the message status change via the Callback API: true — notify; false — not to notify.

4. UTM Object

The object contains additional settings for the delivery. Consists of the following fields:

Field	Type	Mandatory	Description
utmSource	String	No	The source of the delivery.
utmMiddle	String	No	Traffic type.
utmCampaign	String	No	Campaign name.