Update Fax Tags
Perform Update Fax Tags through NikoHealth.
nikohealth_update_fax_tagswritenikohealth
Inputs
- Fax Id
fax_idtextrequiredRequired text value.
- Tag Ids
tag_idstextrequiredRequired text value.
- Tag Ids Select
tag_ids_selectmulti_selectdynamic optionsOptional list of selected values. Retrieve allowed values from the dynamic options endpoint.
- Mode
modeselectOptional selected identifier or value.
Default:
"replace"Options: Append ("append"), Replace ("replace")
Outputs
successSuccessmodeModetag_idsTag IdserrorError
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": [
"fax_id",
"tag_ids"
],
"properties": {
"mode": {
"enum": [
"append",
"replace"
],
"type": "string",
"default": "replace",
"description": "Optional selected identifier or value.",
"x-workflow-field-type": "select"
},
"fax_id": {
"type": "string",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"tag_ids": {
"type": "string",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"tag_ids_select": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional list of selected values. Retrieve allowed values from the dynamic options endpoint.",
"x-dynamic-options": true,
"x-workflow-field-type": "multi_select"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"mode": {},
"error": {},
"success": {},
"tag_ids": {}
},
"additionalProperties": true
}