POST

Set Default Location

Sets a new default location.

Notes:

  • There can only be one default location per site.
  • 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}/set-default
Path Params
idstringRequired

ID of the location to set as the default location.

Response Object
locationLocation

New default location.

Set Default Location
Request
cURL
curl -X POST \
  'https://www.wixapis.com/locations/v1/locations/ea50573e-35fa-47ca-bba7-3e45a935d9bc/set-default' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: <AUTH>' \
  --data-binary '{}'
Response
JSON
{
  "location": {
    "id": "ea50573e-35fa-47ca-bba7-3e45a935d9bc",
    "name": "New Location Name",
    "default": true,
    "status": "ACTIVE",
    "locationType": "UNKNOWN",
    "timeZone": "America/Los_Angeles",
    "address": {
      "country": "US",
      "subdivision": "CA",
      "city": "Los Angeles",
      "postalCode": "90015",
      "streetAddress": {
        "number": "1111",
        "name": "South Figueroa Street",
        "apt": ""
      },
      "formattedAddress": "STAPLES Center, South Figueroa Street, Los Angeles, CA, USA",
      "geocode": {
        "latitude": 34.0430175,
        "longitude": -118.2672541
      }
    },
    "revision": "6",
    "archived": false
  }
}
Errors
400Invalid Argument

There are 2 errors with this status code.

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

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

Set Default Location

Triggered when a location is set as default.

Permissions
Manage Locations
Learn more about app permissions.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring

Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring

Fully qualified domain name of the entity associated with the event. Expected wix.locations.v1.location.

slugstring

Event name. Expected set_default_location.

entityIdstring

ID of the entity associated with the event.

eventTimestringformat date-time

Event timestamp.

triggeredByAnonymizeRequestboolean

Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring

If present, indicates the action that triggered the event.

actionEventActionEvent

Event information.

Event Body

The data payload will include the following as an encoded JWT:

JSON
{
  "data": {
    "eventType": "wix.locations.v1.location_set_default_location",
    "instanceId": "<app-instance-id>",
    "data": "<stringified-JSON>",
    // The identity field is sent as a stringified JSON
    "identity": {
      "identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
      "anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
      "memberId": "<memberId>", // in case of MEMBER
      "wixUserId": "<wixUserId>", // in case of WIX_USER
      "appId": "<appId>" // in case of APP
    }
  }
}
Did this help?