put

/catalog/brands/{brand_id}

Updates a Brand.

Required Fields

  • None

Read-Only Fields

  • id

To update a Brand Image, send a request with an image_url.

Authorization

apiKey - X-Auth-Client
apiKey - X-Auth-Token

Request Parameters

1 Path Parameter
2 Headers

Request Body

2 Examples
Schema
object

Common Brand properties.

id
integer

Unique ID of the Brand. Read-Only.

name
string

The name of the brand. Must be unique. Required in POST.

4 validations + required
page_title
string

The title shown in the browser while viewing the brand.

3 validations
meta_keywords
array[string]

Comma-separated list of meta keywords to include in the HTML.

1 validation
meta_description
string

A meta description to include.

3 validations
search_keywords
string

A comma-separated list of keywords that can be used to locate this brand.

3 validations
image_url
string

Image URL used for this category on the storefront. Images can be uploaded via form file post to /brands/{brandId}/image, or by providing a publicly accessible URL in this field.

2 validations
custom_url
object

The custom URL for the brand on the storefront.

Responses

1 Example
Schema
object

Brand Response returns for:

  • Create Brand
  • Get Brand by Id
  • Update Brand by Id
data
object

Common Brand properties.

meta
object

Empty meta object; may be used later.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
brand_id
$$.env
2 variables not set
store_hash
X-Auth-Client
X-Auth-Token