updateTag
Idempotent
Update an existing tag by ID to rename it while preserving tag-to-member relationships. Omitted fields stay unchanged; use _clear_fields to clear values, and receive the full updated record.
Instructions
Update a tag - Update an existing tag record by ID. Fields omitted are untouched. Writes live data.
Use when: renaming a tag without losing the tag-to-member relationships.
Required: id.
updated_by is wrapper-managed: the audit-trail updated_by field is hardcoded to 0 by the wrapper on every update. Not exposed as an input.
See also: createTag (add new), deleteTag (remove permanently).
Returns: { status: "success", message: {...updatedRecord} } - the full updated record after changes applied.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| tag_name | No | ||
| _clear_fields | No | Column names to clear to empty string. Available on every `update*` operation. Works on base columns AND EAV/`users_meta` rows (rows preserved with `value=""`). To actually clear a field you MUST use this parameter — sending the field with `""` alone is a no-op (BD drops empty values). To remove a `users_meta` row entirely, use `deleteUserMeta`. See **Rule: Clearing fields**. Example: `_clear_fields: ["h2", "hero_link_url"]`. |