post https://api.pictory.ai/pictoryapis/v1/brands/editvideo
Request Body
Parameter Name | Parameter Type | Description |
---|---|---|
name | Text (Required) | Name of the Brand. |
description | Text (Optional) | Brand Description |
color | Object | Color object shall contain the primary color details of your brand. |
font | Object | Font Object shall contain the font details about your brand. |
button | Object | Button object contains the customization of the Edit page. |
//Sample request Object
{
"name": "My App Branding",
"description": "My Brand Description",
"color": {
"primary": {
"main": "#BA0E1C",
"light": "#F2F2F2",
"contrastText": "#F9F9F9"
}
},
"font": {
"family": "Party Confetti",
"format": "truetype",
"url": "https://pictory-static.pictorycontent.com/static/fonts/Party_Confetti/Party_Confetti.ttf"
},
"button":{
"notificationBell":{
"visible": true
},
"downloadVideo":{
"visible": true
}
}
}
Brand Color
Parameter Name | Parameter Type | Description |
---|---|---|
main | Text (Required) | The main color of your brand. Acceptable value: Hex-Code |
light | Text (Required) | The lighter shade of your brand color. Acceptable value: Hex-Code. e.g.: #FFFFFF |
contrastText | Text (Required) | Contrast Text color to be used with your main brand color. Acceptable value: Hex-Code. e.g.: #FFFFFF |
dark | Text (Required) | Darker Shade of your brand color. Acceptable value: Hex-Code. e.g.: #FFFFFF |
//e.g. Brand Color Object
color": {
"primary": {
"main": "#BA0E1C",
"light": "#F2F2F2",
"contrastText": "#F9F9F9",
"dark": "BA0E1C"
}
}
Brand Font
Parameter Name | Parameter Type | Description |
---|---|---|
family | Text (Required) | Name of the Font. e.g. Arial, Calibri. The supported Font list is mentioned here. |
url | Text (Optional) | Provide the url of the font (In case the Pictory does not support your brand font) |
format | Choice (Optional) | Type of the font. Pass this value only if you are providing custom font url e.g: truetype |
//e.g Font Object
"font": {
"family": "Party Confetti",
"format": "truetype",
"url": "https://pictory-static.pictorycontent.com/static/fonts/Party_Confetti/Party_Confetti.ttf"
}
Customize Buttons on the Video Summary Page
//e.g Button Object
"button": {
"downloadVideo": {
"visible": true
},
"notificationBell": {
"visible": false
},
"autoHighlight": {
"visible": true
}
},
"contextMenu": {
"downloadVideo": {
"visible": false,
},
},
"tab": {
"highlight": {
"label": "My Selected Clips"
}
}