---
title: "Preview Bulk Events"
method: POST
path: "/api/companies/{uuid}/events/bulk/preview"
tags: ["company-events"]
---

# Preview Bulk Events

`POST /api/companies/{uuid}/events/bulk/preview`

## Request

- Base URL: `https://api.regdoor.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.regdoor.com/api/companies/{uuid}/events/bulk/preview`
- Auth: HTTP bearer

## Path parameters

- `uuid` string, uuid, required

## Headers

- `X-User-Email` string, nullable
- `X-User-Name` string, nullable

## Request body

- EventBulkRequest: Request schema for bulk event operations.
  - `action` 'select' | 'deselect' | 'add_collections' | 'remove_collections', required: Supported bulk actions for events.
  - `type` string, nullable: Current list event type filter
  - `selected` boolean, nullable: Current list filter by selection status
  - `search` string, nullable: Current list search term
  - `organization_uuid` string, uuid4, nullable: Current list organization UUID filter
  - `collection_list` string[], nullable: Current list collection name filters
  - `country_id` integer[], nullable: Current list filter by organization jurisdiction (country_id)
  - `contact_list` string[], nullable: Current list filter by people (contact UUIDs) in the bill snapshot
  - `include_event_uuids` string[], nullable: Manual event UUID selection. When present, filters are ignored.
  - `exclude_event_uuids` string[], nullable: Event UUIDs excluded from a filtered bulk selection
  - `collections_to_add` string[], nullable: Collection names to merge for add_collections bulk action
  - `collections_to_remove` string[], nullable: Collection names to remove for remove_collections bulk action

## Response `200`

Successful Response

- EventBulkResponse: Response schema for bulk event preview and execution.
  - `action` 'select' | 'deselect' | 'add_collections' | 'remove_collections', required: Supported bulk actions for events.
  - `eligible_count` integer, required
  - `blocked_count` integer, required
  - `processed_count` integer, nullable
  - `processed_uuids` string[]: UUIDs of events effectively processed by execute
  - `blocked_examples` EventBulkBlockedExample[]
    - `event_uuid` string, uuid4, nullable
    - `name` string, nullable
    - `reason` string, required
  - `blocked_reasons` object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/regdoor/apis/regdoor-api.md) - [All operations](https://skmtc.dev/regdoor/apis/regdoor-api/llms.txt) - [OpenAPI document](https://skmtc.dev/regdoor/apis/regdoor-api/revisions/7642336631af?raw)