Create Order Note
Perform Create Order Note through NikoHealth.
nikohealth_create_order_notewritenikohealth
Inputs
- Note Request
note_requestexpressionOptional literal value or workflow expression.
- Order Id
order_idexpressionOptional literal value or workflow expression.
- Subject
subjectexpressionOptional literal value or workflow expression.
- Description
descriptionexpressionOptional literal value or workflow expression.
- Is Pinned
is_pinnedbooleanOptional true-or-false value.
Default:
false - Idempotency Fingerprint
idempotency_fingerprintexpressionOptional literal value or workflow expression.
- Skip If Empty
skip_if_emptybooleanOptional true-or-false value.
Default:
false - Dry Run
dry_runbooleanOptional true-or-false value.
Default:
false
Outputs
successSuccessskippedSkippeddry_runDry RunidempotentIdempotentorder_idOrder Idnote_idNote IdsubjectSubjectnote_textNote TextmessageMessageerrorErrorerror_typeError Type
Output schema completeness: best_effort_declared
Safety
- External effect
- write
- Confirmation recommended
- No
- Retry safe
- No
- Dry run supported
- Yes
Schemas
These schemas are first-pass authoring guidance. Runtime validation remains authoritative.
Input schema
{
"type": "object",
"properties": {
"dry_run": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"subject": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"order_id": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"is_pinned": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"description": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"note_request": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"skip_if_empty": {
"type": "boolean",
"default": false,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
},
"idempotency_fingerprint": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"error": {},
"dry_run": {},
"message": {},
"note_id": {},
"skipped": {},
"subject": {},
"success": {},
"order_id": {},
"note_text": {},
"error_type": {},
"idempotent": {}
},
"additionalProperties": true
}