REregdoor
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)
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required

Headers

X-User-Emailstring nullable
X-User-Namestring nullable

Request body

action'select' | 'deselect' | 'add_collections' | 'remove_collections' required

Supported bulk actions for events.

typestring nullable

Current list event type filter

selectedboolean nullable

Current list filter by selection status

searchstring nullable

Current list search term

organization_uuidstring uuid4 nullable

Current list organization UUID filter

collection_liststring[] nullable

Current list collection name filters

country_idinteger[] nullable

Current list filter by organization jurisdiction (country_id)

contact_liststring[] nullable

Current list filter by people (contact UUIDs) in the bill snapshot

include_event_uuidsstring[] nullable

Manual event UUID selection. When present, filters are ignored.

exclude_event_uuidsstring[] nullable

Event UUIDs excluded from a filtered bulk selection

collections_to_addstring[] nullable

Collection names to merge for add_collections bulk action

collections_to_removestring[] nullable

Collection names to remove for remove_collections bulk action

Response

Successful Response

action'select' | 'deselect' | 'add_collections' | 'remove_collections' required

Supported bulk actions for events.

eligible_countinteger required
blocked_countinteger required
processed_countinteger nullable
processed_uuidsstring[]

UUIDs of events effectively processed by execute

blocked_reasonsobject

Changes

No recorded changes to this operation across all 1 revision of this API.