Edit Section

Patch an existing section of a well schematic. The body is a flat object of the parameter fields you want to change (any subset of the section type's parameters). You can also move the section to a new position by supplying index.

You cannot change a section's type once it has been created — the server reads the existing section's type from sectionid and validates the body against that type's parameter schema. To switch from one type to another, delete the section and create a new one.

PATCH/api/v1/designs/{designid}/well-schematic/sections/{sectionid}

Update fields on an existing well-schematic section

Path Parameters

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

Headers

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

Request Body

Flat object: any subset of the section type's parameter fields, plus optional `index`. At least one property required.

Request body fields

The body is a flat object — not wrapped in parameters, and type is not part of the body. The server looks up the section by sectionid to determine its type, then validates the body against that type's parameter schema.

Field	Type	Required	Description
any section parameter	string | number | object	At least one of these or index	Any subset of the section type's fields, e.g. drillingFluidDensity, sectionTotalDepthMDRKB, holeSize, tubularType, strings. See Create Section for the full per-type field list.
index	number	No	New zero-based position to move the section to

How partial updates work

• The body must contain at least one property (parameter field or index); an empty {} is rejected
• Only fields supported by the existing section's type are accepted; unknown fields produce a 400 (additionalProperties: false)
• Any parameter you omit keeps its existing value
• Do not include type in the body — it is rejected as an unknown property. The section's type is immutable; to change type, delete and re-create
• The supplied index reorders the section within the schematic. If index is outside the valid range, the section stays where it is.

See Create Section for the full list of fields per section type.

Notes

• All measurements must be unit-encoded strings, e.g. "3500\|m", "9.625\|in", "1.15\|sg"
• Audit-log entries record a diff between the previous and updated section
• Patching a section's strings array via this endpoint replaces the strings as a unit; for incremental string changes use the String endpoints instead