updateLocation( )

Developer Preview

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

Updates a location.

The updateLocation() function returns a Promise that resolves to the updated location.

Each time a location is updated, its revision increments by 1. The current revision must be passed when updating the comment. This ensures you're working with the latest location and prevents unintended overwrites.

Notes:

  • Currently, it isn't possible to partially update a location. You must pass the full location object in the location parameter.
  • Any fields which are not included in the location parameter will be overwritten to null.
Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Locations
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

Location ID.

locationUpdateLocationRequired

Updated location details.

Returns
Return Type:Promise<Location>
Was this helpful?
Yes
No