Campaign Participation Token

This endpoint generates a participation token that links an Optimove customer to an Adact campaign.

Use it when you want to forward a known customer from an Optimove campaign into Adact gameplay. The token identifies the participant accurately on arrival and enables Adact to send real-time events back to Optimove based on the outcome of the gameplay.

The response returns a ready-made queryParam value that you append directly to your campaign URL. For example, if your campaign lives at my-brand.adact.me/campaign, the forwarding URL becomes:

my-brand.adact.me/campaign?customerIdToken={token}

Everything you place inside payload is embedded in the generated JWT.

expiresIn is expressed in seconds.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

By using this endpoint, you can forward known Optimove customers directly into Optimove Minigames gameplay without a manual sign-up step. The token identifies the participant on arrival, which is what allows Optimove Minigames to send gameplay outcomes back to Optimove as real-time events.

Handling Regions

Our API is hosted in two regions: US and EU. The Base URL is region-specific.

US: https://gamify-api-us.optimove.net/adact

EU: https://gamify-api-eu.optimove.net/adact

Please ensure you are using the correct Base URL for your account's region.

Rate Limit

For Optimove's general API rate limit, see the Understanding API Rate Limits reference.

Body Params
payload
object
required

The claims to embed in the generated JWT. Everything you place in this object is added to the token.

int32

Optional. The token lifetime in seconds. Restricts how long the participant can reuse the token in your Adact campaigns. If omitted, the generated token never expires.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json