Skip to main content

CreateParty​

Creates a new party.

Request Body required
  • party_size int32 required

    Possible values: 2 ≤ value ≤ 16

    How many members can join the party.

    If using this party with the matchmaker, this number should be less than or equal to your party player limit. Super large parties may not be able to fit insite a lobby and be unable to join the game.

  • publicity object

    Publicity configuration for creating a party.

    Null values will default

    • public string

      Possible values: [none, view, join]

    • mutual_followers string

      Possible values: [none, view, join]

    • groups string

      Possible values: [none, view, join]

  • invites object[]
    • alias string

      Possible values: 1 ≤ length ≤ 64

      An alias used to join a given party.

      This alias must be unique for all invites for your game.

      Pass this alias to rivet.api.party.common#CreatedInvite$alias to consume the invite.

  • matchmaker_current_player_token password

    If the player is currently in the lobby, pass the token from rivet.matchmaker#MatchmakerLobbyJoinInfoPlayer$token.

    This will prevent issuing a new player token and automatically set the party state to the player's current lobby.

Responses

CreateParty 200 response

Schema
  • party_id string required

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    A universally unique identifier.

  • invites object[] required
    • token password required

      A JSON Web Token.

      Slightly modified to include a description prefix and use Protobufs of JSON.