UpdateEntities1

Creates or updates entities in a specified entity set.

Entities are flexible, low-overhead objects used to store domain-specific data like authorized sellers, store locations, or partner lists. Each entity belongs to an entity set, which defines the type and purpose of the entities within it.

Entity lookup: When processing each entity in the request, Bubblehouse uses a dual-lookup strategy to find existing entities: by id (if provided), and by title.

When replace_entities is true, any entities in the entity set that are not mentioned in this request will be marked as deleted. This is useful for full synchronization scenarios where you want the entity set to exactly match your source data.

This func will not return an error unless the entity set is not found or the request is malformed. Specific entity data does not undergo validation.

Input

• entity_set string required

  API name of the target entity set.

  Entity sets are configured by the Bubblehouse team and define the type of entities they contain. Each entity set has a unique API name that you use to reference it.

• entities array of Entity1 required

  Entities to create or update.

• replace_entities boolean optional

  Delete any entities not mentioned in this call.

  When true, entities in the target set that are not included in this request will be deleted. Use this for full synchronization where the provided list should be the complete set of active entities.

  When false (default), entities not in this request are left unchanged.

• debug boolean optional

  True to make it easier to debug this call

  Normally, we do not guarantee that updates are processed synchronously. We might do that, or we might return success from this function immediately and queue processing until a later time. Passing "debug": true ensures that processing is immediate and synchronous, and will also fail the call on any warnings, making it easier to diagnose problems.

  Please ensure to never enable debug mode in production, or even during high-volume testing.

Output

{"ok": true}

{
  "entities": [
    {
      "alt_titles": [
        "Wal-Mart",
        "Walmart Supercenter"
      ],
      "id": "dealer-001",
      "title": "Walmart"
    },
    {
      "alt_titles": [
        "Target Store"
      ],
      "id": "dealer-002",
      "title": "Target"
    }
  ],
  "entity_set": "authorized-dealers"
}

{
  "ok": true
}

{
  "entities": [
    {
      "id": "dealer-001",
      "title": "Walmart"
    },
    {
      "id": "dealer-003",
      "title": "Best Buy"
    }
  ],
  "entity_set": "authorized-dealers",
  "replace_entities": true
}

{
  "ok": true
}

{
  "entities": [
    {
      "id": "dealer-uk-001",
      "markets": [
        "en-GB"
      ],
      "title": "Tesco"
    },
    {
      "id": "dealer-us-001",
      "markets": [
        "en-US"
      ],
      "title": "Kroger"
    }
  ],
  "entity_set": "authorized-dealers"
}

{
  "ok": true
}

{
  "entities": [
    {
      "id": "dealer-global-001",
      "localizations": {
        "de-DE": {
          "alt_titles": [
            "GM Deutschland"
          ],
          "title": "Global Markt"
        },
        "en-GB": {
          "alt_titles": [
            "GM UK"
          ],
          "title": "Global Mart UK"
        }
      },
      "title": "Global Mart"
    }
  ],
  "entity_set": "authorized-dealers"
}

{
  "ok": true
}

Specific Errors

Global Errors