Custom Fields

Update Custom Field

Changed on

Updates an existing custom field.

put/v1/shops/{shopId}/custom-fields/{customFieldId}

Request

Request body

namestring required

Must not be greater than 255 characters.

placeholderstring nullable

Must not be greater than 255 characters.

hintstring nullable

Must not be greater than 255 characters.

type'text' | 'textarea' | 'checkbox' | 'select' required
optionsstring nullable

Must not be greater than 255 characters.

defaultstring nullable

Must not be greater than 255 characters.

regexstring nullable

Must not be greater than 255 characters.

is_requiredboolean

Example request

{
  "name": "tjqotbhpzwonwlzospqcs",
  "placeholder": "nssrciatkmatldznkaapj",
  "hint": "ptdhyldmarwuvlvyfcejz",
  "type": "textarea",
  "options": "olbxnqyvzmcgyfpncfyst",
  "default": "nonjizoohlpabvwbfbzkw",
  "regex": "sewlxtdfjxskykaapbpdx",
  "is_required": true
}

Changes

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable