Skip to main content
POST
Create sample types

Headers

X-Delogue-Api
string

Body

name
string

Display name of the new sample type. Required, unique within the organization, and must not contain a dot.

state
enum<string>

Initial lifecycle state of the sample type. Defaults to active when omitted; the deleted state is not accepted on create.

Available options:
active,
inactive,
deleted
commentDeadline

Number of days after the sample is received within which comments should be posted. Null means no deadline.

notifySettings
null | enum<string>[]

Sample-request statuses that trigger a supplier-contact notification. Null uses the default of every status except Planned; an empty array notifies for none; a non-empty array sets exactly those.

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

Response

Created

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.