NinjaOne icon

NinjaOne

Ninja One Public API documentation. <br><br>See also: <br> <a href="https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf">Device Filter syntax</a><br><a href="https://app.ninjarmm.com/apidocs-beta/core-resources/articles/webhooks/overview">Webhooks</a>

Actions309

CustomFields → Update custom field by field name

AI-generated

Summary

Update a custom field's attributes by specifying its unique field name, modifying properties such as label, description, type, permissions, default value, activity status, and scope configurations.

Inputs

  • fieldName (required) — The unique field name identifier of the custom field to update.
  • additionalFields — Optional collection of attributes to modify, including label, description, type, permissions (technician, script, API), default value, active status, scope, definition scope, and group ID.
  • options — Additional options such as custom JSON body to send, custom headers, query filters, batching, debug mode, pagination settings, and request timeout configuration.

Output shape

a single updated custom field record

Returns the updated custom field object as a single item. If debug is enabled, also includes request details under a debug property. Supports batching multiple input items but processes each update individually.

Examples

Example 1: Update the label and description of a custom field identified by its field name.

Set 'fieldName' to the target field's unique name and populate 'additionalFields' with the new label and description values.

Example 2: Change the type and default value of a custom field while making it active.

Provide 'fieldName' and use 'additionalFields' to set 'type', 'defaultValue', and 'active' attributes accordingly.

Links

Discussion