Update a Product Brand

The request body is a single object, not an array. The endpoint has no path parameter. The product brand to update is matched by the identifier in the request body.

curl -X PUT "https://connect.wholechain.com/Integration/Brand" \
  -H "Content-Type: application/json" \
  -H "X-API-KEY: example_string" \
  -H "accept: */*" \
  -d '{
  "identifier": "BRAND-001",
  "name": "Oceanic Brand (Updated)",
  "description": "Updated premium seafood brand"
}'

import requests
import json

url = "https://connect.wholechain.com/Integration/Brand"
headers = {
  "Content-Type": "application/json",
  "X-API-KEY": "example_string",
  "accept": "*/*"
}
data = {
  "identifier": "BRAND-001",
  "name": "Oceanic Brand (Updated)",
  "description": "Updated premium seafood brand"
}

response = requests.put(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://connect.wholechain.com/Integration/Brand", {
  method: "PUT",
  headers: {
  "Content-Type": "application/json",
  "X-API-KEY": "example_string",
  "accept": "*/*"
},
  body: JSON.stringify({
  "identifier": "BRAND-001",
  "name": "Oceanic Brand (Updated)",
  "description": "Updated premium seafood brand"
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "identifier": "BRAND-001",
  "name": "Oceanic Brand (Updated)",
  "description": "Updated premium seafood brand"
}`)

    req, err := http.NewRequest("PUT", "https://connect.wholechain.com/Integration/Brand", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("X-API-KEY", "example_string")
    req.Header.Set("accept", "*/*")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://connect.wholechain.com/Integration/Brand')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Put.new(uri)
request['Content-Type'] = 'application/json'
request['X-API-KEY'] = 'example_string'
request['accept'] = '*/*'
request.body = '{
  "identifier": "BRAND-001",
  "name": "Oceanic Brand (Updated)",
  "description": "Updated premium seafood brand"
}'

response = http.request(request)
puts response.body

{
  "identifier": "BRAND-001",
  "name": "Oceanic Brand (Updated)",
  "description": "Updated premium seafood brand"
}

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "X-API-KEY": [
      "The apiKey field is required."
    ]
  },
  "traceId": "…"
}

PUT

/Integration/Brand

PUT

Base URLstring

Target server for requests. Edit to use your own host.

Content-Typestring

Required

The media type of the request body

Options: application/json

header

X-API-KEYstring

Required

Your Wholechain API key.

header

acceptstring

Response content type.

Options: */*

identifierstring

Required

Required. Identifies the product brand to update.

namestring

New name of the product brand.

descriptionstring

New description of the product brand.

Request Preview

Response

Response will appear here after sending the request

Responses

identifierstring

namestring

descriptionstring

Introduction

This API updates an existing product brand in Wholechain.

A product brand is a brand that can be assigned to your products.

A product references a brand through the productBrand object in the product Details. See Create a Product and Update a Product.

Endpoint

Method	URL
`PUT`	`https://connect.wholechain.com/Integration/Brand`

Request Headers

Header	Description	Example Value
`X-API-KEY`	Your Wholechain API key.	`<YOUR_API_KEY>`
`Content-Type`	Content type of the request. `application/json` and `application/xml` are accepted.	`application/json`
`accept`	Response content type.	`/`

Request Body

The request body is a single product brand object. It uses the same fields as Create a Product Brand.

Column Name	Data Type	Description	Required
`identifier`	STRING	Identifies the product brand to update.	Yes
`name`	STRING	New name of the product brand.	No
`description`	STRING	New description of the product brand.	No

Example Request

{
  "identifier": "BRAND-001",
  "name": "Oceanic Brand (Updated)",
  "description": "Updated premium seafood brand"
}

cURL

curl -X 'PUT' \
  'https://connect.wholechain.com/Integration/Brand' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY' \
  -d '{
    "identifier": "BRAND-001",
    "name": "Oceanic Brand (Updated)",
    "description": "Updated premium seafood brand"
  }'

Responses

200 — OK

The product brand is updated. The response body is a product brand object with the fields identifier, name, and description.

{
  "identifier": "BRAND-001",
  "name": "Oceanic Brand (Updated)",
  "description": "Updated premium seafood brand"
}

404 — Not Found

No product brand with this identifier exists.

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "title": "Product brand not found: BRAND-001",
  "status": 404,
  "traceId": "<trace-id>"
}

400 — Bad Request

The X-API-KEY header is missing, or the request body is not valid JSON.

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "X-API-KEY": [
      "The apiKey field is required."
    ]
  },
  "traceId": "<trace-id>"
}

Important Notes

The request body is a single object, not an array.
The endpoint has no path parameter. The product brand to update is matched by the identifier in the request body.
identifier is required.
In the Update a Product response, the brand assigned to a product is returned as productBrand (with id, name, description, externalIdentifier, and profileImagePreSignedUrl).

Was this page helpful?