Method: beacons.deactivate

Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via beaconinfo.getforobserved. Calling this method on an already inactive beacon will do nothing (but will return a successful response code).

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

POST https://proximitybeacon.googleapis.com/v1beta1/{beaconName=beacons/*}:deactivate

The URL uses Google API HTTP annotation syntax.

Path parameters

Parameters
beaconName

string

Beacon that should be deactivated. 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-UID, 4 for Eddystone-EID, 1 for iBeacon, or 5 for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.

Query parameters

Parameters
projectId

string

The project id of the beacon to deactivate. 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 must be empty.

Response body

If successful, the response body will be empty.

Authorization

Requires the following OAuth scope:

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

For more information, see the Auth Guide.