Create free spins campaign

POST /free-spins-campaign/create
application/json

Body

  • betCount integer(int32) Required

    Minimum value is 1.

  • betValue number Required

    The bet value the campaign freespins are offered to the player

  • brandId string Required
  • campaignId string Required
  • campaignName string Required
  • consumeBefore integer(int32) Required

    Epoch time in milliseconds. Must be in the future. Consume before is considered to be hard end date, after which the campaign should be expired.

  • currency string Required
  • gameIds array[string]

    Can be limited to single game

  • handoverAfter integer(int32) Required

    Epoch time in milliseconds. Start date.

  • handoverBefore integer(int32) Required

    Epoch time in milliseconds. Must be in the future. Handover before is considered to be soft end date, after which the campaign should be expired if the player has not already started playing freespins.

  • playerId string Required

Responses

  • 200 application/json

    Successful response

    Hide response attribute Show response attribute object
    • providerCampaignId string Required

      Campaign identifier on the provider side. Used to cancel the campaign.
  • 400 application/json

    Request could not be processed

    Hide response attributes Show response attributes object
    • code string

      Values are ERROR_UNKNOWN_ERROR, ERROR_BAD_REQUEST, ERROR_BAD_REQUEST_PLAYER_BLOCKED, ERROR_INVALID_SESSION, ERROR_SESSION_EXPIRED, ERROR_TRANSACTION_DUPLICATE, ERROR_TRANSACTION_WITHDRAW_NOT_FOUND, ERROR_TRANSACTION_INSUFFICIENT_FUNDS, ERROR_TRANSACTION_LIMIT_EXCEEDED, ERROR_TRANSACTION_REALITY_CHECK, or ERROR_ROLLBACK_TRANSACTION_NOT_FOUND.

    • message string
  • 401 application/json

    Request public key or signature is missing or invalid

    Hide response attributes Show response attributes object
  • 500 application/json

    Internal error / Unknown error

    Hide response attributes Show response attributes object
    • code string

      Values are ERROR_UNKNOWN_ERROR or ERROR_TIMEOUT.

    • message string
POST /free-spins-campaign/create 
curl \
 --request POST 'BASE_URL/free-spins-campaign/create' \
 --header "Content-Type: application/json" \
 --header "Signature: string" \
 --header "Public-Key: string" \
 --data '{"betCount":42,"betValue":42.0,"brandId":"string","campaignId":"string","campaignName":"string","consumeBefore":42,"currency":"string","gameIds":["string"],"handoverAfter":42,"handoverBefore":42,"playerId":"string"}'
Request examples 
# Headers
Signature: string
Public-Key: string

# Payload
{
  "betCount": 42,
  "betValue": 42.0,
  "brandId": "string",
  "campaignId": "string",
  "campaignName": "string",
  "consumeBefore": 42,
  "currency": "string",
  "gameIds": [
    "string"
  ],
  "handoverAfter": 42,
  "handoverBefore": 42,
  "playerId": "string"
}
Response examples (200) 
{
  "providerCampaignId": "string"
}
Response examples (400) 
{
  "code": "ERROR_UNKNOWN_ERROR",
  "message": "string"
}
Response examples (401) 
{
  "code": "ERROR_INVALID_SIGNATURE",
  "message": "string"
}
Response examples (500) 
{
  "code": "ERROR_UNKNOWN_ERROR",
  "message": "string"
}