Documentation

ApplyToGroup

Applies to join a group

Request Details

Creates an application to join a group. Calling this while a group application already exists will return the same application instead of an error and will not refresh the time before the application expires. By default, if the entity has an invitation to join the group outstanding, this will accept the invitation to join the group instead and return an error indicating such, rather than creating a duplicate application to join that will need to be cleaned up later. Returns information about the application or an error indicating an invitation was accepted instead.

ApplyToGroupRequest
Request Properties
AutoAcceptOutstandingInvite Boolean

Optional, default true. Automatically accept an outstanding invitation if one exists instead of creating an application

Entity EntityKey

The entity to perform this action on.

Group (required) EntityKey

The identifier of the group

POST https://{{TitleID}}.playfabapi.com/Group/ApplyToGroup
    Content-Type: application/json
{
  "Group": {
    "Id": "ABC1234ABC"
  }
}
        

Response Details

ApplyToGroupResponse
Result Properties
Entity EntityWithLineage

Type of entity that requested membership

Expires (required) DateTime

When the application to join will expire and be deleted

Group EntityKey

ID of the group that the entity requesting membership to

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "Group": {
      "Id": "ABC1234ABC"
    },
    "Entity": {
      "Key": {
        "Id": "90901000",
        "Type": "title_player_account",
        "TypeString": "title_player_account"
      },
      "Lineage": {
        "master_player_account": {
          "Id": "800DED92",
          "Type": "master_player_account",
          "TypeString": "master_player_account"
        }
      }
    },
    "Expires": "2017-12-31T11:59:59Z"
  }
}

Authentication

EntityToken

Possible Error Codes

Name Code
EntityIsAlreadyMember 1359
InvalidParams 1000
NotAuthenticated 1074
NotAuthorized 1089
OutstandingInvitationAcceptedInstead 1363