deletePolicy( )


Permanently deletes a policy.

The deletePolicy() function returns a Promise that resolves when the specified policy is deleted.

Deleted policies are not returned by the getPolicy() or queryPolicies() functions.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Events - all permissions
Manage Policies
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
policyIdstringRequired

ID of the policy to delete.

Was this helpful?
Yes
No