Skip to main content

Link

POST 
/users/v1/link

Link a follower platform user to a leader person.

The Leader person is found using the following priority:

  1. If the leader_person_id is provided directly
  2. If the leader_platform and leader_platform_user_id are provided, the person_id of that platform user is used.
  3. If the scheme and credentials are provided, the person_id of the platform user of credentials is used.

The Follower platform user is found using the following priority:

  1. If the follower_platform and follower_platform_user_id are provided directly.
  2. If the Authorization header contains a user token, the platform and platform user id from the token are used.

For leader selection 1,2 or follower selection 1, Required Permissions:

  • For any user (including themselves) any of: user:*, user:modify:any

NOTE: Whenever you change the link or cross progression status of a user, it is recommended to refresh their access token. Each token does container user information, which may be incorrect after a link or cross progression change. There is no guarantee that calling other endpoints will operate on the correct user until the token has been refreshed.

Request​

Body

    leader_person_id uuid

    Person ID of the leader to link to. If not provided, the person will be found from the leader_platform and leader_platform_user_id

    leader_platform Platform (string)

    Possible values: [Anon, Basic, XboxLive, PSN, NintendoNAID, NintendoSwitch, NintendoPPID, Google, GooglePlay, Apple, Epic, Steam, Amazon, Twitch, RallyHere, LegacyName]

    Platform of the leader to link to. If not provided, the leader will be found from the scheme and credentials

    leader_platform_user_id Leader Platform User Id (string)

    Possible values: <= 2048 characters

    Platform user ID of the leader to link to. If not provided, the leader will be found from the scheme and credentials

    follower_platform Platform (string)

    Possible values: [Anon, Basic, XboxLive, PSN, NintendoNAID, NintendoSwitch, NintendoPPID, Google, GooglePlay, Apple, Epic, Steam, Amazon, Twitch, RallyHere, LegacyName]

    Platform of the follower to link. If not provided, the follower will be found from the Authorization header's token

    follower_platform_user_id Follower Platform User Id (string)

    Possible values: <= 2048 characters

    Platform user ID of the follower to link. If not provided, the follower will be found from the Authorization header's token

    scheme Scheme (string)

    Scheme to use for the leader. For most tokens, this will be Bearer

    credentials Credentials (string)

    Credentials to use for the leader. For most tokens, this will be the token itself.

Responses​

Successful Response

Loading...