Skip to main content
PATCH
/
items
/
{itemId}
/
customfields
/
{customfieldId}
Update Item Custom Field
curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/items/{itemId}/customfields/{customfieldId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '{
  "Value": {}
}'
{
  "ErrorCode": "<string>",
  "ValidationErrors": {},
  "Errors": {},
  "ErrorMessage": "<string>",
  "Stacktrace": "<string>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

Path Parameters

​
itemId
integer<int32>
required

The id of the item that the custom field belongs to.

​
customfieldId
integer<int32>
required

The id of the customfield that should be updated.

Body

application/json

The custom field value.

Model Class: UpdateCustomFieldValue

​
Value
object
required

The custom field value. The object should match the custom field type.

Response