Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
Team Users

Set a team user to expire

This function expires a team user after a specified amount of time.

If the team user already has an expire date set, it's replaced with a new date and reason.

get/Team/set_expire

Query parameters

integer required
OR
string required

The epoch time on which the team user account expires, or the offset from the current time, in days. Integers are treated as Unix Epoch Time unless followed by 'days'.

userstring required
Example:teamUser

The username of the team user.

reasonstring
Example:teamUser gave a two week notice.

The reason for expiration.

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