forbidden( )


Returns a response with a status code 403 (Forbidden) and instructs the router to show a 403 page.

The forbidden() function is used in the router(), beforeRouter(), and afterRouter() hooks to indicate that the requested page is forbidden. Optionally, you can pass a message that otherwise defaults to 'Forbidden'.

Method Declaration
Copy
function forbidden(message: string): Promise<WixRouterResponse>;
Method Parameters
messagestring

The message to show.

Returns
Return Type:Promise<WixRouterResponse>
Create a forbidden response
JavaScript
import { forbidden } from "wix-router"; export function myRouter_Router(request) { return forbidden(); }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?