Update player metadata

Overwrites the displayName stored against a group member you already have a playerId for. A missing member returns 404 with code: CodeNotInGroup. The request body replaces displayName outright rather than merging it in: sending a body without displayName (for example {}) clears any previously stored value instead of leaving it untouched. Only displayName is read from the body; other properties are not stored. This method authenticates with a secret (nexus_sk_...) key.

Authorizations

X-SHARED-SECRET

required

stringheader

Send your secret API key (nexus_sk_...) in the X-SHARED-SECRET header. Generate one in the Publisher Dashboard.

Parameters

Path Parameters

playerId

required

string

Example

player_8f2c41d0

Member player id. This is your internal unique identifier that was used to create this code or when linking to a Nexus.

Query Parameters

groupId

string

Example

V1StGXR8_Z5jdHi6B1LiO

Creator group to use for this operation. If your key is scoped to a single program, that group is always used regardless of this value; otherwise falls back to your default group when omitted.

Request Body

application/x-www-form-urlencoded

Additional player information to be applied to this member (such as their in game display name)

object

displayName

The players in game display name

string

Example

Popcorn Frog

Responses

200

Member object for given playerId

application/json

object

string

name

string

playerId

Your unique identifier for this user or player, provided when the code was created or when an existing nexus was linked to one of your user accounts

string

playerMetadata

Additional player information to be applied to this member (such as their in game display name)

object

displayName

The players in game display name

string

logoImage

string

profileImage

string

codes

Array<object>

A group member’s code which is used as their storefront URL and when creating transactions or referrals

object

code

string

isPrimary

Indicates whether or not this is the primary code for this member.

boolean

isGenerated

Indicates whether or not this is a code that you generated.

boolean

isManaged

Indicates whether or not this is a code that you manage. Once a code that you generated has been linked to a Nexus account, it will no longer be considered managed.

boolean

404

Not found

POST

/manage/members/player/{playerId}/metadata

const url = 'https://api.nexus.gg/v1/manage/members/player/player_8f2c41d0/metadata?groupId=V1StGXR8_Z5jdHi6B1LiO';
const options = {
  method: 'POST',
  headers: {
    'X-SHARED-SECRET': 'nexus_sk_your_key_here',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({displayName: 'Popcorn Frog'})
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url 'https://api.nexus.gg/v1/manage/members/player/player_8f2c41d0/metadata?groupId=V1StGXR8_Z5jdHi6B1LiO' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'X-SHARED-SECRET: nexus_sk_your_key_here' \
  --data 'displayName=Popcorn Frog'

Example

{
  "id": "CsRKC8uD0NLtyQ0LOt8Ru",
  "name": "samzorz",
  "playerId": "player_8f2c41d0",
  "playerMetadata": {
    "displayName": "Popcorn Frog"
  },
  "logoImage": "https://cdn.nexus.gg/CsRKC8uD0NLtyQ0LOt8Ru/images/logo-image.jpg",
  "profileImage": "https://cdn.nexus.gg/CsRKC8uD0NLtyQ0LOt8Ru/images/profile-image.jpg",
  "codes": [
    {
      "code": "samzorz",
      "isPrimary": true,
      "isGenerated": false,
      "isManaged": false
    }
  ]
}