---
title: "Add cable position offset"
method: PUT
path: "/api/v1/reel/encoder/add-cable-offset"
tags: ["v1", "cable-position"]
---

# Add cable position offset

`PUT /api/v1/reel/encoder/add-cable-offset`

Adds a specified offset to the current cable encoder position.

This operation performs a relative adjustment to the current position reading by adding the specified offset value. Positive values increase the position reading, negative values decrease it.

## Request body

- AddCableOffsetRequest — Request data for adding an offset to the current cable encoder position.
  - `offset_to_add_in_meters` number, required — Offset value to add to the current cable position in meters. Positive values increase the position reading, negative values decrease it. This performs a relative adjustment without requiring knowledge of the absolute position.

## Response `200`

Successful Response

- AddCableOffsetResponse — Response for cable encoder offset operations. Adds a specified offset to the current cable encoder position. Useful for making fine adjustments to position readings without requiring absolute position knowledge.
  - `action` string, required — The action that was requested or performed by the endpoint
  - `error` boolean, required — Indicates whether the operation encountered an error
  - `error_msgs` string[] — List of error messages if the operation failed
  - `result` AddCableOffsetResult, required — Result data for cable encoder offset operations.
    - `success` boolean, required — Indicates whether the offset operation completed successfully. True when the offset was applied successfully, False if the operation failed (e.g., encoder not installed).
    - `new_cable_length` number, required — The updated cable position in meters after applying the offset. Represents the final cable position following the offset operation. This is the original position plus the applied offset value.

## Other responses

- `401` — Could not validate credentials
- `403` — Setup required before using this endpoint
- `422` — Validation Error
- `500` — Internal server error

---

[API](https://skmtc.net/reach-systems-tech/apis/reelapi-v1.md) · [All operations](https://skmtc.net/reach-systems-tech/apis/reelapi-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reach-systems-tech/reelapi-v1/versions/1dd366a9c6a3/schema)