Actions168
- Bot Actions
- Call & Meeting Actions
- Channel Actions
- Add Bot to Channel
- Add Channel Members
- Approve Channel
- Archive Channel
- Change Channel Member Role
- Change Channel Permission
- Create Channel
- Delete Channel
- Get Channel
- Get Channel Members
- Join Channel
- Leave Channel
- List Channels
- Reject Channel
- Remove Bot From Channel
- Remove Channel Members
- Remove Single Channel Member
- Unarchive Channel
- Update Channel
- Chat Actions
- Cliq Database Actions
- Custom Domain Actions
- Custom Email Actions
- Department Actions
- Designation Actions
- Event Actions
- File Actions
- Maintenance (Bulk Export) Actions
- Message Actions
- Message Component Builder Actions
- OAuth Helper Actions
- Reaction Actions
- Reminder Actions
- Remote Work Actions
- Role Actions
- Team Actions
- Thread Actions
- User Actions
- User Field Actions
- User Status Actions
- Widget Map Ticker Actions
User Field → Update User Field Details
AI-generatedSummary
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.