Skip to main content

Edit Survey Run

Update an existing survey run. You can change the name, survey tool, tie-on configuration, or replace the survey points entirely.

All fields are optional — include only what you want to change.

PATCH/api/v1/designs/{designid}/survey-runs/{surveyrunid}

Modify a survey run's name, tool, tie-on, or points

Path Parameters

NameTypeRequiredDescription
designidstring (UUID)The UUID of the design
surveyrunidstring (UUID)The UUID of the survey run to update

Headers

NameValueDescription
apikeyYOUR_API_KEYYour API authentication key
Content-Typeapplication/jsonMust be application/json

Request Body

Survey run fields to update

Request body fields

All fields are optional.

FieldTypeDescription
namestringNew display name
surveyToolstringNew survey tool / error model name
tieOnType"surface" or "run"Change how this run connects to the wellbore
tieOnRunUUIDstring (UUID)New parent run UUID (required when changing tieOnType to "run")
tieOnDepthstringNew tie-on depth (required when changing tieOnType to "run")
pointsobjectReplacement survey points — replaces the entire point set

Notes

  • When updating points, the full point set is replaced — there is no way to append individual stations
  • Changing the tieOnType to "run" requires providing both tieOnRunUUID and tieOnDepth
  • The survey tool must exist in the company's error model settings
  • After updating points, the trajectory is recalculated automatically