NEOLearn

PartyService

Parties: friends who join games together, with party chat.

Updated October 21, 2026

On this page

Parties: 2-8 friends who move between games together. The leader's SessionService.Join takes the whole party: it finds a session with room for everyone (the fullest that fits, a friend's session the leader joins, or a new one), holds seats for the others, and tells each member over realtime {"type":"party_follow","partyId","experienceId","sessionId","title"}; their client joins that session. Party chat is the realtime channel party:<pty_...>. Realtime events: {"type":"party","party":{...Party JSON}} to every member on any change; {"type":"party_invite","invite":{...PartyInvite JSON}} to the invitee; {"type":"party_left","partyId"} to someone no longer in it (left, kicked, disbanded). Every method is a POST with a JSON body; see the overview for the protocol, authentication and errors.

Summary#

MethodAuthDescription
GetMyPartyAccountThe caller's party (an empty Party when they're in none) and their pending invites.
CreatePartyAccountStarts a party led by the caller (who must not be in one).
InviteToPartyAccountInvites a friend (any member may invite; up to 8 in the party).
AcceptPartyInviteAccount
DeclinePartyInviteAccount
LeavePartyAccountLeaves the caller's party. A leader who leaves hands it to the longest-standing member; the last one out ends it.
KickFromPartyNoneThe leader removes a member.
PromotePartyLeaderNoneThe leader hands leadership to another member.

Methods#

GetMyParty#

The caller's party (an empty Party when they're in none) and their pending invites.

HTTP
POST /neo.platform.v1.PartyService/GetMyParty
Content-Type: application/json

Auth: A signed-in account. Guests are refused.

Request: GetMyPartyRequest. Response: MyParty.

CreateParty#

Starts a party led by the caller (who must not be in one).

HTTP
POST /neo.platform.v1.PartyService/CreateParty
Content-Type: application/json

Auth: A signed-in account. Guests are refused.

Request: CreatePartyRequest. Response: Party.

InviteToParty#

Invites a friend (any member may invite; up to 8 in the party).

HTTP
POST /neo.platform.v1.PartyService/InviteToParty
Content-Type: application/json

Auth: A signed-in account. Guests are refused.

Request: InviteToPartyRequest. Response: Party.

AcceptPartyInvite#

HTTP
POST /neo.platform.v1.PartyService/AcceptPartyInvite
Content-Type: application/json

Auth: A signed-in account. Guests are refused.

Request: PartyRef. Response: Party.

DeclinePartyInvite#

HTTP
POST /neo.platform.v1.PartyService/DeclinePartyInvite
Content-Type: application/json

Auth: A signed-in account. Guests are refused.

Request: PartyRef. Response: MyParty.

LeaveParty#

Leaves the caller's party. A leader who leaves hands it to the longest-standing member; the last one out ends it.

HTTP
POST /neo.platform.v1.PartyService/LeaveParty
Content-Type: application/json

Auth: A signed-in account. Guests are refused.

Request: LeavePartyRequest. Response: MyParty.

KickFromParty#

The leader removes a member.

HTTP
POST /neo.platform.v1.PartyService/KickFromParty
Content-Type: application/json

Auth: None.

Request: PartyMemberRef. Response: Party.

PromotePartyLeader#

The leader hands leadership to another member.

HTTP
POST /neo.platform.v1.PartyService/PromotePartyLeader
Content-Type: application/json

Auth: None.

Request: PartyMemberRef. Response: Party.

Types#

CreatePartyRequest#

No fields: send {}.

GetMyPartyRequest#

No fields: send {}.

InviteToPartyRequest#

FieldTypeDescription
userIdstring

LeavePartyRequest#

No fields: send {}.

MyParty#

FieldTypeDescription
partyParty
invitesarray of PartyInvite

Party#

FieldTypeDescription
idstringpty_...; empty when the caller is in no party.
leaderUserSummary
membersarray of PartyMember
maxMembersnumber
experienceIdstringThe game and session the leader last took the party to.
experienceTitlestring
sessionIdstring
chatChannelstringThe party's chat channel on the realtime gateway (party:pty_...).
invitedarray of UserSummaryInvites sent and still pending.
createdAtstring

PartyInvite#

FieldTypeDescription
partyIdstring
fromUserSummary
leaderUserSummary
sizenumber
expiresAtstring

PartyMember#

FieldTypeDescription
userUserSummary
leaderboolean
presencestringonline, in_game, offline (as the member's friends see it)
experienceIdstring
joinedAtstring

PartyMemberRef#

FieldTypeDescription
userIdstring

PartyRef#

FieldTypeDescription
partyIdstring

See also#