API Reference

Update a Specific Action Field

Updates (or changes) a specific, existing editable action field based on both action and field IDs.

See Parameters and Authentication below.

Sample Request

{
  "field":
    {
      "name": "frdasd 44",
      "long_name": "s",
      "type": "TextField",
      "allow_scanning": "0",
      "mobile_scan_only": "0",
      "is_open_field": "true",
      "is_required": "0",
      "is_editable": "0",
      "is_return_field": "0",
      "is_required_return": "0",
      "is_editable_return": "0"
    }
}

Parameters

Path ParametersRequired/OptionalDescriptionType
action_idrequiredThe value for the action you want to update.string
field_idrequiredThe value for the field you want to update.string
Body ParametersRequired/OptionalDescriptionType
fieldrequiredThe list of field objects that must be updated for the action(s).Array of objects. See Action Field Objects List below.

Action Fields Objects List

The following action field objects are all required strings:

  • name: The name of the action field.
  • long_name: The display field (read-only).
  • type: The action field type.
  • allow_scanning: Allows the action field to be scanned.
  • mobile_scan_only: Allows the action field to be scanned via mobile devices only.
  • is_open_field: Means this action field is an open field (what happens when someone clicks the action).
  • is_required: Denotes the action field as a required field.
  • is_editable: Allows editing of the specific action field.
  • is_return_field: Provides a return option for the asset.
  • is_required_return: Is a return required for the action to be closed?
  • is_editable_return: Do you wish for users to be able to manually edit the return?

Authentication

KeyDescription
AuthorizationYour Bearer token.
Language
Click Try It! to start a request and see the response here!