Admin Sales: RMA

Update an RMA custom field

Partial update. Sending options replaces the full option set. Permission: sales.rma.custom-fields.edit.

put/rma/custom-fields/{id}

Request

Path parameters

idstring required

Rma custom field ID

Request body

labelstring
is_required0 | 1
positioninteger
status0 | 1

Example request

{
  "label": "How should we resolve this?",
  "position": 2,
  "status": 1,
  "options": [
    {
      "name": "Refund",
      "value": "refund"
    },
    {
      "name": "Store credit",
      "value": "store_credit"
    }
  ]
}

Response

The updated RMA custom field.

Changes

No recorded changes to this operation across all 8 revisions of this API.