API Endpoints
post
Authorizations
Body
channelstring · enumRequiredExample:
SMS
Possible values: playerIdstringRequiredExample:
ca91d88c-21c1-48da-95ac-8b57fdc62869
languagestringRequiredExample:
en
timezonestringRequiredExample:
-2800
countrystringRequiredExample:
HN
Responses
201
Successful Operation
application/json
ResponseanyExample:
{"statusCode":201}
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
POST /communications/notification-channels/device-registration HTTP/1.1
Host:
Authorization: Bearer JWT
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
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
GET /communications/notification-channels HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"notificationChannels": [
{
"channelType": "PUSH",
"isActive": true,
"text": "Push Notification"
}
]
}
}
post
Authorizations
Body
channelTypestring · enumRequiredExample:
SMS
Possible values: gameVersionstringRequiredExample:
1.0.1
Responses
201
Successful Operation
application/json
ResponseanyExample:
{"statusCode":201}
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
POST /communications/notification-channels HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"channelType": "SMS",
"gameVersion": "1.0.1"
}
{
"statusCode": 201
}
put
Authorizations
Path parameters
channelstring · enumRequiredPossible values:
Body
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
PUT /communications/notification-channels/{channel} HTTP/1.1
Host:
Authorization: Bearer JWT
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
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
DELETE /communications/notification-channels/{channel} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}
Last updated
Was this helpful?