Skip to main content
PUT
Updates a single care instruction.

Headers

X-Delogue-Api
string

Path Parameters

id
integer<int64>
required

Unique identifier of the care instruction to update. This route id takes precedence over any id in the body.

Body

userDefinedId
null | string

New customer-defined reference code, at most 50 characters. Omit or send null to leave the existing value unchanged.

text
null | string

New default display text, at most 500 characters. It cannot be empty when supplied; omit or send null to leave the existing text unchanged.

state
null | enum<string>

Lifecycle state to apply to the care instruction. Omit or send null to keep the current state. On bulk update, the deleted value routes the item through the hard-delete path.

Available options:
active,
inactive,
deleted
position

Not writable through this endpoint and must be omitted or left null. A non-null value is rejected.

languages
null | object[]

Replacement set of per-language translations. A non-empty list replaces all existing translations, an empty list clears them, and null leaves them unchanged.

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.