Skip to content
RallyHere Docs

Disable Cross Progression

POST
/users/v1/cross-progression/disable

Disable Cross Progression for a person. While cross progression is disabled, all linked users who login will receive a token for the player associated with their platform user.

The person is found using the following priority:

  1. If the person_id is provided directly
  2. If the platform and platform_user_id are provided, the person_id of that platform user is used.
  3. If the Authorization header contains a user token, the platform and platform user id from the token are used and the person associated with that user is used.

If you are modifying a user outside of your person, 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.

Authorizations

Request Body

object
person_id

Person ID

string format: uuid
platform

Platform ID

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch RallyHere LegacyName
platform_user_id

Platform User ID

string
<= 2048 characters

Responses

200

Successful Response

400

Request inputs are not valid

Error Codes:

  • account_not_found - User Account not found
  • cannot_modify_person - You have insufficient permissions to modify this person
  • invalid_token_claims - Token has missing/invalid claims. Are you using a non-user token on a user endpoint?
  • not_cross_progression_player - Player is not the cross progression player
object
auth_success
boolean
default: true
error_code
required
string
desc
required
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_sig_invalid - Token Signature is invalid
  • auth_token_unknown - Failed to parse token
  • insufficient_permissions - Insufficient Permissions
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string