Skip to documentation
NikoHealth integration

Update Order Tags By Name

Perform Update Order Tags By Name through NikoHealth.

View as Markdown
nikohealth_update_order_tags_by_name
writenikohealth

Inputs

  • order_id
    expressionrequired
    Order Id

    Required literal value or workflow expression.

  • remove_tag_names
    expression
    Remove Tag Names

    Optional literal value or workflow expression.

  • add_tag_names
    expression
    Add Tag Names

    Optional literal value or workflow expression.

  • skip_if_empty
    boolean
    Skip If Empty

    Optional true-or-false value.

    Default: false

  • best_effort
    boolean
    Best Effort

    Optional true-or-false value.

    Default: false

Outputs

  • successSuccess
  • statusStatus
  • skippedSkipped
  • order_idOrder Id
  • tag_idsTag Ids
  • added_tag_idsAdded Tag Ids
  • removed_tag_idsRemoved Tag Ids
  • missing_tag_namesMissing Tag Names
  • failure_reasonFailure Reason
  • errorError

Output schema completeness: best_effort_declared

Safety

External effect
write
Confirmation recommended
No
Retry safe
No
Dry run supported
No

Schemas

These schemas are first-pass authoring guidance. Runtime validation remains authoritative.

Input schema
{
  "type": "object",
  "required": [
    "order_id"
  ],
  "properties": {
    "order_id": {
      "description": "Required literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    },
    "best_effort": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    },
    "add_tag_names": {
      "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"
    },
    "remove_tag_names": {
      "description": "Optional literal value or workflow expression.",
      "x-workflow-field-type": "expression"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "error": {},
    "status": {},
    "skipped": {},
    "success": {},
    "tag_ids": {},
    "order_id": {},
    "added_tag_ids": {},
    "failure_reason": {},
    "removed_tag_ids": {},
    "missing_tag_names": {}
  },
  "additionalProperties": true
}
View all NikoHealth actions