Removing contacts from a project list via API is a quick and efficient solution, eliminating the need for manual deletions or list uploads. By automating contact removal, you ensure your Brightcall AI Agent or Dialer app is always working with the most relevant and up-to-date contact lists. This reduces manual effort, minimizes errors, and helps maintain clean, optimized project lists for better campaign performance.
Follow this guide to learn how to automate the removal of contacts using the API.
How to set up ?
Get the API key here: https://app.convolo.ai/pages/general-settings
For all requests API key should be included as an
api-keyquery parameter. E.g.: https://api.ipmaxi.leadcm.com/api/v2/projects?api-key=%your-api-key%Get a list of all projects through this endpoint: https://api.ipmaxi.leadcm.com/api/v2/projects Please note, that the Power Dialer project has a
typeparameter equal to 2. Alternatively, you can get one project through this endpoint: https://api.ipmaxi.leadcm.com/api/v2/project/{project_id}Get the project ID from the
idproperty from the project payloadGet project columns through this endpoint: https://api.ipmaxi.leadcm.com/api/v1/project-columns/{project_id}
Get project contacts through this endpoint: https://api.ipmaxi.leadcm.com/api/v1/project-contacts/{project_id}
Find
idof contact(s) you want to remove Please note, that contact data itself is stored in thedatafield of a contact: as array of tuples with column id and its value. Column id is at0index and the field value is at1indexSend a
DELETErequest to this endpoint: https://api.ipmaxi.leadcm.com/api/v1/project-contacts/{project_id} Body:
{ "contactIds": []//ids of contacts you want to remove }