delete_user {polished}

Polished API - Delete a User

Description

Polished API - Delete a User

Usage

delete_user(user_uid, api_key = get_api_key())

Arguments

user_uid

the uid of the user to be deleted.

api_key

your Polished API key. Set your polished api key using set_api_key() so that you do not need to supply this argument with each function call.

Value

an object of class polished_api_res. When successful, the content of the polished_api_res is list(message = "success"). In the case of an error, the content is list(error = "<error message>").

See Also

get_users() add_user() update_user()