Delete a User Action API

On this page

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

Request#

Soft delete a User Action. This operation can be reversed by re-activating the User Action.

DELETE/api/user-action/{userActionId}

OpenAPI Spec

Permanently delete a User Action. This operation cannot be reversed.

DELETE/api/user-action/{userActionId}?hardDelete=true

OpenAPI Spec

userActionId UUID required

The Id of the User Action to delete.

hardDelete Boolean optional

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

This API does not return a JSON response body.

Response Codes

Code	Description
200	The request was successful.
400	The 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.
401	You 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.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503	The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Learn about the APIs for invoking a User Action on a User.

API documentation for the FusionAuth Create a User Action API.

Learn about the APIs for creating, retrieving, updating and deleting user actions.

API documentation for the FusionAuth Reactivate a User Action API.