Entity1

Represents a single entity within an entity set.

Entities are flexible objects used to store domain-specific data like authorized sellers, store locations, or partner information. They support external IDs, alternative titles for matching, and localization for multi-market deployments.

Kind	Type
Used in	UpdateEntities1

Properties

• bhid bubbleflake optional

  Bubblehouse-assigned unique identifier

  This is an internal Bubblehouse identifier. It is returned when reading entities but should not be sent when creating or updating.

• id string optional

  External identifier from your system

  Your system's unique identifier for this entity. External IDs are unique within an entity set.

  When updating an entity, the external ID is the primary lookup key. If you initially create entities by title only, you can assign an external ID later to enable more reliable identification.

• title string required when creating

  Primary display title of the entity

  The main human-readable name for this entity. Titles are unique within an entity set for entities that do not have an external ID.

  When no external ID is provided, the title is used as the lookup key to find existing entities.

• alt_titles array of string optional

  Alternative titles for matching

  Additional names or variations that should also match this entity. Useful for entities with multiple common names or abbreviations.

  For example, an authorized dealer might have alt_titles like ["Wal-Mart", "Walmart Supercenter"] in addition to the primary title "Walmart".

• props object optional

  Custom properties for the entity

  An arbitrary key-value object for storing entity-specific data. The structure depends on your use case.

  When updating, passing null or omitting this field preserves existing props. Pass an object to replace all props.

• venues array of string optional

  Venue slugs this entity is restricted to

  List of venue slugs (not IDs) that this entity applies to. An empty array means the entity applies to all venues.

  Venue slugs are resolved at update time. Unknown slugs are silently ignored with a warning logged.

• markets array of string optional

  Market identifiers this entity is restricted to

  List of market identifiers (like "en-US", "en-GB") that this entity applies to. An empty array means the entity applies to all markets.

  Use this to create region-specific entities, such as authorized dealers that only operate in certain countries.

• localizations map of EntityLocalization1 optional

  Market-specific titles and properties

  A map from market identifier to localized content for that market. Allows entities to have different titles and alternative titles in different markets.

  When updating entities:

  • null (or omitted) preserves all existing localizations
  • Empty object {} clears all localizations
  • Non-empty object replaces the full set - markets not included will be removed
• deleted boolean optional

  Set to true to delete this entity in our system

  Bubblehouse does not have deletion APIs for most objects; instead, pass deleted: true when updating an object. Note that we won't delete the data immediately, in case there are other objects referencing this one.