Skip to main content

Additional Payload Examples

This section complements the topic pages and shows HTTP request bodies for public operations. Use only documentId and variables; do not send the query field.

Account Security​

Send email binding code​

sendEmailBindCode​

documentId: sendEmailBindCode
{
  "documentId": "sendEmailBindCode",
  "variables": {
    "email": "[email protected]",
    "pin": "1234"
  }
}

Bind email​

bindEmail​

documentId: bindEmail
{
  "documentId": "bindEmail",
  "variables": {
    "email": "[email protected]",
    "code": "123456"
  }
}

Delete passkey​

deletePasskey​

documentId: deletePasskey
{
  "documentId": "deletePasskey",
  "variables": {
    "credentialId": "credential-id"
  }
}

Game Accounts​

Change game account password​

changeGameAccountPassword​

documentId: changeGameAccountPassword
{
  "documentId": "changeGameAccountPassword",
  "variables": {
    "accountLogin": "GameLogin",
    "currentPassword": "oldPassword123",
    "newPassword": "newPassword123",
    "pin": "1234"
  }
}

Reset game account password​

forgotGameAccountPassword​

documentId: forgotGameAccountPassword
{
  "documentId": "forgotGameAccountPassword",
  "variables": {
    "accountLogin": "GameLogin",
    "pin": "1234"
  }
}

Get game credentials​

getGameCredentials​

documentId: getGameCredentials
{
  "documentId": "getGameCredentials",
  "variables": {
    "accountLogin": "GameLogin",
    "pin": "1234"
  }
}

Characters and Warehouse​

Account characters​

characters​

documentId: characters
{
  "documentId": "characters",
  "variables": {
    "accountLogin": "GameLogin"
  }
}

Character inventory​

characterItems​

documentId: characterItems
{
  "documentId": "characterItems",
  "variables": {
    "accountLogin": "GameLogin",
    "charName": "Hero"
  }
}

Deliver warehouse item​

deliverWarehouseItem​

documentId: deliverWarehouseItem
{
  "documentId": "deliverWarehouseItem",
  "variables": {
    "itemId": 1001,
    "accountLogin": "GameLogin",
    "charName": "Hero"
  }
}

Server and Ratings​

Current online​

serversOnline​

documentId: serversOnline
{
  "documentId": "serversOnline",
  "variables": {
    "gameServerIds": [
      1,
      2
    ]
  }
}

searchRankingCharacters​

documentId: searchRankingCharacters
{
  "documentId": "searchRankingCharacters",
  "variables": {
    "gameServerId": 1,
    "name": "Aria",
    "matchMode": "CONTAINS",
    "first": 50
  }
}

Launcher​

Launcher event​

reportLauncherEvent​

documentId: reportLauncherEvent
{
  "documentId": "reportLauncherEvent",
  "variables": {
    "launcherKey": "launcher-key",
    "launcherId": "launcher-id",
    "event": "launcher_opened",
    "gameServerId": 1,
    "masterAccountId": 1,
    "hardwareId": "hardware-id",
    "launcherVersion": "1.0.0",
    "gameKey": "lineage2"
  }
}