REregdoor
company-interactions

Bulk Interactions

post/api/companies/{company_uuid}/interactions/bulk

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

company_uuidstring uuid required

Headers

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

Request body

action'delete' | 'update_sentiment' | 'add_collections' | 'remove_collections' required

Supported bulk actions for company interactions.

sentiment'negative' | 'neutral' | 'positive' nullable

Target sentiment for update_sentiment bulk action

searchstring nullable

Current list search term

country_idinteger[] nullable

Current list country ID filters

organization_uuidstring[] nullable

Current list organization UUID filters

contact_uuidstring[] nullable

Current list contact UUID filters

user_uuidstring[] nullable

Current list user UUID filters

start_datestring date-time nullable

Current list start date filter

end_datestring date-time nullable

Current list end date filter

statusstring[] nullable

Current list status filters

sort_bystring nullable

Current list sort field

sort_orderstring nullable

Current list sort order

include_company_interaction_uuidsstring[] nullable

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

exclude_company_interaction_uuidsstring[] nullable

Interaction UUIDs excluded from a filtered bulk selection

collection_liststring[] nullable

Current list collection name filters

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'delete' | 'update_sentiment' | 'add_collections' | 'remove_collections' required

Supported bulk actions for company interactions.

eligible_countinteger required
blocked_countinteger required
processed_countinteger nullable
processed_uuidsstring[]

UUIDs of interactions effectively processed by execute

blocked_reasonsobject

Changes

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