Contact

Bulk-remove sale contacts from a sale list

Removes multiple person profiles from a single sale list in one request. Accepts explicit IDs, an exclude list, or empty body (remove all on the list).

delete/api/contacts/{contactableEntity}/{contactableId}/sale-contact

Request

Path parameters

contactableEntitystring required

Type of an entity (agency, property, brand)

contactableIdinteger required

Id of an entity

Request body

sale_list_idinteger required
person_profile_idsinteger[]

Explicit person_profile IDs to remove. Mutually exclusive with excluded_person_profile_ids.

excluded_person_profile_idsinteger[]

Remove every contact on the list except these. Mutually exclusive with person_profile_ids.

Response

All contacts removed.

Changes

No recorded changes to this operation across all 2 revisions of this API.