v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Team Users

Suspend a team user

This function immediately suspends a team user.

get/Team/suspend_team_user

Query parameters

userstring required
Example:teamuser

The username of the team user.

reasonstring
Example:teamuser is on vacation

The reason for suspension.

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": "suspend_team_user",
  "module": "Team",
  "result": {
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}