Skip to main content

Adding Contacts to a Project via API

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

Updated over a month ago

Adding contacts to your Brightcall Project via API lets you connect external systems directly, so your contact lists are always up-to-date without manual uploads. This guide walks you through setting up and using the API URL from inside your project.

Step-by-Step Instructions

1. Open Your Project

Go to the project where you want to add contacts.

2. Start Contact Addition

Click the Add contacts button inside the project interface.

3. Select API Integration

From the available options, choose Connect via API.

4. Configure Request Settings

Adjust how the API will handle contacts:

  • Is add multiple contacts in one request
    Enable this to add many contacts in a single request (bulk mode).

  • Is add duplicate contacts
    Enable this to allow duplicates (contacts with the same phone number).

  • Is replace existing contacts (only visible in bulk mode)
    Enable this to clear all existing contacts in the project before adding new ones.

5. Copy Your API URL

A unique API request URL will be generated for your project. Click to copy it.

6. Use the POST Method

All contact-addition requests must use the POST HTTP method.

7. Copy the Example Payload

The system will generate a ready-to-use example JSON payload that shows the correct format. You can copy it directly from the Payload field.

Tip: Click the copy icons next to both the URL and the payload to save time and avoid mistakes.

Quick Reference

  • Method: POST

  • URL: Auto-generated for your project (see Step 5)

  • Content-Type: application/json

  • Body: Use the payload structure shown in Step 7

With this setup, your CRM, website, or external system can push contacts directly into your Brightcall AI Agent or Dialer project in real time.

Did this answer your question?