Get details of a campaign

POST /free-spins-campaigns/get-details

Headers

Signature string Required
Public-Key string Required

application/json

Body Required

brandId string Required
campaignId string Required

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- betCount integer(int32)
- betValue number Required
  
  The bet value the campaign freespins are offered to the player
- campaignId string Required
  
  A campaign ID that was provided during creation
- campaignName string Required
  
  Non blank campaign name
  
  Format should match the following pattern: ^(?!\s*$).+.
- consumeBefore integer(int64)
  
  Unix 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
  
  Non blank currency
  
  Format should match the following pattern: ^(?!\s*$).+.
- gameId string Required
  
  Non blank game ID
  
  Format should match the following pattern: ^(?!\s*$).+.
- handoverAfter integer(int64)
  
  Unix epoch time in milliseconds. Start date of the campaign. Must be in the future.
- id string Required
  
  Unique ID for the created campaign
- playerIds array[string]
  
  Non blank player ID
  
  Minimum length of each is 1, maximum length of each is 45. Format of each should match the following pattern: ^(?!\s*$).+.
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, ERROR_TRANSACTION_NOT_FOUND, ERROR_ROLLBACK_TRANSACTION_NOT_FOUND, ERROR_GAME_NOT_ACTIVE, or ERROR_BRAND_NOT_ACTIVE.
- description string
  
  Message describing the error
- traceId string
  
  Internal ID to trace the request when debugging
401 application/json

Request public key or signature is missing or invalid
Hide response attributes Show response attributes object
- code string
  
  Value is ERROR_INVALID_SIGNATURE.
- description string
  
  Message describing the error
- traceId string
  
  Internal ID to trace the request when debugging
500 application/json

Internal error / Unknown error
Hide response attributes Show response attributes object
- code string
  
  Values are ERROR_UNKNOWN_ERROR or ERROR_TIMEOUT.
- description string
  
  Message describing the error
- traceId string
  
  Internal ID to trace the request when debugging

POST /free-spins-campaigns/get-details

curl \
 --request POST 'BASE_URL/free-spins-campaigns/get-details' \
 --header "Content-Type: application/json" \
 --header "Signature: string" \
 --header "Public-Key: string" \
 --data '{"brandId":"string","campaignId":"string"}'

Request examples

# Headers
Signature: string
Public-Key: string

# Payload
{
  "brandId": "string",
  "campaignId": "string"
}

Response examples (200)

{
  "betCount": 42,
  "betValue": 42.0,
  "campaignId": "string",
  "campaignName": "string",
  "consumeBefore": 641779201000,
  "currency": "string",
  "gameId": "string",
  "handoverAfter": 641779201000,
  "id": "string",
  "playerIds": [
    "string"
  ]
}

Response examples (400)

{
  "code": "ERROR_UNKNOWN_ERROR",
  "description": "string",
  "traceId": "string"
}

Response examples (401)

{
  "code": "ERROR_INVALID_SIGNATURE",
  "description": "string",
  "traceId": "string"
}

Response examples (500)

{
  "code": "ERROR_UNKNOWN_ERROR",
  "description": "string",
  "traceId": "string"
}