archiveLocation( )

Developer Preview

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

Archives a location.

The archiveLocation() function returns a Promise that resolves to the archived location.

The archiveLocation() function changes a location's archived property to true.

Notes:

  • A location's status isn't affected by this function.
  • An archived location can't be updated.
  • It's currently not possible to unarchive locations.
  • A 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 archive.

Returns
Return Type:Promise<ArchiveLocationResponse>
Did this help?