POST /cloud/v2/groups/{group_id}/memberships/{membership_id}:assignRole — cloud.docs

Assign Role Group Membership

Assigns a specific role to a user within a group. If the user already holds the specified role, no action is taken.

Endpoint

Method: POST

Path: /cloud/v2/groups/{group_id}/memberships/{membership_id}:assignRole

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
group_id	path	true	The group ID.
membership_id	path	true	The membership ID.

[
  {
    "name": "group_id",
    "in": "path",
    "description": "The group ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "membership_id",
    "in": "path",
    "description": "The membership ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AssignRoleGroupMembershipRequest"
      }
    }
  },
  "required": true
}

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/GroupMembership"
        }
      }
    }
  }
}

Authentication

{
  "security": [],
  "securitySchemes": {}
}

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Assign Role Group Membership",
  "description": "Assigns a specific role to a user within a group. If the user already\nholds the specified role, no action is taken.",
  "operationId": "Cloud_AssignRoleGroupMembership",
  "parameters": [
    {
      "name": "group_id",
      "in": "path",
      "description": "The group ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "membership_id",
      "in": "path",
      "description": "The membership ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/AssignRoleGroupMembershipRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/GroupMembership"
          }
        }
      }
    }
  },
  "x-visibility": "BETA",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": true
  },
  "x-roblox-scopes": [
    {
      "name": "group:write"
    }
  ],
  "x-roblox-docs": {
    "category": "Users and groups",
    "methodProperties": {
      "scopes": [
        "group:write"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/GroupMembership",
      "name": "GroupMembership"
    }
  }
}