Set Player Referrer

POST 
/friends/v2/player/:player_uuid/referrer

Set a player's referrer using either a player_uuid or referral code.

Required Permissions:

• For any player (including themselves) : refer:set:any

• For the player themselves : refer:set:self

Request

Path Parameters

player_uuid uuidrequired

The player_uuid to set the referrer for

application/json

Body

required

referrer_player_uuid uuid
referral_code Referral Code (string)

Responses

200

Successful Response

application/json

Schema

Schema

referree_player_uuid uuidrequired
referrer_player_uuid uuidrequired
created_datetime date-timerequired
last_modified_timestamp date-timerequired

Example (from schema)

{
  "referree_player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referrer_player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "created_datetime": "2024-07-29T15:51:28.071Z",
  "last_modified_timestamp": "2024-07-29T15:51:28.071Z"
}

400

Bad Request

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

403

Error Codes:

• auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token

• auth_invalid_version - Invalid Authorization - version

• auth_malformed_access - Invalid Authorization - malformed access token

• auth_not_jwt - Invalid Authorization

• auth_token_expired - Token is expired

• auth_token_format - Invalid Authorization - {}

• auth_token_invalid_claim - Token contained invalid claim value: {}

• auth_token_invalid_type - Invalid Authorization - Invalid Token Type

• auth_token_sig_invalid - Token Signature is invalid

• auth_token_unknown - Failed to parse token

• insufficient_permissions - Insufficient Permissions

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

404

Not Found

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...