Token API


The following document defines the process for utilizing an API for apps to manage push tokens in the Engagement service.


Add Token

Before an app can receive push messages from the Engagement service, a push token must be registered.

 

Post Endpoint:

POST https://token.api.kochava.com/token/add”>http://token.api.kochava.com/token/add

 

Request:

Attributes Description Format
kochava_device_id The Kochava Device ID string
kochava_app_id The Kochava App GUID string
data The app data. object

token

The push token for the app install. string

locale

The device locale collected from the OS. It must be in BCP47, iOS, or Java 6 format. string

timezone

The device timezone collected from the OS. This is used by campaigns targeting device local time. It must be a tzid from https://www.iana.org/time-zones. string

usertime

Seconds since unix epoc. number

 

Body:

 

Response:

Attributes Description Format
success The request was successful. boolean
msg The error message, if any. string

 

Body:


Remove Token

Once a token is removed from the push service, the app will not receive messages from the Engagement service.

 

Post Endpoint:

POST https://token.api.kochava.com/token/remove

 

Request:

Attributes Description Format
kochava_device_id The Kochava Device ID string
kochava_app_id The Kochava App GUID string
data The app data. object

token

The push token for the app install. string

usertime

Seconds since unix epoc. number

 

Body:

 

Response:

Attributes Description Format
success The request was successful. boolean
msg The error message, if any. string

 

Body:

 
 

Last Modified: Aug 16, 2018 at 4:40 pm