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.

SecurityBasicAuth

Request

query Parameters

required	integer or string 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'. Examples: offset date=120days unix-timestamp date=1649948169
user required	string The username of the team user. Example: user=teamUser
reason	string The reason for expiration. Example: reason=teamUser gave a two week notice.

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Team/set_expire

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Team \
  set_expire \
  user='teamUser' \
  date='120days'

Response samples

application/json

{"apiversion": 3,
"func": "set_expire",
"module": "Team",
"result": {"data": 1674575562,
"errors": null,
"messages": null,
"metadata": {"transformed": 1
},
"status": 1,
"warnings": null
}
}