Skip to main content
PATCH
/
brands
/
{brandId}
Update a brand.
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 '
{
  "name": "Head & Shoulders",
  "image": {
    "id": 0,
    "url": "https://images.aasaan.app/123412421",
    "type": "image/png"
  },
  "slug": "head_shoulders",
  "description": "Head & Shoulders",
  "hide": false,
  "displayOrder": 0,
  "active": "true"
}
'
{
  "id": "623d3455ec3c4b3548eb4a322",
  "name": "Head & Shoulders",
  "slug": "head_shoulders",
  "description": "Head & Shoulders",
  "hide": false,
  "displayOrder": 0,
  "active": "true",
  "image": {
    "id": 0,
    "url": "https://images.aasaan.app/123412421",
    "type": "image/png"
  },
  "date_created": "2022-03-25T03:17:44.092Z",
  "date_modified": "2022-06-10T07:51:12.510Z"
}

Documentation Index

Fetch the complete documentation index at: https://help.aasaan.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
brandId
string
required

Brand id

Body

application/json
​
name
string
required

Name

Example:

"Head & Shoulders"

​
image
object
required

Brand image

​
slug
string

Slug

Example:

"head_shoulders"

​
description
string

Head & Shoulders brand

Example:

"Head & Shoulders"

​
hide
boolean

Hide a brand

Example:

false

​
displayOrder
string

Display order

Example:

0

​
active
boolean

Activate the brand

Example:

"true"

Response

Brand updated.

​
id
string

Unique identifier for the resource

Example:

"623d3455ec3c4b3548eb4a322"

​
name
string

Name

Example:

"Head & Shoulders"

​
slug
string

Slug

Example:

"head_shoulders"

​
description
string

Head & Shoulders brand

Example:

"Head & Shoulders"

​
hide
boolean

Hide a brand

Example:

false

​
displayOrder
string

Display order

Example:

0

​
active
boolean

Activate the brand

Example:

"true"

​
image
object

Brand image

​
date_created
string

Created date

Example:

"2022-03-25T03:17:44.092Z"

​
date_modified
string

Modified date

Example:

"2022-06-10T07:51:12.510Z"