Brand Kit
Brand Kit serves as a centralized repository for your organization's brand identity and guidelines, offering a comprehensive array of product details and overall brand persona. By using the API requests, you can create, view, update, and delete one or more Brand Kits.
Get All Brand Kits
https://brand-kits-api.contentstack.com/v1/brand-kits?skip={skip}&limit={limit}&include_users={boolean}&include_count={boolean}&include_voice_profiles_count={boolean}&typeahead={string}The Get All Brand Kits request fetches the list of all the Brand Kits in an organization.
To configure the permissions for your application via OAuth, include the brand-kits:read scope.
{
"brand_kits": [
{
"uid": "cs***********0",
"name": "AI Blogs",
"description": "Brand Kit for AI related Blogs",
"created_at": "2024-04-26T07:56:35.584Z",
"created_by": "bl**************b",
"updated_at": "2024-04-26T08:27:13.974Z",
"updated_by": "bl**************b",
"deleted_at": false,
"api_keys": [
"bl**************7",
"bl**************5"
],
"organization_uid": "bl***************9"
}
]
}Get a Single Brand Kit
https://brand-kits-api.contentstack.com/v1/brand-kits/{brand_kit_uid}The Get a Single Brand Kit request fetches the details of a specific Brand Kit in an organization.
To configure the permissions for your application via OAuth, include the brand-kits:read scope.
{
"brand_kit": {
"uid": "cs***********40",
"name": "AI Blogs",
"description": "Brand Kit for AI related Blogs",
"created_at": "2024-04-26T07:56:35.584Z",
"created_by": "bl****************b",
"updated_at": "2024-04-26T08:27:13.974Z",
"updated_by": "bl****************b",
"deleted_at": false,
"api_keys": [
"bl*************7",
"bl*************5"
],
"organization_uid": "bl**************9"
}
}Create Brand Kit
https://brand-kits-api.contentstack.com/v1/brand-kitsThe Create Brand Kit request lets you create a new Brand Kit in the specified organization.
To configure the permissions for your application via OAuth, include the brand-kits:manage scope.
Here’s an example of the Request Body for creating a new Brand Kit:
{
"brand_kit": {
"name": "Sample Brand Kit",
"description": "This is a sample Brand Kit created for testing",
"api_keys": [
"bxxxxxxxxxxxx9",
"bxxxxxxxxxxxx9"
]
}
}{
"brand_kit": {
"name": "Test Brand Kit",
"description": "Brand Kit for testing",
"api_keys": [
"xxxxxxxxxxxx"
]
}
}{
"message": "Brand Kit created successfully",
"brand_kit": {
"uid": "cs4**********0",
"name": "Test Brand Kit",
"description": "Brand Kit for testing",
"created_at": "2024-05-09T13:17:15.200Z",
"created_by": "bxxxxxxxxxxxxb",
"updated_at": "2024-05-09T13:17:15.200Z",
"updated_by": "bxxxxxxxxxxxxb",
"deleted_at": false,
"api_keys": [
"xxxxxxxxxxxx"
],
"organization_uid": "bxxxxxxxxxxxx9"
}
}Update Brand Kit
https://brand-kits-api.contentstack.com/v1/brand-kits/{brand_kit_uid}The Update Brand Kit request lets you update an existing Brand Kit in an organization.
To configure the permissions for your application via OAuth, include the brand-kits:manage scope.
Here’s an example of the Request Body that you can use to update a Brand Kit:
{
"brand_kit": {
"name": "Sample Brand Kit",
"description": "This is the updated description for Sample Brand Kit",
"api_keys": [
"bxxxxxxxxxxxx9"
]
}
}{
"brand_kit": {
"name": "Sample Brand Kit",
"description": "This is the updated description for Sample Brand Kit",
"api_keys": [
"b**********9"
]
}
}{
"message": "Brand Kit updated successfully",
"brand_kit": {
"uid": "cs************0",
"name": "Sample Brand Kit",
"description": "This is the updated description for Sample Brand Kit",
"created_at": "2024-05-09T13:17:15.200Z",
"created_by": "bl**************b",
"updated_at": "2024-05-09T13:17:15.200Z",
"updated_by": "bl**************b",
"deleted_at": false,
"api_keys": [
"b**********9",
"b**********9"
],
"organization_uid": "bl************9"
}
}Delete Brand Kit
https://brand-kits-api.contentstack.com/v1/brand-kits/{brand_kit_uid}The Delete Brand Kit request lets you delete an existing Brand Kit in an organization.
To configure the permissions for your application via OAuth, include the brand-kits:manage scope.
{
"message": "Brand Kit deleted successfully"
}