---
title: "Update beacon."
method: POST
path: "/beacon/update"
tags: ["Tracking|Beacon"]
---

# Update beacon.

`POST /beacon/update`

This function can be utilized to modify beacons. It is not possible to update the position of beacons through the
API to ensure precise data within geoCapture. In addition, the creation or deletion of beacons is not possible.

An identified beacon is updated according to the chosen primary key type and the supplied primary key. It is
important to note that creating a new beacon is not possible through this action. You can update the serial
number of the item to which the beacon is attached, along with the `objectIdentifier`.

## Request body

- StandardBeaconUpdateRequest
  - `records` object[] — The records. This Parameter is required.
    - `keyField` string — This parameter specifies the name of the unique key used to distinctly assign each dataset in the API. | Value | Description | |----------------|-----------------------------| | id | The internal beacon ID | | uuid | The UUID |
    - `data` BeaconUpdateRequestRecordData
      - `id` integer — The internal ID.
      - `uuid` string — The beacon UUID as hexadecimal value.
      - `macAddress` string — The beacon MAC address.
      - `name` string — The name of the beacon. (max. 255 characters)
      - `objectIdentifier` string — External, customer specific ID of the object the beacon is attached to. (max. 64 characters)
      - `objectSerialNumber` string — Serial number of object, the beacon is attached to. (max. 128 characters)
  - `dryRun` boolean — Simulate the operation. (No records will be created or changed) This Parameter is optional.

## Response `200`

Success Response:

- StandardBeaconUpdateResponse
  - `updatedBeacons` object[] — The changed beacons.
    - `id` integer — The internal ID.
    - `uuid` string — The beacon UUID as hexadecimal value.
    - `macAddress` string — The beacon MAC address.

---

[API](https://skmtc.net/geocapture/apis/geocapture-api.md) · [All operations](https://skmtc.net/geocapture/apis/geocapture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/geocapture/geocapture-api/versions/869b05603541/schema)