Skip to main content
PUT
Bulk-updates or hard-deletes care instruction materials in a single transaction.

Headers

X-Delogue-Api
string

Body

id
integer<int64>
required

Unique identifier of the material to update or hard-delete. Required for every item in the request.

userDefinedId
null | string

Customer-defined identifier for the material, unique within the organization. When omitted or null the current value is left unchanged.

text
null | string

Display text of the material. When omitted or null the current text is left unchanged, and a supplied value cannot be empty.

state
null | enum<string>

Lifecycle state to apply to the material. On bulk update the deleted value routes the item through the hard-delete path; single update rejects it in favour of the DELETE endpoint.

Available options:
active,
inactive,
deleted
position

Display order of the material. It cannot be set through an update and must be omitted or null. A non-null value is rejected.

languages
null | object[]

Per-language translations of the material text. When supplied they fully replace the existing translations, an empty array 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.