Prerequisites
Valid API key from Brightcall
Project ID where the contact exists
Contact’s phone number in international format, using digits only
Get Your API Key
Authentication: For all requests below, include the API key as an api-key query parameter.
Identify Your Project
You can get your project information using either of these endpoints:
GET https://api.dialer.brightcall.ai/api/v2/projects?api-key=%ACCOUNT_API_KEY%
GET https://api.dialer.brightcall.ai/api/v2/project/%PROJECT_ID%?api-key=%ACCOUNT_API_KEY%
Mark Contact as Complete
Send a PUT request with these specifications:
URL: https://api.dialer.brightcall.ai/api/v1/project-contacts/%PROJECT_ID%/ignore
Method: PUT
Query Parameters:
- api-key: %ACCOUNT_API_KEY%
- phone: %LEAD_PHONE%
Body: {}
This request completes all matching contacts in the project. success: true can also mean no contacts matched; check the project’s contact list.
Alternate formatting (same call):
https://api.dialer.brightcall.ai/api/v1/project-contacts/%PROJECT_ID%/ignore?api-key=%ACCOUNT_API_KEY%&phone=%LEAD_PHONE%
Body: {}
Example Request (cURL)
curl -X PUT \
'https://api.dialer.brightcall.ai/api/v1/project-contacts/%PROJECT_ID%/ignore?api-key=%ACCOUNT_API_KEY%&phone=%LEAD_PHONE%' \
-H 'Content-Type: application/json' \
-d '{}'
Note: Replace %ACCOUNT_API_KEY%, %PROJECT_ID% and %LEAD_PHONE% with your actual values.