Update a Field
PUThttps://euwest.api.elasticpath.com/v2/fields/:flowFieldID
- For Commerce, this endpoint updates a field.
- For Product Experience Manager, this endpoint updates an attribute.
Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the field/attribute is not updated.
Request
Path Parameters
flowFieldID uuidrequired
The unique identifier for the flow/template to which the field/attribute you want to update belongs.
- application/json
Body
required
data object
Responses
- 200
- 404
- 422
- 500
OK
- application/json
- Schema
- Example (from schema)
- default
Schema
data object
{
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "string",
"field_type": "string",
"slug": "string",
"name": "string",
"description": "string",
"required": true,
"enabled": true,
"omit_null": true,
"validation_rules": [
{
"type": "enum",
"options": [
null
],
"to": "customer"
}
],
"meta": {
"owner": "enum",
"timestamps": {
"created_at": "2023-10-11T13:02:25.293Z",
"updated_at": "2023-10-11T13:02:25.293Z"
}
},
"links": {
"self": "https://euwest.api.elasticpath.com/v2/flows/3cf3ad3f-b12c-4a08-a6ab-05e6aab0122c/fields/c1c788d1-f1c7-4b90-938f-f158f3353c66"
},
"relationships": {
"flow": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "flow"
}
}
}
}
}
{
"data": {
"id": "102b2087-d56a-45e7-bf1c-e9517716abb3",
"type": "field",
"field_type": "integer",
"slug": "start-of-life",
"name": "start-of-life",
"description": "day the iphone will work",
"required": true,
"default": "2018-01-01",
"enabled": true,
"validation_rules": [
{
"type": "between",
"options": {
"from": 1,
"to": 5
}
}
],
"order": 1,
"omit_null": false,
"links": {
"self": "https://useast.api.elasticpath.com/v2/flows/6d320b42-237d-4474-8452-d49f884d4ae1/fields/102b2087-d56a-45e7-bf1c-e9517716abb3"
},
"relationships": {
"flow": {
"data": {
"id": "6d320b42-237d-4474-8452-d49f884d4ae1",
"type": "flow"
}
}
},
"meta": {
"owner": "organization",
"timestamps": {
"created_at": "2018-05-10T18:19:11.559Z",
"updated_at": "2018-05-10T18:36:01.208Z"
}
}
}
}
Bad request. Not Found.
- application/json
- Schema
- Example (from schema)
- internal-server-error
Schema
errors Error[]required
{
"errors": [
{
"status": 500,
"title": "Internal server error",
"detail": "An internal error has occurred.",
"request_id": "00000000-0000-0000-0000-000000000000",
"meta": {
"missing_ids": [
"e7d50bd5-1833-43c0-9848-f9d325b08be8"
]
}
}
]
}
{
"errors": [
{
"title": "Not Found",
"status": 404
}
]
}
Bad request. The request failed validation.
- application/json
- Schema
- Example (from schema)
- missing-name
Schema
errors Error[]required
{
"errors": [
{
"status": 500,
"title": "Internal server error",
"detail": "An internal error has occurred.",
"request_id": "00000000-0000-0000-0000-000000000000",
"meta": {
"missing_ids": [
"e7d50bd5-1833-43c0-9848-f9d325b08be8"
]
}
}
]
}
{
"errors": [
{
"title": "Validation Error",
"status": 400,
"detail": "data.attributes.name: \"name\" is required"
}
]
}
Internal server error. There was a system failure in the platform.
- application/json
- Schema
- Example (from schema)
- internal-server-error
Schema
errors Error[]required
{
"errors": [
{
"status": 500,
"title": "Internal server error",
"detail": "An internal error has occurred.",
"request_id": "00000000-0000-0000-0000-000000000000",
"meta": {
"missing_ids": [
"e7d50bd5-1833-43c0-9848-f9d325b08be8"
]
}
}
]
}
{
"errors": [
{
"status": 500,
"title": "Internal Server Error",
"detail": "There was an internal server error, you can report with your request id.",
"request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
}
]
}
Authorization: http
name: bearerAuthtype: httpscheme: bearer
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X PUT 'https://euwest.api.elasticpath.com/v2/fields/:flowFieldID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"data": {
"default": 0,
"description": "string",
"field_type": "string",
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"required": true,
"slug": "string",
"type": "string"
}
}'
ResponseClear