Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {{ACCESS_TOKEN}}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can create your own app to gain API access under Global settings / Developer apps.

• campaigns.list
• campaigns.view
• campaigns.pause
• campaigns.resume
• campaigns.integrations.list
• campaigns.game-data-statistics
• campaigns.sections.list
• campaigns.sections.view
• campaigns.sections.form-fields.list
• campaigns.sections.form-fields.view
• campaigns.prizes.list
• campaigns.prizes.view
• campaigns.bulk-prizes.list
• campaigns.bulk-prizes.view
• campaigns.bulk-prizes-items.send-email
• campaigns.email-log.list
• campaigns.email-log.view
• campaigns.sms-log.list
• campaigns.sms-log.view
• campaigns.registrations.list
• campaigns.registrations.view
• campaigns.registrations.delete
• campaigns.voucher.list
• campaigns.voucher.view
• campaigns.voucher.delete
• campaigns.types.list
• campaigns.types.view
• campaigns.copy
• campaigns.clear-cache
• media.upload
• user.create-login-token

Issue Token

This API issues a new access token. List over available scopes can be seen under the authentication introduction. Access tokens have a life-span of 1 hour. Once expired you will have to generate a new access token. We expect implementations to re-use access tokens generated for as long as they're active.

Applications found to be generating new access tokens when existing ones haven't expired may be subject to rate limiting. Scope can be declared singular as string or multiple as array within a single request.

{
  "grant_type": "client_credentials",
  "client_id": "your-client-id",
  "client_secret": "your-client-secret",
  "scope": [
    "campaigns.list",
    "campaigns.view",
    "campaigns.pause",
    "campaigns.resume",
    "campaigns.integrations.list",
    "campaigns.game-data-statistics",
    "campaigns.sections.list",
    "campaigns.sections.view",
    "campaigns.sections.form-fields.list",
    "campaigns.sections.form-fields.view",
    "campaigns.prizes.list",
    "campaigns.prizes.view",
    "campaigns.bulk-prizes.list",
    "campaigns.bulk-prizes.view",
    "campaigns.bulk-prizes-items.send-email",
    "campaigns.email-log.list",
    "campaigns.email-log.view",
    "campaigns.sms-log.list",
    "campaigns.sms-log.view",
    "campaigns.registrations.list",
    "campaigns.registrations.view",
    "campaigns.registrations.delete",
    "campaigns.voucher.list",
    "campaigns.voucher.view",
    "campaigns.voucher.delete",
    "campaigns.types.list",
    "campaigns.types.view",
    "campaigns.copy",
    "campaigns.clear-cache",
    "media.upload",
    "user.create-login-token"
  ]
}

{
  "token_type": "token_type",
  "access_token": "token"
}