Skip to content

Update RMA custom field

Partial update — send only the fields you want to change. Pass the resource IRI as id. Permission: sales.rma.custom-fields.edit.

Operation

OperationTypePurpose
updateAdminRmaCustomField(input:)MutationUpdate a RMA custom field

Input fields

Input fields are camelCase. id is the resource IRI.

FieldTypeRequiredNotes
idIDYesResource IRI of the RMA custom field to update.
labelstringNoField label.
is_requiredintegerNo1/0.
positionintegerNoSort order.
statusintegerNo1 active / 0 inactive.
optionsarrayNoSending options replaces the full option set. Each entry { name, value }.

Released under the MIT License.