PATCH

Update Location Attributes


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 or deletes attributes on a location's Business Profile.

Only the attributes you specify are affected. Attributes you don't mention are left as they are, so you don't need to resend the whole set.

Whether an attribute is set or deleted depends on valueJson:

  • Specify valueJson to set the attribute to that value. It takes Google's attribute value JSON, for example {"valueType":"BOOL","values":[true]} or {"valueType":"URL","uriValues":[{"uri":"https://example.com"}]}. Use the bare attribute key in attributeId, such as has_wifi.
  • Leave valueJson empty to delete the attribute.

There's no flag for clearing everything: to delete several attributes, send one entry per attribute with valueJson empty. To delete all of them, first retrieve the location's attributes with Get Location Attributes, then send one empty entry per attribute you get back. At least one entry is always required, and a request carries at most 50, so a location with more than 50 attributes needs more than one call.

Call List Attribute Metadata to find which attributes a location supports and what value type each one takes.

Errors:

  • INVALID_VALUE_JSON: a valueJson isn't valid Google attribute JSON. The response says which entries were wrong, by index and attribute ID. This is checked before anything else, so nothing is changed.
  • NOT_FOUND: the location isn't recorded for this site. Google isn't called.
  • GOOGLE_API_CALL_FAILED: the call to Google failed. Google's status and response are in the error payload.
Authentication

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

Permissions
Manage SEO Settings
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/gbp/v1/locations/{locationId}/attributes

Errors
400Invalid Argument

There is 1 error with this status code.

500Internal

There is 1 error with this status code.

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

Did this help?