Skip to main content
PUT
Update a sample type (full replace)

Headers

X-Delogue-Api
string

Path Parameters

id
integer<int64>
required

Unique identifier of the sample type to update. The route id wins over any id in the body.

Body

name
null | string

Display name of the sample type. Required and non-empty on a full-replace PUT and preserved by a PATCH that does not touch it. It must not contain a dot.

state
null | enum<string>

Lifecycle state of the sample type to set on update. Required on a full-replace PUT and cannot be removed by a PATCH.

Available options:
active,
inactive,
deleted
commentDeadline

Number of days after the sample is received within which comments should be posted. On a PUT, null or omitted clears the deadline; a PATCH preserves it unless the field is touched.

position

Server-controlled 1-based display order among the organization's sample types. It must be null or omitted on writes; a non-null value is rejected.

notifySettings
null | enum<string>[]

Sample-request statuses that trigger a supplier-contact notification. On a PUT, null or empty clears all and a non-empty list sets exactly those; a PATCH preserves the set unless touched.

Available options:
requested,
sent,
received,
commented,
cancelled,
confirmed,
planned

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
null | object
required

The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value.