Skip to main content
PUT
Update Custom Field

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The shop ID.

customFieldId
integer
required

The custom field ID.

Body

application/json
name
string
required

Must not be greater than 255 characters.

Example:

"pasyzwszwtxpeqq"

type
enum<string>
required
Available options:
text,
textarea,
checkbox,
select
Example:

"textarea"

placeholder
string

Must not be greater than 255 characters.

Example:

"ikymwkiinfowtzm"

hint
string

Must not be greater than 255 characters.

Example:

"ixkolowyuffszfr"

options
string

Must not be greater than 255 characters.

Example:

"snwwxvxezhebdrx"

default
string

Must not be greater than 255 characters.

Example:

"kpiypmuihrdifek"

regex
string

Must not be greater than 255 characters.

Example:

"zagqzitsslufxbo"

is_required
boolean
Example:

true

Response

200 - undefined