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

# Update hyperlink by ID

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

## Path parameters

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

## Headers

- `Fieldwire-Version` string, date, required

## Request body

- HyperlinkUpdateInput — Schema for updating hyperlink
  - `last_editor_user_id` integer — ID of the user who most recently edited this entity
  - `attachment_id` string, uuid, nullable — ID of the attachment this links to
  - `custom_symbol_id` string, uuid, nullable — ID of the custom symbol this links to
  - `floorplan_id` string, uuid, nullable — ID of the plan this links too
  - `form_id` string, uuid, nullable — ID of the form this links to
  - `color` string, nullable — Color to be used for this link
  - `description` string, nullable — A short description of the entity
  - `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
  - `device_updated_at` string, date-time — Time when the device last updated the entity
  - `attachment` AttachmentInHyperlink — Creating or finding an Attachment associated with this Hyperlink
    - `id` string, uuid — ID of the attachment
    - `is_dynamic` boolean — Whether the content of this attachment can change without the URL changing
    - `file_url` string — URL of the potential processed file
    - `name` string — Name of the attachment
    - `original_url` string, nullable — URL of the file originally uploaded by the user
    - `thumb_url` string, nullable — URL of the thumb version of image attachment
    - `file_size` integer, nullable — Attachment file size

## Response `201`

Successful response

- Hyperlink — Link that lives on a plan & links to other entities
  - `id` string, uuid, required — ID of the entity
  - `creator_user_id` integer, required — ID of the user who created this entity
  - `last_editor_user_id` integer, required — ID of the user who most recently edited this entity
  - `attachment_id` string, uuid, nullable — ID of the attachment this links to
  - `custom_symbol_id` string, uuid, nullable — ID of the custom symbol this links to
  - `floorplan_id` string, uuid, nullable — ID of the plan this links too
  - `form_id` string, uuid, nullable — ID of the form 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 links to
  - `color` string, nullable — Color to be used for this link
  - `description` string, nullable — A short description of the entity
  - `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
  - `created_at` string, date-time, required — Time when the server created the entity
  - `deleted_at` string, date-time, nullable — Time the server deleted the entity
  - `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
  - `resolved_conflict` boolean, nullable, required — Specifies if PUT/PATCH request was rejected - do not store this field!
  - `updated_at` string, date-time, required — Time when the server last updated the entity

---

[API](https://skmtc.dev/fieldwire/apis/fieldwire-super-api.md) · [All operations](https://skmtc.dev/fieldwire/apis/fieldwire-super-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fieldwire/fieldwire-super-api/revisions/66ee1c20b92d/schema)