API Endpoints

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

channelstring · enumRequiredExample: SMSPossible values:

playerIdstringRequiredExample: ca91d88c-21c1-48da-95ac-8b57fdc62869

languagestringRequiredExample: en

timezonestringRequiredExample: -2800

countrystringRequiredExample: HN

Responses

201

Successful Operation

application/json

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

422

An error occurred while processing the information

application/json

500

Internal server error

application/json

post

/communications/notification-channels/device-registration

HTTPcURLJavaScriptPython

POST /communications/notification-channels/device-registration HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "channel": "SMS",
  "playerId": "ca91d88c-21c1-48da-95ac-8b57fdc62869",
  "language": "en",
  "timezone": "-2800",
  "country": "HN"
}

{
  "statusCode": 201
}

get

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Operation

application/json

ResponseanyExample: {"statusCode":200,"data":{"notificationChannels":[{"channelType":"PUSH","isActive":true,"text":"Push Notification"}]}}

401

Failed because the authentication token is not sent or it has already expired.

application/json

500

Internal server error

application/json

get

/communications/notification-channels

HTTPcURLJavaScriptPython

GET /communications/notification-channels HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 200,
  "data": {
    "notificationChannels": [
      {
        "channelType": "PUSH",
        "isActive": true,
        "text": "Push Notification"
      }
    ]
  }
}

post

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

channelTypestring · enumRequiredExample: SMSPossible values:

gameVersionstringRequiredExample: 1.0.1

Responses

201

Successful Operation

application/json

400

This error can occur because of an invalid value or because a value is required.

application/json

401

Failed because the authentication token is not sent or it has already expired.

application/json

422

An error occurred while processing the information

application/json

500

Internal server error

application/json

post

/communications/notification-channels

HTTPcURLJavaScriptPython

POST /communications/notification-channels HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "channelType": "SMS",
  "gameVersion": "1.0.1"
}

{
  "statusCode": 201
}

put

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

channelstring · enumRequiredPossible values:

Body

application/json

identifierstringOptionalExample: [email protected]

languagestringOptionalExample: es

timezonestringOptionalExample: -2800

gameVersionstringOptionalExample: 1.0.1

tagsobjectOptional

countrystringOptionalExample: HN

Responses

200

Successful Operation

application/json

ResponseanyExample: {"statusCode":200}

401

Failed because the authentication token is not sent or it has already expired.

application/json

500

Internal server error

application/json

put

/communications/notification-channels/{channel}

HTTPcURLJavaScriptPython

PUT /communications/notification-channels/{channel} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "identifier": "[email protected]",
  "language": "es",
  "timezone": "-2800",
  "gameVersion": "1.0.1",
  "tags": {},
  "country": "HN"
}

{
  "statusCode": 200
}

delete

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

channelstring · enumRequiredPossible values:

Responses

200

Successful Operation

application/json

ResponseanyExample: {"statusCode":200}

401

Failed because the authentication token is not sent or it has already expired.

application/json

422

An error occurred while processing the information

application/json

500

Internal server error

application/json

delete

/communications/notification-channels/{channel}

HTTPcURLJavaScriptPython

DELETE /communications/notification-channels/{channel} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": 200
}