Preset Properties

This table defines the structure of the preset entity, including all properties and their descriptions.

🔹 Core Properties

Property	Type	Required	Read-Only	Description	Example
id	string (UUID)	No	Yes	Unique identifier for the preset	"123e4567-e89b-12d3-a456-426614174001"
title	string	Yes	No	Title of the preset	"Video Streaming Preset"
description	string	No	No	Detailed description of the preset	"Configuration for video streaming applications"
organizationId	string (UUID)	No	Yes	Organization ID that owns the preset	"123e4567-e89b-12d3-a456-426614174002"
createdAt	date (ISO 8601)	No	Yes	Creation timestamp	"2025-05-28T10:15:30Z"
updatedAt	date (ISO 8601)	No	Yes	Last update timestamp	"2025-05-28T11:22:45Z"

🖼️ Visual Properties

Property	Type	Required	Read-Only	Description	Example
logo	string (URL)	No	No	URL to the preset logo	"https://example.com/logo.png"
image	string (URL)	No	No	URL to the preset cover image	"https://example.com/cover.png"

🔗 Related Resources

Property	Type	Required	Read-Only	Description	Example
assetIds	array of strings (UUIDs)	No	No	IDs of existing multimedia assets associated with this preset	["123e4567-e89b-12d3-a456-426614174003"]
assets	array of Multimedia	No	No	New multimedia assets to create with the preset (for POST and PUT requests only)	See multimedia properties
products	array of strings	No	No	Product identifiers associated with this preset	["product1", "product2"]
effectId	string	No	No	ID of the effect applied to this preset	"effect123"

🧩 Property Details

Core Properties

• id: A UUID that uniquely identifies the preset. This is automatically generated when the preset is created and cannot be modified.

• title: A descriptive name for the preset. This should be unique within your organization and clearly identify the purpose of the preset.

• description: A detailed explanation of what the preset is for, what settings it contains, and any other relevant information that helps users understand its purpose.

• organizationId: The UUID of the organization that owns this preset. This is automatically set based on your authentication credentials when the preset is created.

• createdAt: The timestamp when the preset was first created. This field is automatically set and cannot be modified.

• updatedAt: The timestamp when the preset was last modified. This field is automatically updated whenever any changes are made to the preset.

Visual Properties

• logo: A URL pointing to an image that serves as the preset's logo. This can be used in user interfaces to provide visual identification.

• image: A URL pointing to a cover image for the preset. This can be used as a background or featured image in user interfaces.

Related Resources

• assetIds: An array of UUIDs that reference existing multimedia assets in the system. These assets will be associated with the preset.

• assets: Used only during creation or update operations, this array contains new multimedia assets to be created and associated with the preset. See the Multimedia Properties documentation for details on asset structure.

• products: An array of product identifiers that this preset is associated with. This can be used to filter presets by product or to establish relationships between presets and products.

• effectId: A reference to a visual effect that should be applied to the preset's assets. The available effects depend on your organization's configuration.

📊 Property Usage Examples

Basic Preset

{
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "organizationId": "123e4567-e89b-12d3-a456-426614174002",
  "title": "Basic Streaming Preset",
  "description": "Standard configuration for video streaming",
  "createdAt": "2025-05-28T10:15:30Z",
  "updatedAt": "2025-05-28T10:15:30Z"
}

Complete Preset

{
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "organizationId": "123e4567-e89b-12d3-a456-426614174002",
  "title": "Premium Showcase Preset",
  "description": "High-quality configuration for product showcases",
  "logo": "https://example.com/premium-logo.png",
  "image": "https://example.com/premium-cover.png",
  "assets": [
    "123e4567-e89b-12d3-a456-426614174003",
    "123e4567-e89b-12d3-a456-426614174004"
  ],
  "products": [
    "premium-product-1",
    "premium-product-2"
  ],
  "effectId": "premium-effect-1",
  "createdAt": "2025-05-28T10:15:30Z",
  "updatedAt": "2025-05-28T11:22:45Z"
}

📘 Notes

• The combination of organizationId and title must be unique
• All timestamps are returned in ISO 8601 format with UTC timezone
• Asset and product relationships are managed through their respective ID arrays
• Visual properties (logo, image) should be valid URLs to publicly accessible resources
• When creating or updating presets, you can either reference existing assets using assetIds or create new ones using the assets array