brands
Get brand metadata
Given a brand type in a query param, this endpoint returns the metadata required to build the brand registration form. The metadata is based on different brand categories that contain different set of attributes. Each attribute comes with its own set of validation rules.
get/v1/projects/{projectId}/brand-metadata
Path parameters
projectIdstring required
Customer's project id
Query parameters
brandType'US_SHORT_CODE_REGISTRY' enum required
Example:US_SHORT_CODE_REGISTRY
The brand type for which the metadata is requested.
Response
Successfully retrieved Brand Metadata
Example response
{
"brandMetadataId": "4444444444",
"brandType": "US_SHORT_CODE_REGISTRY",
"marketCode": "US",
"majorVersion": 1,
"createTime": "2023-10-01 12:00:00+00:00",
"data": [
{
"categoryType": "BRAND_CLIENT_ADDRESS",
"title": "Address Information",
"attributes": [
{
"description": "Street Address must be a valid address in United States.",
"title": "Address Line 1",
"required": true,
"type": "string",
"maxLength": 11,
"minLength": 3,
"name": "address1",
"pattern": "^[+][0-9]+$",
"message": {
"pattern": "The number needs to start with country code. For example +1",
"maxLength": "Address value length must be less than 100 characters",
"minLength": "Address value length must be greater than 3 characters",
"minItems": "You must select at least 1 item from the list"
},
"items": {
"type": "string",
"enum": [
"value1",
"value2"
]
},
"minItems": 1,
"multiline": true
}
]
}
]
}