v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Team Users

Set roles for a team user

This function sets roles for a team user.

Note:

This action may result in team users gaining access to team owner level privileges.

get/Team/set_roles

Query parameters

userstring required
Example:teamuser

The username of the team user.

rolestring
Example:database

The role or roles to set for the team user. Current roles include admin, database, email, web.

Note:

  • This function replaces the team user's current roles. If you omit this parameter, the team user loses every role and cannot use any features.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "set_roles",
  "module": "Team",
  "result": {
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}