retrieve-booking-custom-attribute-definition-response.md

Retrieve Booking Custom Attribute Definition Response

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

Structure

RetrieveBookingCustomAttributeDefinitionResponse

Fields

Name	Type	Tags	Description
customAttributeDefinition	CustomAttributeDefinition | undefined	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	Error[] | undefined	Optional	Any errors that occurred during the request.

Example (as JSON)

{
  "custom_attribute_definition": {
    "created_at": "2022-11-16T15:27:30Z",
    "description": "The favorite shampoo of the customer.",
    "key": "favoriteShampoo",
    "name": "Favorite shampoo",
    "schema": {
      "key1": "val1",
      "key2": "val2"
    },
    "updated_at": "2022-11-16T15:27:30Z",
    "version": 1,
    "visibility": "VISIBILITY_READ_WRITE_VALUES"
  },
  "errors": []
}