Zoho Cliq icon

Zoho Cliq

Fully manage your Zoho Cliq workspace: messages, channels, teams, users, databases, events, reminders, bots, files, and more

Actions168

User Field → Update User Field Details

AI-generated

Summary

Update the schema definition of a specified Zoho Cliq user field by modifying properties such as its display name, mandatory status, encryption, edit permissions, and dropdown options according to the chosen input mode.

Inputs

  • fieldId (required) — The ID of the user-field schema definition to update (not a user ID).
  • inputMode (required) — Method to provide the update payload: structured fields, agent/tool JSON, or raw JSON input.
  • name — New display name for the user-field schema definition (max 30 characters). Shown if inputMode allows structured input.
  • mandatoryMode — Whether the user field is required across user profiles. Options are true, false, or unset (no change). Available in structured input modes.
  • encryptedMode — Specifies if values stored for this field are encrypted (irreversible). Use for sensitive data. Available in structured input modes.
  • editPermissionMode — Defines whether end users can edit their values for this field. Does not affect definition-level edit permissions. Available in structured input modes.
  • replaceOptions — When true, replaces dropdown options for this field schema, requiring option objects with required name and optional id. Used with structured input.
  • options — Dropdown option entries (name and optional existing ID) to add or update when replaceOptions is true. Used with structured input.
  • agentToolOptions — JSON array of dropdown option objects (name required, id optional) used when inputMode is agentTool.
  • updateDefinitionRaw (required) — Raw JSON object specifying the user field schema update payload. Contains keys like name, mandatory, encrypted, edit_permission, and options. Used when inputMode is raw.
  • enableAiErrorMode — If true, returns errors as output items instead of stopping execution, suitable for AI Tool runs that recover from API errors.
  • simplify — If true, returns a simplified response instead of raw API data.
  • simplifyMode — Controls the simplification format for the output, such as fully simplified, raw, or selected fields.
  • simplifyFields — Selects which fields to include in the output when using selected fields simplify mode. Always includes the record ID.

Output shape

a single record representing the updated user field schema definition.

The output can be simplified or raw depending on user settings. The operation requires ZohoCliq.UserFields.UPDATE scope and updates only the user-field schema definition, not user profile values.

Links

Discussion