setDefaultLocation( )

Sets a new default location.

Notes:

  • There can only be one default location per site.
  • The default location can't be archived.
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Locations
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

ID of the location to set as the default location.

Returns
Return Type:Promise<SetDefaultLocationResponse>
Errors
400Invalid Argument

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?