Method: beacons.update

Updates the information about the specified beacon. Any field that you do not populate in the submitted beacon will be permanently erased, so you should follow the "read, modify, write" pattern to avoid inadvertently destroying data.

Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for activation, deactivation, and decommissioning. Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project.

HTTP request

PUT https://proximitybeacon.googleapis.com/v1beta1/{beacon.beaconName=beacons/*}

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
beacon.beaconName

string

Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are 3 for Eddystone, 1 for iBeacon, or 5 for AltBeacon.

This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.

Query parameters

Parameters
projectId

string

The project id of the beacon to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.

Request body

The request body contains an instance of Beacon.

Response body

If successful, the response body contains an instance of Beacon.

Authorization

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/userlocation.beacon.registry

For more information, see the Auth Guide.