Delete a User Action

This API is used to delete an User Action. You must specify the Id of the User Action on the URI.

Request#

API Key Authentication
Soft delete a User Action. This operation can be reversed by re-activating the User Action.
DELETE/api/user-action/{userActionId}
OpenAPI Spec
API Key Authentication
Permanently delete a User Action. This operation cannot be reversed.
DELETE/api/user-action/{userActionId}&hardDelete=true

Request Parameters#

userActionIdUUIDrequired

The Id of the User Action to delete.

hardDeleteBooleanoptional

Whether or not the User Action is soft or hard deleted.

Response#

This API does not return a JSON response body.

Response Codes
CodeDescription
200The request was successful.
400The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404The object you requested doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.