POST /catalog/brands

Creates a brand.

Required Fields

Limits

Servers

Request headers

Name Type Required Description
Accept String Yes

The MIME type of the response body.

Default value: "application/json"

Content-Type String Yes

The MIME type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
meta_keywords[] Array No

An array of meta keywords to include in the HTML.

name String Yes

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

page_title String No

The title shown in the browser while viewing the brand.

meta_description String No

A meta description to include.

custom_url Object No

The custom URL for the brand on the storefront. If not provided, the URL will be autogenerated from the brand name.

custom_url.url String No

Brand URL on the storefront. Only letters, numbers, dots (.), dashes (-), underscores (_), and forward slashes (/) are allowed. Must be 1-1024 characters, consisting of segments divided by "/". Each segment must be 1-256 characters.

custom_url.is_customized Boolean No

Returns true if the URL has been changed from its default state (the auto-assigned URL that BigCommerce provides).

search_keywords String No

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

image_url String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.