Edit Target

Update an existing target. You can change the name, depth, position, shape, or any of the optional attributes (azimuth, dip, confidence level).

All fields are optional — include only what you want to change. The server merges the patch onto the existing target before validating and persisting, so unspecified fields keep their previous values.

PATCH/api/v1/designs/{designid}/targets/{targetid}

Update an existing target — any subset of fields

Path Parameters

Name	Type	Required	Description
designid	string (UUID)	✓	The UUID of the design
targetid	string (UUID)	✓	The UUID of the target to update

Headers

Name	Value	Description
apikey	YOUR_API_KEY	Your API authentication key
Content-Type	application/json	Must be application/json

Request Body

Any subset of target fields to update

Request body fields

All fields are optional. Include only what you want to change.

Field	Type	Description
name	string	New display name
shape	object	Replacement shape — see Create Target for the full catalogue. Switching to or from Polygon changes which position fields are required.
depthTVD	string	True vertical depth, e.g. "2520|m"
depthReference	"RKB" or "MSL"	Depth reference datum
mapPositionEasting	string	Easting on the projected map
mapPositionNorthing	string	Northing on the projected map
azimuth	string	Target azimuth, e.g. "135|deg"
dipAngle	string	Target dip angle, e.g. "5|deg"
dipDirectionAzimuth	string	Direction of dip, e.g. "180|deg"
confidenceLevel	string	Drillers-target confidence as "NN|%"

Read-only on response (computed server-side): targetId, epsgCode, geographicPosition*. Do not supply these in the patch.

Notes

• The patch is merged onto the existing target — fields you omit are preserved
• Replacing shape swaps the geometry wholesale; you cannot patch just one parameter inside the shape.parameters object
• The same conditional rules from Create Target apply to the merged result: if the resulting shape.type is Polygon, the merged object must not contain mapPositionEasting/mapPositionNorthing
• All measurement fields use the pipe-delimited "value\|unit" format
• The response is 200 OK with the full, post-merge target representation