POST /processes/:processId/invites

Description

Invite a player to join a process.

The player must have the role of admin on the lane to which they wish to invite other players.

It returns the invitation request.

Resource URL

https://api.playlyfe.com/processes/:processId/invites

Method

POST

Scopes

player, game, debug

Parameters

Example

Request

POST https://api.playlyfe.com/processes/neo/therealmatrix/invites
{
  "id": "trinity",
  "roles": {
    "~": "player"
  }
}

Response

{
  "id": "aef37730-a233-11e3-9af5-753d0e60669a",
  "event": "invite",
  "timestamp": "2014-03-02T17:54:21.347Z",
  "actor": {
    "id": "neo",
    "alias": "Neo"
  },
  "invitee": {
    "id": "trinity",
    "alias": "Trinity"
  },
  "process": {
    "id": "neo/therealmatrix",
    "name": "Protected"
  },
  "roles": {
    "~": "player"
  },
  "state": "PENDING"
}