What problem does it solve?
Enables engineers to implement and operate Braze catalog CRUD workflows across synchronous and asynchronous endpoints, reducing silent failures, rate-limit errors, and inconsistent data states when working with items, fields, selections, and catalog lifecycle management.
Core Features & Use Cases
- Sync vs Async Guidance: Clear rules for choosing synchronous endpoints for real-time single-item operations and asynchronous endpoints for bulk operations and selections, plus polling/webhook patterns.
- Resource Management: Patterns for creating, listing, updating (upsert semantics), and deleting catalogs, fields, items, and selections with permission and rate-limit considerations.
- Selections & Personalization: How to design, create, preview, and use named selections as filtered views for message personalization, including limits and Liquid considerations.
- Troubleshooting & Error Handling: Mapped error IDs to remediation steps, common mistakes, and validation rules to avoid invalid requests and permission issues.
Quick Start
Create a catalog selection named favorite-restaurants for catalog restaurants with filters City equals NYC and Rating greater than 7, set results_limit to 10, and return the recommended API request, required permission, and follow-up polling strategy.