---
updatedAt: 2026-06-03T14:46:37.000Z
agentTools:
  projectIndex: https://developers.fieldwire.com/llms.txt
---

# Create a new hyperlink in a sheet

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Fieldwire Regional API",
    "version": "v3"
  },
  "servers": [
    {
      "url": "https://client-api.{region}.fieldwire.com",
      "variables": {
        "region": {
          "default": "us",
          "enum": [
            "ca",
            "eu",
            "us"
          ]
        }
      }
    }
  ],
  "components": {
    "headers": {
      "current_user_id": {
        "description": "Current user's id",
        "schema": {
          "type": "integer"
        }
      }
    },
    "parameters": {
      "api_version": {
        "name": "Fieldwire-Version",
        "in": "header",
        "description": "Specifies the version of the API to talk to",
        "required": true,
        "schema": {
          "type": "string",
          "format": "date"
        }
      },
      "project_id": {
        "name": "project_id",
        "in": "path",
        "description": "ID of the project this entity belongs to",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "schemas": {
      "hyperlink": {
        "type": "object",
        "description": "Link that lives on a plan & links to other entities",
        "required": [
          "id",
          "creator_user_id",
          "last_editor_user_id",
          "project_id",
          "sheet_id",
          "created_at",
          "device_created_at",
          "device_updated_at",
          "resolved_conflict",
          "updated_at"
        ],
        "nullable": false,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "nullable": false,
            "description": "ID of the entity"
          },
          "creator_user_id": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "ID of the user who created this entity"
          },
          "last_editor_user_id": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "ID of the user who most recently edited this entity"
          },
          "attachment_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID of the attachment this links to"
          },
          "custom_symbol_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID of the custom symbol this links to"
          },
          "floorplan_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID of the plan this links too"
          },
          "form_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID of the form this links to"
          },
          "project_id": {
            "type": "string",
            "format": "uuid",
            "nullable": false,
            "description": "ID of the project this entity belongs to"
          },
          "sheet_id": {
            "type": "string",
            "format": "uuid",
            "nullable": false,
            "description": "ID of the sheet this links to"
          },
          "color": {
            "type": "string",
            "nullable": true,
            "description": "Color to be used for this link"
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "A short description of the entity"
          },
          "pos_x": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "X coordinate of the pixel where the link is centered on the plan"
          },
          "pos_y": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Y coordinate of the pixel where the link is centered on the plan"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the server created the entity"
          },
          "deleted_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Time the server deleted the entity"
          },
          "device_created_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the device created the entity"
          },
          "device_updated_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the device last updated the entity"
          },
          "resolved_conflict": {
            "type": "boolean",
            "nullable": true,
            "description": "Specifies if PUT/PATCH request was rejected - do not store this field!"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the server last updated the entity"
          }
        },
        "additionalProperties": false
      },
      "attachment_in_hyperlink": {
        "type": "object",
        "nullable": false,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "nullable": false,
            "description": "ID of the attachment"
          },
          "is_dynamic": {
            "type": "boolean",
            "nullable": false,
            "description": "Whether the content of this attachment can change without the URL changing"
          },
          "file_url": {
            "type": "string",
            "nullable": false,
            "description": "URL of the potential processed file"
          },
          "name": {
            "type": "string",
            "nullable": false,
            "description": "Name of the attachment"
          },
          "original_url": {
            "type": "string",
            "nullable": true,
            "description": "URL of the file originally uploaded by the user"
          },
          "thumb_url": {
            "type": "string",
            "nullable": true,
            "description": "URL of the thumb version of image attachment"
          },
          "file_size": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Attachment file size"
          }
        },
        "description": "Creating or finding an Attachment associated with this Hyperlink",
        "additionalProperties": false
      },
      "hyperlink_create_input": {
        "type": "object",
        "required": [
          "creator_user_id",
          "last_editor_user_id",
          "device_created_at",
          "device_updated_at"
        ],
        "nullable": false,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "nullable": false,
            "description": "ID of the entity"
          },
          "creator_user_id": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "ID of the user who created this entity"
          },
          "last_editor_user_id": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "ID of the user who most recently edited this entity"
          },
          "attachment_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID of the attachment this links to"
          },
          "custom_symbol_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID of the custom symbol this links to"
          },
          "floorplan_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID of the plan this links too"
          },
          "form_id": {
            "type": "string",
            "format": "uuid",
            "nullable": true,
            "description": "ID of the form this links to"
          },
          "color": {
            "type": "string",
            "nullable": true,
            "description": "Color to be used for this link"
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "A short description of the entity"
          },
          "pos_x": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "X coordinate of the pixel where the link is centered on the plan"
          },
          "pos_y": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "Y coordinate of the pixel where the link is centered on the plan"
          },
          "device_created_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the device created the entity"
          },
          "device_updated_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the device last updated the entity"
          },
          "attachment": {
            "$ref": "#/components/schemas/attachment_in_hyperlink"
          }
        },
        "description": "Schema for creating hyperlinks",
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "jwt": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Access token (JWT) generated using the acquired refresh token (API token). Our [authentication](https://developers.fieldwire.com/docs/authentication) guide covers the steps to generate a valid token"
      }
    }
  },
  "paths": {
    "/api/v3/projects/{project_id}/sheets/{sheet_id}/hyperlinks": {
      "post": {
        "summary": "Create a new hyperlink in a sheet",
        "operationId": "add_hyperlink_in_sheet",
        "tags": [
          "hyperlinks"
        ],
        "security": [
          {
            "jwt": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/project_id"
          },
          {
            "$ref": "#/components/parameters/api_version"
          },
          {
            "name": "sheet_id",
            "description": "ID of the sheet to create hyperlink in",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "Successful response",
            "headers": {
              "X-Current-User-Id": {
                "$ref": "#/components/headers/current_user_id"
              }
            },
            "content": {
              "application/json": {
                "example": {
                  "id": "ab684bbb-5453-4325-9924-6e161a1c4660",
                  "creator_user_id": 1180,
                  "last_editor_user_id": 1180,
                  "project_id": "d2ffce72-47d0-41ac-b441-7158e95a1dc4",
                  "resolved_conflict": false,
                  "created_at": "2026-10-02T14:50:36.623Z",
                  "updated_at": "2026-10-02T14:50:36.623Z",
                  "device_created_at": "2026-10-02T14:50:36.304Z",
                  "device_updated_at": "2026-10-02T14:50:36.304Z",
                  "deleted_at": null,
                  "sheet_id": "367cfbaf-834c-4beb-ac2e-0c8c1aff7a5e",
                  "description": "description",
                  "pos_x": 100,
                  "pos_y": 200,
                  "floorplan_id": "2cdaf4d2-1ba1-4097-a476-5998f6dd2510",
                  "attachment_id": null,
                  "color": null,
                  "custom_symbol_id": null,
                  "form_id": null
                },
                "schema": {
                  "$ref": "#/components/schemas/hyperlink"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/hyperlink_create_input"
              }
            }
          },
          "required": true
        }
      }
    }
  }
}
```