create-merchant-custom-attribute-definition-response.md

Create Merchant Custom Attribute Definition Response

Represents a CreateMerchantCustomAttributeDefinition response. Either custom_attribute_definition or errors is present in the response.

Structure

Create Merchant Custom Attribute Definition Response

Fields

Name	Type	Tags	Description
custom_attribute_definition	Custom Attribute Definition Hash	Optional	Represents a definition for custom attribute values. A custom attribute definition specifies the key, visibility, schema, and other properties for a custom attribute.
errors	Array<Error Hash>	Optional	Any errors that occurred during the request.

Example (as JSON)

{
  "custom_attribute_definition": {
    "created_at": "2023-05-05T19:06:36.559Z",
    "description": "This is the other name this merchant goes by.",
    "key": "alternative_seller_name",
    "name": "Alternative Merchant Name",
    "schema": {
      "key1": "val1",
      "key2": "val2"
    },
    "updated_at": "2023-05-05T19:06:36.559Z",
    "version": 1,
    "visibility": "VISIBILITY_READ_ONLY"
  },
  "errors": [
    {
      "category": "MERCHANT_SUBSCRIPTION_ERROR",
      "code": "MAP_KEY_LENGTH_TOO_LONG",
      "detail": "detail6",
      "field": "field4"
    }
  ]
}