Skip to main content
PUT
/
commerce
/
customer
/
accountattributedefinition
/
attributes
/
{attributeFQN}
Error
A valid request URL is required to generate request examples
{
  "attributeCode": "<string>",
  "valueType": "<string>",
  "displayGroup": "<string>",
  "id": 123,
  "adminName": "<string>",
  "namespace": "<string>",
  "inputType": "<string>",
  "dataType": "<string>",
  "attributeMetadata": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "attributeFQN": "<string>",
  "content": {
    "localeCode": "<string>",
    "value": "<string>"
  },
  "validation": {
    "regularExpression": "<string>",
    "minStringLength": 123,
    "maxStringLength": 123,
    "minNumericValue": 123,
    "maxNumericValue": 123,
    "minDateTime": "2023-11-07T05:31:56Z",
    "maxDateTime": "2023-11-07T05:31:56Z"
  },
  "vocabularyValues": [
    {
      "value": "<string>",
      "sequence": 123,
      "isHidden": true,
      "content": {
        "localeCode": "<string>",
        "value": "<string>"
      }
    }
  ],
  "auditInfo": {
    "updateDate": "2023-11-07T05:31:56Z",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "createBy": "<string>"
  },
  "isActive": true,
  "isRequired": true,
  "isReadOnly": true,
  "isMultiValued": true,
  "isVisible": true,
  "order": 123,
  "availableForOrderRouting": true,
  "availableForDiscounts": true
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

attributeFQN
string
required

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json
attributeCode
string
required
Maximum string length: 50
valueType
string
required
displayGroup
string
required
id
integer<int32> | null
adminName
string | null
Maximum string length: 50
namespace
string | null
Maximum string length: 200
inputType
string | null
dataType
string | null
attributeMetadata
object[] | null
attributeFQN
string | null
content
object
validation
object
vocabularyValues
object[] | null
auditInfo
object
isActive
boolean | null
isRequired
boolean | null
isReadOnly
boolean
isMultiValued
boolean | null
isVisible
boolean | null
order
integer<int32> | null
availableForOrderRouting
boolean
availableForDiscounts
boolean

Response

Success

attributeCode
string
required
Maximum string length: 50
valueType
string
required
displayGroup
string
required
id
integer<int32> | null
adminName
string | null
Maximum string length: 50
namespace
string | null
Maximum string length: 200
inputType
string | null
dataType
string | null
attributeMetadata
object[] | null
attributeFQN
string | null
content
object
validation
object
vocabularyValues
object[] | null
auditInfo
object
isActive
boolean | null
isRequired
boolean | null
isReadOnly
boolean
isMultiValued
boolean | null
isVisible
boolean | null
order
integer<int32> | null
availableForOrderRouting
boolean
availableForDiscounts
boolean