Light Mode

Update Brand

PUT/brands/{brand}

Last modified: 15 days ago

This endpoint allows you to update brand details by passing the brand as a path parameter.

:::info[Information]

All variables in the Update Brand body request are optional.
Updating one variable at a time is possible, but at least one of the variables must be in the body request payload. Otherwise, an error will be shown if you send an empty body request payload.
:::

`brands.read_write`- Brands Read & Write

Request

Authorization

Inherited from project

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Path Params

brand

integer

required

Unique identifier assigned to the Brand. List of Brand IDs can be found here

name

string

required

logo

string

required

banner

string

required

description

string

required

metadata_title

string

required

metadata_description

string

required

metadata_url

string

required

translations

object

required

object

required

{
    "name": "ابل",
    "logo": "",
    "banner": "",
    "description": "شركه ابل",
    "metadata_title": "ابل",
    "metadata_description": "شركه ابل",
    "metadata_url": "apple",
    "translations": {
        "en": {
            "name": "Apple",
            "description": "Apple brand",
            "metadata_title": "Apple",
            "metadata_description": "Apple brand",
            "metadata_url": "apple",
        }
    }
}

Request samples

Responses

Brand details updated successfully.(201)

Record Not Found(404)

Error Validation(422)

Unauthorized(401)

Brand details updated successfully.

HTTP Code: 201

Content Type : JSONapplication/json

status

number

optional

Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.

success

boolean

optional

Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.

data

#/definitions/1307297

optional

{
  "success": true,
  "status": 200,
  "data": {
    "id": 883017162,
    "name": "بربري",
    "description": "بربري",
    "banner": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
    "logo": "https://i.ibb.co/jyqRQfQ/avatar-male.webp",
    "ar_char": "ب",
    "en_char": "b",
    "metadata": {
      "title": "Zara brand",
      "description": "Brand awareness seo",
      "url": "zara/item"
    }
  }
}

Last modified: 15 days ago