{
  "opencollection": "1.0.0",
  "info": {
    "name": "Boom CDP Custom Objects Segments API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Segments",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List segments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.useboom.ai/api/v1/segments",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List the organization's active segments, newest first. Archived segments are excluded."
        },
        {
          "info": {
            "name": "Create a segment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.useboom.ai/api/v1/segments",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a segment from a filter expression. It starts empty until evaluated. Validate and preview the filter first."
        },
        {
          "info": {
            "name": "Get a segment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.useboom.ai/api/v1/segments/:slug",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get one segment by slug, with a live member count."
        },
        {
          "info": {
            "name": "Update a segment",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://www.useboom.ai/api/v1/segments/:slug",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a segment in place; the slug is permanent. Changing the filter doesn't re-evaluate membership until the next evaluation."
        },
        {
          "info": {
            "name": "Delete a segment",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://www.useboom.ai/api/v1/segments/:slug",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Remove a segment. It disappears from all lists and its journey triggers are disconnected. Idempotent."
        },
        {
          "info": {
            "name": "Evaluate a segment now",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.useboom.ai/api/v1/segments/:slug/evaluate",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Re-evaluate a segment's membership now instead of waiting for its cadence. Runs synchronously; can take a while for large organizations."
        },
        {
          "info": {
            "name": "List segment members",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.useboom.ai/api/v1/segments/:slug/members",
            "params": [
              {
                "name": "slug",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List a segment's active members, newest first."
        },
        {
          "info": {
            "name": "Get the segment filter catalog",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://www.useboom.ai/api/v1/segments/catalog"
          },
          "docs": "Everything filterable in your organization — person attributes, related data, and computed variables — with the token and operators to use for each. Read this first when building a filter."
        },
        {
          "info": {
            "name": "Preview a segment filter",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.useboom.ai/api/v1/segments/preview",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Count how many people currently match a filter, without saving. Use it to check the audience before saving a segment."
        },
        {
          "info": {
            "name": "Validate a segment filter",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://www.useboom.ai/api/v1/segments/validate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Dry-run a filter expression against your live catalog — nothing is saved. Returns whether it's valid, or the field to fix."
        }
      ]
    }
  ],
  "bundled": true
}