/v1/custom-fields/{id}

put

https://example.com/v1/custom-fields/{id}

Update custom field

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Query Params

customFieldIdType

string

enum

Allowed:

sealedTarget

string

enum

Body Params

faceted

boolean

indexable

boolean

mandatory

boolean

name

object

required

properties

searchable

boolean

sortable

boolean

Headers

dj-client

string

enum

required

Specifies the client type making the request.

OPERATOR: Platform operator user.
ACCOUNT: Customer account user.
SUPPLIER: Supplier managing orders.

Allowed:

dj-api-key

string

required

API key required for authentication. Must be valid and linked to the requesting user.

dj-store

string

(Optional) Store ID in multi-store environments.

dj-store-view

string

(Optional) Store view ID in multi-store environments.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Given custom field id is updated

404Given custom field id is not found