Skip to main content
PUT
Updates a single care instruction layer.

Headers

X-Delogue-Api
string

Path Parameters

id
integer<int64>
required

The unique identifier of the care instruction layer to update. This route value is authoritative.

Body

userDefinedId
null | string

A new customer-defined identifier for the layer. Null or omitted leaves the existing value unchanged.

text
null | string

The new default display text for the layer. Null or omitted leaves the existing text unchanged, and it cannot be set to empty.

state
null | enum<string>

The lifecycle state to apply. Null or omitted leaves the current state unchanged. The deleted state is rejected on the single update and hard-deletes the layer on the bulk update.

Available options:
active,
inactive,
deleted
position

Display order cannot be changed through this endpoint and must be omitted or null. A non-null value is rejected.

languages
null | object[]

The full replacement list of per-language translations. Null or omitted leaves existing translations unchanged; an empty list clears them all.

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.