partyInvite

Invite a player to your party.

They must accept in their own client — this only sends the invitation. Watch `party.members` for them to appear.

In Party.

Request

POST /api/v1/sessions/{accountKey}/actions/partyInvite

Parameters

NameTypeRequiredDescription
accountId (account_id)stringyesFrom `partyFind`.
characterId (character_id)stringnoTheir character id, from `partyFind`.
namestringnoTheir name, used only for the status banner.

Example request

{ "accountId": "acc-2", "characterId": "char-2", "name": "Alice" }

Response

`{ ok: true }`; watch `party` for them to join.

Example response

{ "ok": true }

Errors

CodeWhen
action_failedNo character is in the lobby, or `accountId` was empty.
plan_limitNot on the free plan.

See also

DarkerAPI is an independent project. It is not affiliated with, endorsed by or associated with IRONMACE Co., Ltd. or Valve Corporation. “Dark and Darker” and related marks belong to their respective owners.