company-contacts

Bulk Contacts

post/api/companies/{company_uuid}/contacts/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' | 'select' | 'deselect' | 'add_owner' | 'add_collections' | 'remove_collections' | 'remove_owner' | 'restore' required

Supported bulk actions for contacts.

selectedboolean nullable

Current list filter by selection status

searchstring nullable

Current list search term

search_namestring nullable

Current list name-only search term

user_uuidstring uuid4 nullable

Current list owner filter

organization_uuidstring[] nullable

Current list organization UUID filters

organization_typeTypeEnum[] nullable

Current list organization type filters

country_idinteger[] nullable

Current list country ID filters

positionstring nullable

Current list position filter

departmentstring nullable

Current list department filter

regdoor_verifiedboolean nullable

Current list RegDoor verified filter

collection_liststring[] nullable

Current list collection name filters

sort_bystring nullable

Current list sort field

sort_orderstring nullable

Current list sort order

include_contact_uuidsstring[] nullable

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

exclude_contact_uuidsstring[] nullable

Contact UUIDs excluded from a filtered bulk selection

assign_owner_user_uuidstring uuid4 nullable

User UUID to assign as owner for add_owner bulk action

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' | 'select' | 'deselect' | 'add_owner' | 'add_collections' | 'remove_collections' | 'remove_owner' | 'restore' required

Supported bulk actions for contacts.

eligible_countinteger required
blocked_countinteger required
processed_countinteger nullable
processed_uuidsstring[]

UUIDs of contacts effectively processed by execute

blocked_reasonsobject

Changes

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