Skip to main content
All CollectionsMULTI LINE DIALER™⚒️ For Developers
Adding Contacts to a Project via API
Adding Contacts to a Project via API

Add contacts to a Project for Dialling via AI Agent or Brightcall Dialer app

Updated over a week ago

Adding contacts to a project list via API offers a faster and more efficient alternative to manual uploads. Instead of repeatedly uploading XLS or CSV, the API allows contacts to be automatically added to your Brightcall AI Agent or Dialer app project list in real-time. This automation saves time, reduces manual errors, and ensures your contact lists are always up-to-date, enabling seamless dialling and improved campaign efficiency. Follow this guide to learn how to set up contact imports via API for a streamlined workflow.
​
Follow the instruction below to learn how to set up contact imports via API for a streamlined workflow.
​


How to set up ?

  1. Get the API key here: https://app.brightcall.ai/pages/general-settings

  2. For all requests API key should be included as an api-key query parameter. E.g.: https://api.ipmaxi.convolo.ai/api/v2/projects?api-key=%your-api-key%

  3. 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 type parameter equal to 2. Alternatively, you can get one project through this endpoint: https://api.ipmaxi.convolo.ai/api/v2/project/{project_id}

  4. Get the project ID from the id property from the project payload

  5. Get phoneColumnId, nameColumnId and websiteColumnId properties from project payload

  6. Get project columns through this endpoint: https://api.ipmaxi.convolo.ai/api/v1/project-columns/{project_id}

  7. Prepare contacts payload:

    1. contacts —Array of contacts. Each contact should include the following:
      - id with the null value
      - data: Array of tuples with column id and its value. Column id should be at 0 index and the field value should be at 1 index

    2. addContacts — bool parameter. If true, contacts would be added to the project. If false contacts in the project would be replaced

    3. ifDuplicates —numeric value. it defines how duplicate contacts would be handled:
      - 2 — keep duplicates
      - 3 — discard duplicates


    Payload example:

    {
        "contacts": [
            {
                "data": [
                    [{column_id}, {column_value}]
                ],
                "id": null
            }
        ],
        "addContacts": true,
        "ifDuplicates": 1
    }

  8. Send contact payload to this endpoint:
    ​ https://api.ipmaxi.convolo.ai/api/v1/project-contacts/{project_id} using a PUT method

Did this answer your question?