Update a Custom field

Update a Custom Field

PUT https://{{accountSlug}}.myeshopbox.com/api/platform/v1/property

The endpoint allows you to update custom field.

Headers

NameTypeDescription

Authorization

string

The Bearer token to grant access to the API.

Request Body

NameTypeDescription

label

string

It is the name with which the property will be identified.

internalName

string

It is the unique name of the property.

description

string

Short description of the property.

isUnique

boolean

It states whether the property is unique or not.

fieldType

string

It is the data type of property .

options

object

Options are there, when the client selectssingle_selects or multi_selects.

scope

object

It is the name of the module to which property can be assigned.

createdAt

string

Creation date and time.

updatedAt

string

Updation date and time.

{
    "items": [
        {
            "label": "fabric",
            "internalName": "style type",
            "description": "this is style code type property",
            "isUnique": "yes",
            "fieldType": "multi_select",
            "options": [
                "rock",
                "classy"
            ],
            "scope": [
                "product"
            ],
            "createdAt": "2020-03-09T17:16:20.645+05:30",
            "updatedAt": "2020-03-17T11:31:24.193+05:30"
        }
    ]
}
curl --location --request PUT 'http://localhost:8080/_ah/api/esb/v1/property' \
--header 'Content-Type: application/json' \
--header 'Authorization: ' \
--data-raw '{
   
    "internalName": "style type",
    "description": "this is style code type property",
    "isUnique": "yes"
   
}'

Last updated