OnPrintShop icon

OnPrintShop

Interact with OnPrintShop API

Actions218

Complete API → Set Admin Extra Field

AI-generated

Summary

Set or update admin extra fields for OnPrintShop entities using the Complete API with configurable input modes and response options.

Inputs

  • Inputs (required) — Provide one or more admin extra field inputs to set or update. Each input can include properties such as Admin Extra Field ID, Attributes (which themselves can have various details like Attribute ID, Label, Status, etc.), Available To, Default Value, Delete flag, Description, Field Key, Field Type, Regex, Sort Order, Status, Title, and Validation Type.
  • Safe Mode — Optionally enable to block mutations in the Complete API or to retain legacy reduced-response behavior.
  • Input Mode (required) — Choose whether to provide inputs as individual fields or as a raw JSON object.
  • Arguments JSON — When JSON Object input mode is selected, specify the full JSON payload describing admin extra fields.
  • Partial Response — Specify how to handle partial success or failures when processing multiple inputs ('Fail on Errors' or 'Return Partial Data').
  • Return Fields Mode — Select whether to return all fields or a custom selection in the response.
  • Return Fields — When 'Custom Selection' is chosen, select specific fields like ID, Index, Message, and Result to be included in the operation's response.

Output shape

a list of response objects representing the results of setting admin extra fields; each item corresponds to one input provided.

Each response object may contain fields like 'id', 'index', 'message', and 'result'. Partial success can be controlled via the Partial Response option. Errors during execution will throw node errors or be returned per item when 'Continue On Fail' is enabled.

Examples

Example 1: Using Fields input mode to update multiple admin extra fields by specifying their IDs, attributes, and other properties.

User selects 'Complete API' resource, 'Set Admin Extra Field' operation. Inputs are entered as multiple field sets, each describing one admin extra field to set. Safe Mode and Partial Response options are adjusted as needed. Return Fields Mode is used to select response details.

Links

Discussion