Skip to main content
Creates a new group role.

Syntax

Parameters

entityHandle   PFEntityHandle PFEntityHandle to use for authentication. request   PFGroupsCreateGroupRoleRequest* Populated request object. async   XAsyncBlock*
Inout
XAsyncBlock for the async operation.

Return value

Type: HRESULT Result code for this API operation.

Remarks

This API is available on all platforms. Creates a new role within an existing group, with no members. Both the role ID and role name must be unique within the group, but the name can be the same as the ID. The role ID is set at creation and cannot be changed. Returns information about the role that was created. See also GroupDeleteRoleAsync. When the asynchronous task is complete, call PFGroupsCreateRoleGetResultSize and PFGroupsCreateRoleGetResult to get the result.

Requirements

Header: PFGroups.h

See also

PFGroups members
Last modified on August 1, 2026