CPcpanel
Team Users

Suspend a team user

This function immediately suspends a team user.

get/Team/suspend_team_user

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

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
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.