Removing identifiers from an account
[CLIENT_ID]
: Unique identifier for the client application, provided by Playfull[GAME_ID]
: Unique identifier for the game sending the event, provided by Playfull[GENERATED_SIGNATURE]
: A signature that verifies the integrity of the request (see Signature Generation)[USER_ID]
: The game's own internal user identifier
POST /v2/custom-events
x-client-id: "[CLIENT_ID]",
x-timestamp: "1698306156387",
x-signature: "[GENERATED_SIGNATURE]",
Content-Type: "application/json"
{
"gameId": "[GAME_ID]",
"identifiers": [
{
"userId": "[USER_ID]",
"discordId": null,
"email": null,
"twitterId": null,
"walletAddress": null
},
]
}
To remove a user identifier, the value must explicitly be null. What this means is that if a previously set identifier is omitted from the request, it will not be removed. Here is an example flow:
- The following identifier payload will create a user record with the
email
identifier:
{ "userId": "[USER_ID]", "email": "john@doe.com" }
- A subsequent request is sent to add the
discordId
identifier to the already existing user, which will NOT remove the email:
{ "userId": "[USER_ID]", "discordId": "123456789" }
- A third request is sent to remove the
email
identifier from the existing user, leaving only the identifierdiscordId
in place.
{ "userId": "[USER_ID]", "email": null }
A full list of supported identifiers:
userId
(required): string - in-game user identifierdiscordId
: string - numeric Discord IDtwitterId
: string - numeric Twitter IDsteamId
: string - Steam IDemail
: string - User EmailepicGamesId
: string - Epic Games IDtelegramId
: string - Telegram IDwalletAddress
: string - a valid Ethereum addressplayfullUserId
: string - Playfull user identifier. Playfull will attach apfid
search params on redirect link optionally. Please contact our team for more details.