API Endpoints

PreviousEnvironment Variables NextVGS

Last updated 2 years ago

Was this helpful?

post

/communications/notification-channels/device-registration

Authorizations

Body

playerIdstringrequired

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

languagestringrequired

Example: en

timezonestringrequired

Example: -2800

countrystringrequired

Example: HN

channelstring · enumrequired

Example: SMS

Options: PUSH, EMAIL, SMS

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 '{"playerId":"ca91d88c-21c1-48da-95ac-8b57fdc62869","language":"en","timezone":"-2800","country":"HN","channel":"SMS"}'

201

400

401

422

500

{
  "statusCode": 201
}

Successful Operation

get

/communications/notification-channels

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

/communications/notification-channels

Authorizations

Body

gameVersionstringrequired

Example: 1.0.1

channelTypestring · enumrequired

Example: SMS

Options: PUSH, EMAIL, SMS

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 '{"gameVersion":"1.0.1","channelType":"SMS"}'

201

400

401

422

500

{
  "statusCode": 201
}

Successful Operation

put

/communications/notification-channels/{channel}

Authorizations

Path parameters

channelstring · enumrequired

Options: PUSH, EMAIL, SMS

Body

identifierstring

Example: john.smith@example.com

languagestring

Example: es

timezonestring

Example: -2800

gameVersionstring

Example: 1.0.1

tagsobject

countrystring

Example: 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

delete

/communications/notification-channels/{channel}

Authorizations

Path parameters

channelstring · enumrequired

Options: PUSH, EMAIL, SMS

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