PFGroupsAddMembersRequest

PFGroupsAddMembersRequest data model. Adds members to a group or role. Existing members of the group will added to roles within the group, but if the user is not already a member of the group, only title claimants may add them to the group, and others must use the group application or invite system to add new members to a group. Returns nothing if successful.

Syntax

typedef struct PFGroupsAddMembersRequest {  
    PFStringDictionaryEntry const* customTags;  
    uint32_t customTagsCount;  
    PFEntityKey const* group;  
    PFEntityKey const* members;  
    uint32_t membersCount;  
    const char* roleId;  
} PFGroupsAddMembersRequest;  

Members

customTags PFStringDictionaryEntry const*
may be nullptr (Optional) The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). customTagsCount uint32_t Count of customTags group PFEntityKey const* The identifier of the group. members PFEntityKey const* List of entities to add to the group. Only entities of type title_player_account and character may be added to groups. membersCount uint32_t Count of members roleId const char*
is null-terminated (Optional) Optional: The ID of the existing role to add the entities to. If this is not specified, the default member role for the group will be used. Role IDs must be between 1 and 64 characters long.

Requirements

Header: PFGroupsTypes.h

PlayFab API

PlayFab REST API References

Supplemental pages

Syntax

Members

Requirements

See also

​Syntax

​Members

​Requirements

​See also

Syntax

Members

Requirements

See also