setDefaultLocation( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Sets a new default location.

The setDefaultLocation() function returns a Promise that resolves to the new default location.

Notes:

  • There can be only one default location per site.
  • The setDefaultLocation() function changes the value of the default property of both the new and old default locations objects.
  • The default location can't be archived.
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

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>
Did this help?