---
title: "Update automatic_hyperlink by ID"
method: PATCH
path: "/api/v3/projects/{project_id}/automatic_hyperlinks/{id}"
tags: ["automatic hyperlinks"]
---

# Update automatic_hyperlink by ID

`PATCH /api/v3/projects/{project_id}/automatic_hyperlinks/{id}`

## Request

- Base URL: `https://client-api.us.fieldwire.com`
- URL: `https://client-api.us.fieldwire.com/api/v3/projects/{project_id}/automatic_hyperlinks/{id}`
- Auth: HTTP bearer

## Path parameters

- `project_id` string, uuid, required
- `id` string, uuid, required

## Headers

- `Fieldwire-Version` string, date, required

## Request body

- AutomaticHyperlinkUpdateInput: Schema for updating automatic_hyperlinks
  - `floorplan_id` string, uuid, nullable: ID of the plan this links to
  - `device_updated_at` string, date-time: Time when the device last updated the entity

## Response `201`

Successful response

- AutomaticHyperlink: Plan link that takes to another plan which is automatically recognized & extracted by Fieldwire
  - `id` string, uuid, required: ID of the entity
  - `floorplan_id` string, uuid, nullable: ID of the plan this links to
  - `project_id` string, uuid, required: ID of the project this entity belongs to
  - `sheet_id` string, uuid, required: ID of the sheet this link lives on
  - `pos_x` integer, nullable: X coordinate of the pixel where the link is centered on the plan
  - `pos_y` integer, nullable: Y coordinate of the pixel where the link is centered on the plan
  - `radius` integer, nullable: Radius in pixel in case this is a circular hyperlink
  - `data` object, nullable: Data that gives the geometry in case this is a rectangular hyperlink
  - `created_at` string, date-time, required: Time when the server created the entity
  - `resolved_conflict` boolean, required: Specifies if PUT/PATCH request was rejected - do not store this field!
  - `device_created_at` string, date-time, required: Time when the device created the entity
  - `device_updated_at` string, date-time, required: Time when the device last updated the entity
  - `updated_at` string, date-time, required: Time when the server last updated the entity
  - `deleted_at` string, date-time, nullable: Time the server deleted the entity

---

[API](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api.md) - [All operations](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fieldwire/apis/fieldwire-regional-api/revisions/34b820438c0b?raw)