Update hyperlink by ID

patch

https://client-api.{region}.fieldwire.com/api/v3/projects/{project_id}/hyperlinks/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

project_id

uuid

required

ID of the project this entity belongs to

uuid

required

ID of the entity

Body Params

Schema for updating hyperlink

last_editor_user_id

int32

ID of the user who most recently edited this entity

attachment_id

uuid | null

ID of the attachment this links to

custom_symbol_id

uuid | null

ID of the custom symbol this links to

floorplan_id

uuid | null

ID of the plan this links too

form_id

uuid | null

ID of the form this links to

color

string | null

Color to be used for this link

description

string | null

A short description of the entity

pos_x

int32 | null

X coordinate of the pixel where the link is centered on the plan

pos_y

int32 | null

Y coordinate of the pixel where the link is centered on the plan

device_updated_at

date-time

Time when the device last updated the entity

attachment

object

Creating or finding an Attachment associated with this Hyperlink

Headers

Fieldwire-Version

date

required

Specifies the version of the API to talk to

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Successful response