PATCH
/
brands
/
{brandId}
curl --request PATCH \
  --url https://api.aasaan.shop/api/v1/stores/brands/{brandId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "active": "true",
  "description": "Head & Shoulders",
  "displayOrder": "<string>",
  "hide": true,
  "image": {
    "id": "<string>",
    "type": "image/png",
    "url": "https://images.aasaan.app/123412421"
  },
  "name": "Head & Shoulders",
  "slug": "head_shoulders"
}'
{
  "active": "true",
  "date_created": "2022-03-25T03:17:44.092Z",
  "date_modified": "2022-06-10T07:51:12.510Z",
  "description": "Head & Shoulders",
  "displayOrder": "<string>",
  "hide": true,
  "id": "623d3455ec3c4b3548eb4a322",
  "image": {
    "id": "<string>",
    "type": "image/png",
    "url": "https://images.aasaan.app/123412421"
  },
  "name": "Head & Shoulders",
  "slug": "head_shoulders"
}

Authorizations

x-api-key
string
headerrequired

Path Parameters

brandId
string
required

Brand id

Body

application/json
active
boolean

Activate the brand

description
string

Head & Shoulders brand

displayOrder
string

Display order

hide
boolean

Hide a brand

image
object
required

Brand image

name
string
required

Name

slug
string

Slug

Response

200 - application/json
active
boolean

Activate the brand

date_created
string

Created date

date_modified
string

Modified date

description
string

Head & Shoulders brand

displayOrder
string

Display order

hide
boolean

Hide a brand

id
string

Unique identifier for the resource

image
object

Brand image

name
string

Name

slug
string

Slug