Update Product Brand

The Payiano update product brand endpoint is essential for maintaining the accuracy and relevancy of brand information within a business's catalog. As brands evolve—whether through changes in their product lines, target demographics, or brand positioning—this endpoint ensures that businesses can reflect these changes in their systems promptly. Updating brand information is key to ensuring consistency across marketing, sales, and customer service channels, enabling businesses to present a cohesive and current brand image to their customers.

This endpoint also plays a pivotal role in strategic brand management. By allowing businesses to modify brand details, it supports the repositioning of brands, alignment with new market trends, and refinement of target consumer segments. Such adaptability is indispensable for keeping pace with the dynamic nature of the marketplace, ensuring that businesses can effectively communicate the value and uniqueness of their brands to their target audience.

In the Payiano system, it's important to note a key operational rule regarding record updates. If a product brand record has been soft deleted, without being permanently removed from the database, any updates to this record are forbidden. This restriction ensures data integrity and consistency, as modifying a soft-deleted record could lead to confusion or inaccuracies in the system management.

To update a soft-deleted product brand, the record must first be restored. Restoration reverts the record's deleted status, making it once again eligible for updates and modifications. This policy is crucial for maintaining a clear and accurate representation of the product brand record, while still retaining the flexibility to recover and revise previously soft-deleted product brand as needed. By enforcing this rule, the Payiano system ensures a streamlined and coherent management process, balancing flexibility with control.

PUT/product_brands/{id}
Sandbox: https://api.payiano.dev/v1/product_brands/{id}
Live: https://api.payiano.com/v1/product_brands/{id}
Security
  • Authorization header with access token is required to access this endpoint: Bearer ACCESS-TOKEN
  • Your access token should be associated to this permission product_brands_update
Request
Request body schema:
application/json
Path parameters:
id
required
Type: ulid
Length: 26

The unique ID assigned to each product brand which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every product brand. This ULID is automatically created by our system and is used to uniquely identify and track each product brand in our database.

Query parameters:
identify_by
Type: enum|null
Possible values:
[
"id", "reference_id" ]

This attribute specifies which identifier is being used to interact with a resource in the Payiano API. It helps the system understand how to identify resource when processing API requests. By default, the identify_by attribute is set to id, so you only need to specify it if you're using a different identifier.

includes
Type: array_of_enums|null
Possible values:
[
"product_brand.products_count", "product_brand.metadata" ]

A list of additional product brand relations to return, if available. Feel free to send the relations you would like to return with every item. See Including Resources to better understand how this is working.

Request body:
name
Type: string
Min: 1
Max: 255

This attribute represents the official name of the brand. This is the name that is displayed to customers and used in all marketing materials. It is crucial for identifying the brand across the business's platforms and channels. The brand name is often the first point of contact between the brand and potential customers, making it a significant component of the brand's identity and perception in the marketplace. Please notice that duplicate values are not allowed.

is_active
Type: boolean
Default: true

This value indicates whether the product brand is active or not. This flag can be used to control the product brand's availability in runtime environments or listings without deleting or removing the product brand from records. A true value means the product brand is active and functioning, while a false value implies that the product brand is deactivated or not in use.

reference_id
Type: string|null
Max: 50

It's a unique identifier assigned to each product brand. It's primary role is to distinguish one product brand from another, ensuring that each product brand can be individually tracked and managed without any confusion. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_]. The reference_id value is used to Identify Resource when you consume any product brand endpoint with sending identify_by query parameter with value reference_id.

slug
Type: string
Min: 1
Max: 255

This attribute is a URL-friendly version of the brand name. It's used in the web address to help users and search engines find the brand page easily. For instance, if you have a brand named "Asfour Crystal" the slug might be "asfour-crystal". It's a simplified version of the name and without spaces. Slugs are important for website navigation and SEO . A well-crafted slug makes it easier for customers to remember and type the URL, and it helps improve the brand's visibility in search engine results. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_]. If the slug value is not provided, the Payiano system automatically generates one based on the provided name attribute. This auto-generation of the slug ensures consistency and convenience, eliminating the need for manual slug entry.

description
Type: string|null
Min: 1
Max: 10000

This attribute provides more detailed information about the product brand. It's like a brief paragraph that explains what the brand is about and what it includes. This attribute is important because it gives context and depth to the brand name, offering users a clearer understanding of what's included and potentially the types of customers the brand is aimed at. A good description can also help in search optimization, making it easier for customers to find what they're looking for through search engines.

metadata
Type: object|null

The product brand metadata model details. Metadata serves as a tool for keeping extra, organized details about a resource. For example, you can use it to store a user's preferences like prefered color, notes or any other data that aids in personalizing services, improving customer relations, or optimizing internal workflows. This information isn't utilized by Payiano – meaning it's not involved in authorizing or declining transactions and remains invisible to your users. Its value is entirely private for your internal use, and we ensure it remains confidential, not shared with any external parties.

info
Type: array_of_objects
Max: 50

This array consists of objects, each containing a key and a value. These pairs of key-value are structured in a way that's more suitable for programmatic access. You can add up to 50 objects.

key
required
Type: string
Min: 1
Max: 50

It's a unique identifier to avoid confusion or data overlap. The keys serve as identifiers for the corresponding values, making it easier to retrieve specific pieces of information as needed.

value
required
Type: string
Min: 1
Max: 255

The value is the actual data associated with that key. It could be a simple string, a number, a URL, or any other data format that conveys the necessary information.

list
Type: array_of_strings
Max: 50

The list attribute is particularly useful for scenarios where the data needs to be presented in a straightforward, unstructured format. It's ideal for quick overviews, simple data logging, or when the information does not require the more complex organization that nested JSON objects provide. Please notice that duplicate values are not allowed, you can add up to 50 item and the max list item length is 255 characters.

Response
200
Response schema:
application/json
Response body:
product_brand
Type: object

The product brand model details.

id
Type: ulid
Length: 26

The unique ID assigned to each product brand which is generated by our system using the ULID format. Each ID is precisely 26 characters long, ensuring a unique and consistent identifier for every product brand. This ULID is automatically created by our system and is used to uniquely identify and track each product brand in our database.

name
Type: string
Min: 1
Max: 255

This attribute represents the official name of the brand. This is the name that is displayed to customers and used in all marketing materials. It is crucial for identifying the brand across the business's platforms and channels. The brand name is often the first point of contact between the brand and potential customers, making it a significant component of the brand's identity and perception in the marketplace. Please notice that duplicate values are not allowed.

is_active
Type: boolean
Default: true

This value indicates whether the product brand is active or not. This flag can be used to control the product brand's availability in runtime environments or listings without deleting or removing the product brand from records. A true value means the product brand is active and functioning, while a false value implies that the product brand is deactivated or not in use.

reference_id
Type: string|null
Max: 50

It's a unique identifier assigned to each product brand. It's primary role is to distinguish one product brand from another, ensuring that each product brand can be individually tracked and managed without any confusion. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_]. The reference_id value is used to Identify Resource when you consume any product brand endpoint with sending identify_by query parameter with value reference_id.

slug
Type: string
Min: 1
Max: 255

This attribute is a URL-friendly version of the brand name. It's used in the web address to help users and search engines find the brand page easily. For instance, if you have a brand named "Asfour Crystal" the slug might be "asfour-crystal". It's a simplified version of the name and without spaces. Slugs are important for website navigation and SEO . A well-crafted slug makes it easier for customers to remember and type the URL, and it helps improve the brand's visibility in search engine results. Please notice that duplicate values are not allowed and it's allowed to use alpha dash only [A-Za-z0-9-_]. If the slug value is not provided, the Payiano system automatically generates one based on the provided name attribute. This auto-generation of the slug ensures consistency and convenience, eliminating the need for manual slug entry.

description
Type: string|null
Min: 1
Max: 10000

This attribute provides more detailed information about the product brand. It's like a brief paragraph that explains what the brand is about and what it includes. This attribute is important because it gives context and depth to the brand name, offering users a clearer understanding of what's included and potentially the types of customers the brand is aimed at. A good description can also help in search optimization, making it easier for customers to find what they're looking for through search engines.

is_deleted
Type: boolean
Default: false

This value indicates whether the product brand is deleted or not. This flag can be used to control the product brand's availability in runtime without actual deleting or removing the product brand from records. A true value means the product brand is deleted, while a false value implies that the product brand is not deleted and functioning.

products_count
Type: integer

This attribute represents the total number of products that directly fall under a specific product brand. This is a numerical value that provides immediate insight into the size and scope of each brand.

metadata
Type: object|null

The product brand metadata model details. Metadata serves as a tool for keeping extra, organized details about a resource. For example, you can use it to store a user's preferences like prefered color, notes or any other data that aids in personalizing services, improving customer relations, or optimizing internal workflows. This information isn't utilized by Payiano – meaning it's not involved in authorizing or declining transactions and remains invisible to your users. Its value is entirely private for your internal use, and we ensure it remains confidential, not shared with any external parties.

info
Type: array_of_objects
Max: 50

This array consists of objects, each containing a key and a value. These pairs of key-value are structured in a way that's more suitable for programmatic access. You can add up to 50 objects.

key
Type: string
Min: 1
Max: 50

It's a unique identifier to avoid confusion or data overlap. The keys serve as identifiers for the corresponding values, making it easier to retrieve specific pieces of information as needed.

value
Type: string
Min: 1
Max: 255

The value is the actual data associated with that key. It could be a simple string, a number, a URL, or any other data format that conveys the necessary information.

list
Type: array_of_strings
Max: 50

The list attribute is particularly useful for scenarios where the data needs to be presented in a straightforward, unstructured format. It's ideal for quick overviews, simple data logging, or when the information does not require the more complex organization that nested JSON objects provide. Please notice that duplicate values are not allowed, you can add up to 50 item and the max list item length is 255 characters.

created_at
Type: datetime

The created datetime of the product brand. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

updated_at
Type: datetime

The updated datetime of the product brand. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

deleted_at
Type: datetime|null

The deleted datetime of the product brand. This attribute can be formatted as an ISO 8601 string or a UNIX timestamp in milliseconds, depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or 1722572118554). By default, the format is UNIX timestamp in milliseconds.

Response sample:
1
{
2
"product_brand": {
3 "id": "01htcy6rwpcjn56ys9p1f37ans", 4 "name": "Asfour Crystal", 5 "slug": "asfour-crystal", 6 "description": "Utilizing the latest in technology to introduce its unlimited possibilities to transform dreams into impressive.", 7 "reference_id": "3e88d728-b647-3b34-bebc-88807f8a2d0b", 8 "is_active": true, 9 "is_deleted": false, 10 "products_count": 0, 11
"metadata": {
12
"info": [
13
{
14 "key": "Company name", 15 "value": "Pyngy" 16 } 17 ], 18
"list": [
19 "Cairo, Nasr City, 7th District, Building 12 floor 5" 20 ] 21 }, 22 "created_at": "1722572118554", 23 "updated_at": "1722572118554", 24 "deleted_at": null 25 } 26}