Game Join v1

Reference for the Game Join v1 endpoints on Roblox.

Base URL: https://gamejoin.roblox.com

Endpoints

Method	Path	Name
`POST`	`/v1/join-game`	`postJoinGame`
`POST`	`/v1/join-game-instance`	`postJoinGameInstance`
`POST`	`/v1/join-play-together-game`	`postJoinPlayTogetherGame`
`POST`	`/v1/join-private-game`	`postJoinPrivateGame`
`POST`	`/v1/join-reserved-game`	`postJoinReservedGame`
`GET`	`/v1/join-team-test`	`getJoinTeamTest`
`POST`	`/v1/play-with-user`	`postPlayWithUser`
`POST`	`/v1/team-create`	`postTeamCreate`
`POST`	`/v1/team-create-preemptive`	`postTeamCreatePreemptive`

`postJoinGame`

POST /v1/join-game

Endpoint to join a game

Usage

import { fetchApi } from 'rozod';
import { postJoinGame } from 'rozod/lib/endpoints/gamejoinv1';

const data = await fetchApi(postJoinGame, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`isoContext`	`string`
`gameIdToExclude`	`string`
`eventId`	`string`
`gameJoinAttemptId`	`string`
`placeId`	`number`
`gamerTag`	`string`
`isPlayTogetherGame`	`boolean`
`browserTrackerId`	`number`
`isTeleport`	`boolean`
`isQueueAllowedOverride`	`boolean`
`isImmersiveAdsTeleport`	`boolean`
`channelName`	`string`
`joinOrigin`	`string`
`partyId`	`string`

Response

Field	Type	Description
`jobId`	`string`
`status`	`number`
`statusData`	`object`	See below
`joinScriptUrl`	`string`
`authenticationUrl`	`string`
`authenticationTicket`	`string`
`message`	`string`
`joinScript`	`object`	See below
`queuePosition`	`number`

statusData fields:

Field	Type	Description
`creatorExperienceBan`	`object`	See below

creatorExperienceBan fields:

Field	Type	Description
`startTime`	`string`
`durationSeconds`	`number`
`displayReason`	`string`
`displayReasonTextFilterStatus`	`number`
`isInherited`	`boolean`

joinScript fields:

Field	Type	Description
`ClientPort`	`number`
`MachineAddress`	`string`
`ServerPort`	`number`
`ServerConnections`	`object[]`	See below
`UdmuxEndpoints`	`object[]`	See below
`DirectServerReturn`	`boolean`
`TokenGenAlgorithm`	`number`
`PepperId`	`number`
`TokenValue`	`string`
`PingUrl`	`string`
`PingInterval`	`number`
`UserName`	`string`
`DisplayName`	`string`
`HasVerifiedBadge`	`boolean`
`SeleniumTestMode`	`boolean`
`UserId`	`number`
`RobloxLocale`	`string`
`GameLocale`	`string`
`SuperSafeChat`	`boolean`
`FlexibleChatEnabled`	`boolean`
`CharacterAppearance`	`string`
`ClientTicket`	`string`
`GameId`	`string`
`PlaceId`	`number`
`BaseUrl`	`string`
`ChatStyle`	`string`
`CreatorId`	`number`
`CreatorTypeEnum`	`string`
`MembershipType`	`string`
`AccountAge`	`number`
`CookieStoreFirstTimePlayKey`	`string`
`CookieStoreFiveMinutePlayKey`	`string`
`CookieStoreEnabled`	`boolean`
`IsUnknownOrUnder13`	`boolean`
`GameChatType`	`string`
`WhoCanWhisperChatWithMeInExperiences`	`string`
`SessionId`	`string`
`AnalyticsSessionId`	`string`
`DataCenterId`	`number`
`UniverseId`	`number`
`FollowUserId`	`number`
`characterAppearanceId`	`number`
`CountryCode`	`string`
`AlternateName`	`string`
`RandomSeed1`	`string`
`ClientPublicKeyData`	`string`
`RccVersion`	`string`
`ChannelName`	`string`
`VerifiedAMP`	`number`
`PrivateServerOwnerID`	`number`
`PrivateServerID`	`string`
`EventId`	`string`
`EphemeralEarlyPubKey`	`string`
`PartyId`	`string`
`ShowRobloxTranslations`	`boolean`
`MatchmakingAttributes`	`string`
`TranslationDisplayMode`	`string`

ServerConnections[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

UdmuxEndpoints[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

Errors

Status	Description
400	-1: An unknown error occurred.
429	3: Too many requests, please slow down.

`postJoinGameInstance`

POST /v1/join-game-instance

Endpoint to join a particular game instance

Usage

import { fetchApi } from 'rozod';
import { postJoinGameInstance } from 'rozod/lib/endpoints/gamejoinv1';

const data = await fetchApi(postJoinGameInstance, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`gameId`	`string`
`cId`	`string`
`gameJoinAttemptId`	`string`
`placeId`	`number`
`gamerTag`	`string`
`isPlayTogetherGame`	`boolean`
`browserTrackerId`	`number`
`isTeleport`	`boolean`
`isQueueAllowedOverride`	`boolean`
`isImmersiveAdsTeleport`	`boolean`
`channelName`	`string`
`joinOrigin`	`string`
`partyId`	`string`

Response

Field	Type	Description
`jobId`	`string`
`status`	`number`
`statusData`	`object`	See below
`joinScriptUrl`	`string`
`authenticationUrl`	`string`
`authenticationTicket`	`string`
`message`	`string`
`joinScript`	`object`	See below
`queuePosition`	`number`

statusData fields:

Field	Type	Description
`creatorExperienceBan`	`object`	See below

creatorExperienceBan fields:

Field	Type	Description
`startTime`	`string`
`durationSeconds`	`number`
`displayReason`	`string`
`displayReasonTextFilterStatus`	`number`
`isInherited`	`boolean`

joinScript fields:

Field	Type	Description
`ClientPort`	`number`
`MachineAddress`	`string`
`ServerPort`	`number`
`ServerConnections`	`object[]`	See below
`UdmuxEndpoints`	`object[]`	See below
`DirectServerReturn`	`boolean`
`TokenGenAlgorithm`	`number`
`PepperId`	`number`
`TokenValue`	`string`
`PingUrl`	`string`
`PingInterval`	`number`
`UserName`	`string`
`DisplayName`	`string`
`HasVerifiedBadge`	`boolean`
`SeleniumTestMode`	`boolean`
`UserId`	`number`
`RobloxLocale`	`string`
`GameLocale`	`string`
`SuperSafeChat`	`boolean`
`FlexibleChatEnabled`	`boolean`
`CharacterAppearance`	`string`
`ClientTicket`	`string`
`GameId`	`string`
`PlaceId`	`number`
`BaseUrl`	`string`
`ChatStyle`	`string`
`CreatorId`	`number`
`CreatorTypeEnum`	`string`
`MembershipType`	`string`
`AccountAge`	`number`
`CookieStoreFirstTimePlayKey`	`string`
`CookieStoreFiveMinutePlayKey`	`string`
`CookieStoreEnabled`	`boolean`
`IsUnknownOrUnder13`	`boolean`
`GameChatType`	`string`
`WhoCanWhisperChatWithMeInExperiences`	`string`
`SessionId`	`string`
`AnalyticsSessionId`	`string`
`DataCenterId`	`number`
`UniverseId`	`number`
`FollowUserId`	`number`
`characterAppearanceId`	`number`
`CountryCode`	`string`
`AlternateName`	`string`
`RandomSeed1`	`string`
`ClientPublicKeyData`	`string`
`RccVersion`	`string`
`ChannelName`	`string`
`VerifiedAMP`	`number`
`PrivateServerOwnerID`	`number`
`PrivateServerID`	`string`
`EventId`	`string`
`EphemeralEarlyPubKey`	`string`
`PartyId`	`string`
`ShowRobloxTranslations`	`boolean`
`MatchmakingAttributes`	`string`
`TranslationDisplayMode`	`string`

ServerConnections[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

UdmuxEndpoints[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

Errors

Status	Description
400	-1: An unknown error occurred.
429	3: Too many requests, please slow down.

`postJoinPlayTogetherGame`

POST /v1/join-play-together-game

Endpoint to join play together game. DEPRECATED

Usage

import { fetchApi } from 'rozod';
import { postJoinPlayTogetherGame } from 'rozod/lib/endpoints/gamejoinv1';

const data = await fetchApi(postJoinPlayTogetherGame, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`conversationId`	`number`
`gameJoinAttemptId`	`string`
`placeId`	`number`
`gamerTag`	`string`
`isPlayTogetherGame`	`boolean`
`browserTrackerId`	`number`
`isTeleport`	`boolean`
`isQueueAllowedOverride`	`boolean`
`isImmersiveAdsTeleport`	`boolean`
`channelName`	`string`
`joinOrigin`	`string`
`partyId`	`string`

Response

Field	Type	Description
`jobId`	`string`
`status`	`number`
`statusData`	`object`	See below
`joinScriptUrl`	`string`
`authenticationUrl`	`string`
`authenticationTicket`	`string`
`message`	`string`
`joinScript`	`object`	See below
`queuePosition`	`number`

statusData fields:

Field	Type	Description
`creatorExperienceBan`	`object`	See below

creatorExperienceBan fields:

Field	Type	Description
`startTime`	`string`
`durationSeconds`	`number`
`displayReason`	`string`
`displayReasonTextFilterStatus`	`number`
`isInherited`	`boolean`

joinScript fields:

Field	Type	Description
`ClientPort`	`number`
`MachineAddress`	`string`
`ServerPort`	`number`
`ServerConnections`	`object[]`	See below
`UdmuxEndpoints`	`object[]`	See below
`DirectServerReturn`	`boolean`
`TokenGenAlgorithm`	`number`
`PepperId`	`number`
`TokenValue`	`string`
`PingUrl`	`string`
`PingInterval`	`number`
`UserName`	`string`
`DisplayName`	`string`
`HasVerifiedBadge`	`boolean`
`SeleniumTestMode`	`boolean`
`UserId`	`number`
`RobloxLocale`	`string`
`GameLocale`	`string`
`SuperSafeChat`	`boolean`
`FlexibleChatEnabled`	`boolean`
`CharacterAppearance`	`string`
`ClientTicket`	`string`
`GameId`	`string`
`PlaceId`	`number`
`BaseUrl`	`string`
`ChatStyle`	`string`
`CreatorId`	`number`
`CreatorTypeEnum`	`string`
`MembershipType`	`string`
`AccountAge`	`number`
`CookieStoreFirstTimePlayKey`	`string`
`CookieStoreFiveMinutePlayKey`	`string`
`CookieStoreEnabled`	`boolean`
`IsUnknownOrUnder13`	`boolean`
`GameChatType`	`string`
`WhoCanWhisperChatWithMeInExperiences`	`string`
`SessionId`	`string`
`AnalyticsSessionId`	`string`
`DataCenterId`	`number`
`UniverseId`	`number`
`FollowUserId`	`number`
`characterAppearanceId`	`number`
`CountryCode`	`string`
`AlternateName`	`string`
`RandomSeed1`	`string`
`ClientPublicKeyData`	`string`
`RccVersion`	`string`
`ChannelName`	`string`
`VerifiedAMP`	`number`
`PrivateServerOwnerID`	`number`
`PrivateServerID`	`string`
`EventId`	`string`
`EphemeralEarlyPubKey`	`string`
`PartyId`	`string`
`ShowRobloxTranslations`	`boolean`
`MatchmakingAttributes`	`string`
`TranslationDisplayMode`	`string`

ServerConnections[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

UdmuxEndpoints[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

Errors

Status	Description
400	-1: An unknown error occurred.
429	3: Too many requests, please slow down.

`postJoinPrivateGame`

POST /v1/join-private-game

Endpoint to join a private game

Usage

import { fetchApi } from 'rozod';
import { postJoinPrivateGame } from 'rozod/lib/endpoints/gamejoinv1';

const data = await fetchApi(postJoinPrivateGame, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`accessCode`	`string`
`linkCode`	`string`
`gameJoinAttemptId`	`string`
`placeId`	`number`
`gamerTag`	`string`
`isPlayTogetherGame`	`boolean`
`browserTrackerId`	`number`
`isTeleport`	`boolean`
`isQueueAllowedOverride`	`boolean`
`isImmersiveAdsTeleport`	`boolean`
`channelName`	`string`
`joinOrigin`	`string`
`partyId`	`string`

Response

Field	Type	Description
`jobId`	`string`
`status`	`number`
`statusData`	`object`	See below
`joinScriptUrl`	`string`
`authenticationUrl`	`string`
`authenticationTicket`	`string`
`message`	`string`
`joinScript`	`object`	See below
`queuePosition`	`number`

statusData fields:

Field	Type	Description
`creatorExperienceBan`	`object`	See below

creatorExperienceBan fields:

Field	Type	Description
`startTime`	`string`
`durationSeconds`	`number`
`displayReason`	`string`
`displayReasonTextFilterStatus`	`number`
`isInherited`	`boolean`

joinScript fields:

Field	Type	Description
`ClientPort`	`number`
`MachineAddress`	`string`
`ServerPort`	`number`
`ServerConnections`	`object[]`	See below
`UdmuxEndpoints`	`object[]`	See below
`DirectServerReturn`	`boolean`
`TokenGenAlgorithm`	`number`
`PepperId`	`number`
`TokenValue`	`string`
`PingUrl`	`string`
`PingInterval`	`number`
`UserName`	`string`
`DisplayName`	`string`
`HasVerifiedBadge`	`boolean`
`SeleniumTestMode`	`boolean`
`UserId`	`number`
`RobloxLocale`	`string`
`GameLocale`	`string`
`SuperSafeChat`	`boolean`
`FlexibleChatEnabled`	`boolean`
`CharacterAppearance`	`string`
`ClientTicket`	`string`
`GameId`	`string`
`PlaceId`	`number`
`BaseUrl`	`string`
`ChatStyle`	`string`
`CreatorId`	`number`
`CreatorTypeEnum`	`string`
`MembershipType`	`string`
`AccountAge`	`number`
`CookieStoreFirstTimePlayKey`	`string`
`CookieStoreFiveMinutePlayKey`	`string`
`CookieStoreEnabled`	`boolean`
`IsUnknownOrUnder13`	`boolean`
`GameChatType`	`string`
`WhoCanWhisperChatWithMeInExperiences`	`string`
`SessionId`	`string`
`AnalyticsSessionId`	`string`
`DataCenterId`	`number`
`UniverseId`	`number`
`FollowUserId`	`number`
`characterAppearanceId`	`number`
`CountryCode`	`string`
`AlternateName`	`string`
`RandomSeed1`	`string`
`ClientPublicKeyData`	`string`
`RccVersion`	`string`
`ChannelName`	`string`
`VerifiedAMP`	`number`
`PrivateServerOwnerID`	`number`
`PrivateServerID`	`string`
`EventId`	`string`
`EphemeralEarlyPubKey`	`string`
`PartyId`	`string`
`ShowRobloxTranslations`	`boolean`
`MatchmakingAttributes`	`string`
`TranslationDisplayMode`	`string`

ServerConnections[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

UdmuxEndpoints[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

Errors

Status	Description
400	-1: An unknown error occurred.
429	3: Too many requests, please slow down.

`postJoinReservedGame`

POST /v1/join-reserved-game

Endpoint to join a reserved game

Usage

import { fetchApi } from 'rozod';
import { postJoinReservedGame } from 'rozod/lib/endpoints/gamejoinv1';

const data = await fetchApi(postJoinReservedGame, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`accessCode`	`string`
`cId`	`string`
`gameJoinAttemptId`	`string`
`placeId`	`number`
`gamerTag`	`string`
`isPlayTogetherGame`	`boolean`
`browserTrackerId`	`number`
`isTeleport`	`boolean`
`isQueueAllowedOverride`	`boolean`
`isImmersiveAdsTeleport`	`boolean`
`channelName`	`string`
`joinOrigin`	`string`
`partyId`	`string`

Response

Field	Type	Description
`jobId`	`string`
`status`	`number`
`statusData`	`object`	See below
`joinScriptUrl`	`string`
`authenticationUrl`	`string`
`authenticationTicket`	`string`
`message`	`string`
`joinScript`	`object`	See below
`queuePosition`	`number`

statusData fields:

Field	Type	Description
`creatorExperienceBan`	`object`	See below

creatorExperienceBan fields:

Field	Type	Description
`startTime`	`string`
`durationSeconds`	`number`
`displayReason`	`string`
`displayReasonTextFilterStatus`	`number`
`isInherited`	`boolean`

joinScript fields:

Field	Type	Description
`ClientPort`	`number`
`MachineAddress`	`string`
`ServerPort`	`number`
`ServerConnections`	`object[]`	See below
`UdmuxEndpoints`	`object[]`	See below
`DirectServerReturn`	`boolean`
`TokenGenAlgorithm`	`number`
`PepperId`	`number`
`TokenValue`	`string`
`PingUrl`	`string`
`PingInterval`	`number`
`UserName`	`string`
`DisplayName`	`string`
`HasVerifiedBadge`	`boolean`
`SeleniumTestMode`	`boolean`
`UserId`	`number`
`RobloxLocale`	`string`
`GameLocale`	`string`
`SuperSafeChat`	`boolean`
`FlexibleChatEnabled`	`boolean`
`CharacterAppearance`	`string`
`ClientTicket`	`string`
`GameId`	`string`
`PlaceId`	`number`
`BaseUrl`	`string`
`ChatStyle`	`string`
`CreatorId`	`number`
`CreatorTypeEnum`	`string`
`MembershipType`	`string`
`AccountAge`	`number`
`CookieStoreFirstTimePlayKey`	`string`
`CookieStoreFiveMinutePlayKey`	`string`
`CookieStoreEnabled`	`boolean`
`IsUnknownOrUnder13`	`boolean`
`GameChatType`	`string`
`WhoCanWhisperChatWithMeInExperiences`	`string`
`SessionId`	`string`
`AnalyticsSessionId`	`string`
`DataCenterId`	`number`
`UniverseId`	`number`
`FollowUserId`	`number`
`characterAppearanceId`	`number`
`CountryCode`	`string`
`AlternateName`	`string`
`RandomSeed1`	`string`
`ClientPublicKeyData`	`string`
`RccVersion`	`string`
`ChannelName`	`string`
`VerifiedAMP`	`number`
`PrivateServerOwnerID`	`number`
`PrivateServerID`	`string`
`EventId`	`string`
`EphemeralEarlyPubKey`	`string`
`PartyId`	`string`
`ShowRobloxTranslations`	`boolean`
`MatchmakingAttributes`	`string`
`TranslationDisplayMode`	`string`

ServerConnections[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

UdmuxEndpoints[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

Errors

Status	Description
400	-1: An unknown error occurred.
429	3: Too many requests, please slow down.

`getJoinTeamTest`

GET /v1/join-team-test

Endpoint to join a team test.

Usage

import { fetchApi } from 'rozod';
import { getJoinTeamTest } from 'rozod/lib/endpoints/gamejoinv1';

const data = await fetchApi(getJoinTeamTest, {
  PlaceId: /* integer */,
  PlaceVersion: /* integer */
});

Parameters

Name	Type	Required	Description
`PlaceId`	`integer`	Yes	The Target Place Id for Team Test.
`PlaceVersion`	`integer`	Yes	The Target Place Version for Team Test.

Response

Type: unknown

`postPlayWithUser`

POST /v1/play-with-user

Endpoint to play with user

Usage

import { fetchApi } from 'rozod';
import { postPlayWithUser } from 'rozod/lib/endpoints/gamejoinv1';

const data = await fetchApi(postPlayWithUser, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`userIdToFollow`	`number`
`gameJoinAttemptId`	`string`
`placeId`	`number`
`gamerTag`	`string`
`isPlayTogetherGame`	`boolean`
`browserTrackerId`	`number`
`isTeleport`	`boolean`
`isQueueAllowedOverride`	`boolean`
`isImmersiveAdsTeleport`	`boolean`
`channelName`	`string`
`joinOrigin`	`string`
`partyId`	`string`

Response

Field	Type	Description
`jobId`	`string`
`status`	`number`
`statusData`	`object`	See below
`joinScriptUrl`	`string`
`authenticationUrl`	`string`
`authenticationTicket`	`string`
`message`	`string`
`joinScript`	`object`	See below
`queuePosition`	`number`

statusData fields:

Field	Type	Description
`creatorExperienceBan`	`object`	See below

creatorExperienceBan fields:

Field	Type	Description
`startTime`	`string`
`durationSeconds`	`number`
`displayReason`	`string`
`displayReasonTextFilterStatus`	`number`
`isInherited`	`boolean`

joinScript fields:

Field	Type	Description
`ClientPort`	`number`
`MachineAddress`	`string`
`ServerPort`	`number`
`ServerConnections`	`object[]`	See below
`UdmuxEndpoints`	`object[]`	See below
`DirectServerReturn`	`boolean`
`TokenGenAlgorithm`	`number`
`PepperId`	`number`
`TokenValue`	`string`
`PingUrl`	`string`
`PingInterval`	`number`
`UserName`	`string`
`DisplayName`	`string`
`HasVerifiedBadge`	`boolean`
`SeleniumTestMode`	`boolean`
`UserId`	`number`
`RobloxLocale`	`string`
`GameLocale`	`string`
`SuperSafeChat`	`boolean`
`FlexibleChatEnabled`	`boolean`
`CharacterAppearance`	`string`
`ClientTicket`	`string`
`GameId`	`string`
`PlaceId`	`number`
`BaseUrl`	`string`
`ChatStyle`	`string`
`CreatorId`	`number`
`CreatorTypeEnum`	`string`
`MembershipType`	`string`
`AccountAge`	`number`
`CookieStoreFirstTimePlayKey`	`string`
`CookieStoreFiveMinutePlayKey`	`string`
`CookieStoreEnabled`	`boolean`
`IsUnknownOrUnder13`	`boolean`
`GameChatType`	`string`
`WhoCanWhisperChatWithMeInExperiences`	`string`
`SessionId`	`string`
`AnalyticsSessionId`	`string`
`DataCenterId`	`number`
`UniverseId`	`number`
`FollowUserId`	`number`
`characterAppearanceId`	`number`
`CountryCode`	`string`
`AlternateName`	`string`
`RandomSeed1`	`string`
`ClientPublicKeyData`	`string`
`RccVersion`	`string`
`ChannelName`	`string`
`VerifiedAMP`	`number`
`PrivateServerOwnerID`	`number`
`PrivateServerID`	`string`
`EventId`	`string`
`EphemeralEarlyPubKey`	`string`
`PartyId`	`string`
`ShowRobloxTranslations`	`boolean`
`MatchmakingAttributes`	`string`
`TranslationDisplayMode`	`string`

ServerConnections[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

UdmuxEndpoints[] item fields:

Field	Type	Description
`Address`	`string`
`Port`	`number`

Errors

Status	Description
400	-1: An unknown error occurred.
429	3: Too many requests, please slow down.

`postTeamCreate`

POST /v1/team-create

Endpoint to join team create session

Usage

import { fetchApi } from 'rozod';
import { postTeamCreate } from 'rozod/lib/endpoints/gamejoinv1';

const data = await fetchApi(postTeamCreate, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`gameJoinAttemptId`	`string`
`placeId`	`number`
`gamerTag`	`string`
`isPlayTogetherGame`	`boolean`
`browserTrackerId`	`number`
`isTeleport`	`boolean`
`isQueueAllowedOverride`	`boolean`
`isImmersiveAdsTeleport`	`boolean`
`channelName`	`string`
`joinOrigin`	`string`
`partyId`	`string`

Response

Field	Type	Description
`status`	`number`
`message`	`string`
`settings`	`object`	See below

Errors

Status	Description
400	-1: An unknown error occurred.
403	1: Request is not authorized from specified origin. 2: User is invalid or does not exist.
429	3: Too many requests, please slow down.

`postTeamCreatePreemptive`

POST /v1/team-create-preemptive

Endpoint to preemptively start team create session.

Usage

import { fetchApi } from 'rozod';
import { postTeamCreatePreemptive } from 'rozod/lib/endpoints/gamejoinv1';

const data = await fetchApi(postTeamCreatePreemptive, {
  body: { /* ... */ }
});

Request Body

Field	Type	Description
`gameJoinAttemptId`	`string`
`placeId`	`number`
`gamerTag`	`string`
`isPlayTogetherGame`	`boolean`
`browserTrackerId`	`number`
`isTeleport`	`boolean`
`isQueueAllowedOverride`	`boolean`
`isImmersiveAdsTeleport`	`boolean`
`channelName`	`string`
`joinOrigin`	`string`
`partyId`	`string`

Response

Field	Type	Description
`status`	`number`
`message`	`string`
`settings`	`object`	See below

Errors

Status	Description
400	-1: An unknown error occurred.
403	0: Token Validation Failed 1: Request is not authorized from specified origin. 2: User is invalid or does not exist.
429	3: Too many requests, please slow down.