Skip to main content
POST
Creates one or more care instructions.

Headers

X-Delogue-Api
string

Body

userDefinedId
null | string

Optional customer-defined reference code for the new care instruction. Must be unique within the organization and at most 50 characters.

text
string

Default display text of the care instruction. Required and limited to 500 characters.

isActive
boolean

Whether the care instruction is active and available for use when created. Defaults to true.

languages
null | object[]

Optional initial per-language translations for the care instruction. Each language may appear at most once.

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.