action vtex_post_api_catalog_pvt_brand { label: "Create Brand" description: "Creates a new Brand. \n## Request and response body example \n \n```json \n{ \n \"Id\": 2000013, \n \"Name\": \"Orma Carbon\", \n \"Text\": \"Orma Carbon\", \n \"Keywords\": \"orma\", \n \"SiteTitle\": \"Orma Carbon\", \n \"Active\": true, \n \"MenuHome\": true, \n \"AdWordsRemarketingCode\": \"\", \n \"LomadeeCampaignCode\": \"\", \n \"Score\": null, \n \"LinkId\": \"orma-carbon\" \n} \n```" provider: vtex method: POST path: "/api/catalog/pvt/brand" encoding: json input: { type: "object" properties: { Accept: { type: "string" } Active: { type: "boolean" description: "Defines if the brand is active (`true`) or not (`false`)." } AdWordsRemarketingCode: { type: "string" description: "This is a legacy field. Do not take this information into consideration." } "Content-Type": { type: "string" } Id: { type: "integer" description: "Brand's unique numerical identifier." } Keywords: { type: "string" description: "Store Framework - Deprecated. \nLegacy CMS Portal - Alternative search terms that will lead to the specific brand. The user can find the desired brand even when misspelling it. Used especially when words are of foreign origin and have a distinct spelling that is transcribed into a generic one, or when small spelling mistakes occur. \n" } LinkId: { type: "string" description: "Brand page slug. Only lowercase letters and hyphens (`-`) are allowed." } LomadeeCampaignCode: { type: "string" description: "This is a legacy field. Do not take this information into consideration." } MenuHome: { type: "boolean" description: "Store Framework - Deprecated. \nLegacy CMS Portal - Defines if the Brand appears in the Department Menu control (``). \n" } Name: { type: "string" description: "Brand name." } Score: { type: "integer" description: "Store Framework - Deprecated \nLegacy CMS Portal - Value used to set the priority on the search result page. \n" } SiteTitle: { type: "string" description: "Meta Title for the Brand page." } Text: { type: "string" description: "Meta Description for the Brand page. A brief description of the brand, displayed by search engines. Since search engines can only display less than 150 characters, we recommend not exceeding this character limit when creating the description." } } required: ["Accept", "Content-Type", "Id", "Name"] additionalProperties: false } output: { type: "object" description: "Object containing Brand information." required: ["Id", "Name"] properties: { Active: { type: "boolean" description: "Defines if the brand is active (`true`) or not (`false`)." } AdWordsRemarketingCode: { type: "string" description: "This is a legacy field. Do not take this information into consideration." } Id: { type: "integer" description: "Brand's unique numerical identifier." } Keywords: { type: "string" description: "Store Framework - Deprecated. \nLegacy CMS Portal - Alternative search terms that will lead to the specific brand. The user can find the desired brand even when misspelling it. Used especially when words are of foreign origin and have a distinct spelling that is transcribed into a generic one, or when small spelling mistakes occur. \n" } LinkId: { type: "string" description: "Brand page slug. Only lowercase letters and hyphens (`-`) are allowed." } LomadeeCampaignCode: { type: "string" description: "This is a legacy field. Do not take this information into consideration." } MenuHome: { type: "boolean" description: "Store Framework - Deprecated. \nLegacy CMS Portal - Defines if the Brand appears in the Department Menu control (``). \n" } Name: { type: "string" description: "Brand name." } Score: { type: "integer" description: "Store Framework - Deprecated \nLegacy CMS Portal - Value used to set the priority on the search result page. \n" } SiteTitle: { type: "string" description: "Meta Title for the Brand page." } Text: { type: "string" description: "Meta Description for the Brand page. A brief description of the brand, displayed by search engines. Since search engines can only display less than 150 characters, we recommend not exceeding this character limit when creating the description." } } } }