POST

Archive Location


Archives a location.

Notes:

  • Changes the archived boolean of a location to true.
  • You can't change a location's status using this endpoint.
  • Archived locations can't be updated.
  • 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.
Endpoint
POST
https://www.wixapis.com/locations/v1/locations/{id}/archive

Path Params
idstringRequired

ID of the location to archive.

Response Object
locationLocation

Archived location.

Archive Location
Request
cURL
curl -X POST \ 'https://www.wixapis.com/locations/v1/locations/97dc43b5-521b-48e9-8710-a3543f00f0ca/archive' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH>' \ --data-binary '{}'
Response
JSON
{ "location": { "id": "97dc43b5-521b-48e9-8710-a3543f00f0ca", "name": "3rd Avenue", "default": false, "status": "ACTIVE", "locationType": "UNKNOWN", "fax": "1800-555-XXX", "timeZone": "America/New_York", "email": "employee-email@domain.com", "phone": "1800-555-XXX", "address": { "country": "US", "subdivision": "NY", "city": "New York", "postalCode": "10003", "streetAddress": { "number": "33", "name": "3rd Avenue", "apt": "" }, "formattedAddress": "Alumni Hall, 33 3rd Ave, New York, NY 10003, USA", "geocode": { "latitude": 40.7302968, "longitude": -73.98899449999999 } }, "revision": "3", "archived": true } }
Errors
400Invalid Argument

There is 1 error with this status code.

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

Event TriggersThis method triggers the following events:
Did this help?