API Endpoints

PreviousEnvironment Variables NextVGS

Last updated 2 years ago

Was this helpful?

delete

Authorizations

Path parameters

channelstring · enumrequiredAvailable options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/communications/notification-channels/{channel}' \
  --header 'Authorization: Bearer JWT'

200

401

422

500

{
  "statusCode": 200
}

Successful Operation

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/communications/notification-channels' \
  --header 'Authorization: Bearer JWT'

200

401

500

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

Successful Operation

post

Authorizations

Body

channelstring · enumrequiredExample: SMSAvailable options:

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

languagestringrequiredExample: en

timezonestringrequiredExample: -2800

countrystringrequiredExample: HN

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/communications/notification-channels/device-registration' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "channel": "SMS",
    "playerId": "ca91d88c-21c1-48da-95ac-8b57fdc62869",
    "language": "en",
    "timezone": "-2800",
    "country": "HN"
  }'

201

400

401

422

500

{
  "statusCode": 201
}

Successful Operation

post

Authorizations

Body

channelTypestring · enumrequiredExample: SMSAvailable options:

gameVersionstringrequiredExample: 1.0.1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/communications/notification-channels' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "channelType": "SMS",
    "gameVersion": "1.0.1"
  }'

201

400

401

422

500

{
  "statusCode": 201
}

Successful Operation

put

Authorizations

Path parameters

channelstring · enumrequiredAvailable options:

Body

identifierstringoptionalExample: john.smith@example.com

languagestringoptionalExample: es

timezonestringoptionalExample: -2800

gameVersionstringoptionalExample: 1.0.1

tagsobjectoptional

countrystringoptionalExample: HN

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/communications/notification-channels/{channel}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "identifier": "john.smith@example.com",
    "language": "es",
    "timezone": "-2800",
    "gameVersion": "1.0.1",
    "tags": {},
    "country": "HN"
  }'

200

401

500

{
  "statusCode": 200
}

Successful Operation