Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

Update Custom Input Field

PUT

https://api.zid.sa/v1/products/{product_id}/custom_user_input_fields/{custom_user_input_field_id}/

Updates an existing custom user-input field. This endpoint will replace the old data with the new data passed in the payload of this endpoint request.

🔑Scopes

products.read_write - Products Read & Write

Request

Path Params

Header Params

Body Params application/json

Example

{
  "type": "TEXT",
  "label": {
    "en": "Gift Message",
    "ar": "رسالة الهدية"
  },
  "hint": {
    "en": "please enter message text",
    "ar": "يرجى إدخال نص الرسالة"
  },
  "price": 25,
  "is_required": false,
  "is_published": true,
  "display_order": 1,
  "configs": {
    "is_multiline": true
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.zid.sa/v1/products/e0ad7a76-ba42-4c59-94c9-0da600117fbf/custom_user_input_fields/47eae56e-9874-4ed0-baf3-4a8618feb228/' \
--header 'Access-Token: {{Access-Token}}' \
--header 'Store-Id: {{StoreId}}' \
--header 'Role: Manager' \
--header 'Accept-Language: en' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "TEXT",
  "label": {
    "en": "Gift Message",
    "ar": "رسالة الهدية"
  },
  "hint": {
    "en": "please enter message text",
    "ar": "يرجى إدخال نص الرسالة"
  },
  "price": 25,
  "is_required": false,
  "is_published": true,
  "display_order": 1,
  "configs": {
    "is_multiline": true
  }
}'

Responses

🟢200Success

application/json

Body

Example

{
    "id": "47eae56e-9874-4ed0-baf3-4a8618feb228",
    "type": "TEXT",
    "hint": {
        "en": "please enter message text",
        "ar": "يرجى إدخال نص الرسالة"
    },
    "label": {
        "en": "Gift Message",
        "ar": "رسالة الهدية"
    },
    "display_order": 1,
    "is_required": false,
    "price": 25.0,
    "formatted_price": " SAR 25.00",
    "configs": {
        "is_multiline": true
    },
    "visibility_condition": null,
    "is_published": true
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-03-19 11:31:01

Create Custom Input Field

Delete Custom Input Field