Contact Lists

Retrieve Contact Lists

Retrieve all the contact lists associated with the logged in user.

GET /integrations/contact-list/

Headers

Name	Value
Authorization	Bearer Access Token

Query Parameters

Name	Type	Required	Description
list_id	string	No	Contact List ID (retrieves all lists of the user if not provided)
page	integer	No
page_size	integer	No
email	string	Yes	Email of the user

Response

{
 "success": true,
 "message": "string",
 "data": {
  "count": 0,
  "next": "string",
  "previous": "string",
  "results": [
   {
    "id": 0,
    "list_id": "string",
    "title": "string",
    "total_contacts": 0,
    "assigned_contacts": 0,
    "created_at": "string",
    "updated_at": "string"
   }
  ]
 }
}

Create Contact List

Create a new contact list.

POST /integrations/contact-list/

Headers

Name	Value
Authorization	Bearer Access Token
Content-Type	application/json

Query Parameters

Name	Type	Required	Description
email	string	No	The email of Frejun User

Payload

userrequired

string

Email of the user creating the contact list

titlerequired

string

Title of the contact list

contactsrequired

array of object

List of contacts to be added to the contact list

Array [

contactrequired

string

Phone number of the contact without country code

namerequired

string

Name of the contact

country_coderequired

string

Country code of the contact

notes

string

Notes to add to the contact

custom_data

object

Custom contact data (e.g., {"key":"value"}). If key = company_name, the value appears in the Chrome extension's incoming call popup.

]

Response

{
 "success": true,
 "message": "string",
 "contact_list_id": "string"
}

Tip

If you are storing the email address of the contact using custom_data field, use email as the key. This will allow the system to automatically detect and use the email for internal email-contact mappings.
E.g.,

custom_data: {
    email: "john@example.com"
}

Update Contact List

Update an existing contact list.

PATCH /integrations/contact-list/

Headers

Name	Value
Authorization	Bearer Access Token
Content-Type	application/json

Query Parameters

Name	Type	Required	Description
email	string	No	The email of Frejun User

Payload

emailrequired

string

Email of the user who created the list

list_idrequired

string

ID of the contact list

enquiriesrequired

array of object

List of contact operations to perform

Array [

contactrequired

string

Phone number of the contact without country code

namerequired

string

Name of the contact

country_coderequired

string

Country code of the contact

notes

string

Notes to add to the contact

custom_data

object

Custom contact data (e.g., {"key":"value"}). If key = company_name, the value appears in the Chrome extension's incoming call popup.

operationrequired

string (add | delete)

Operation to perform. add or delete

]

Response

{
 "success": true,
 "message": "string"
}

Tip

If a contact already exists in the contact list, any attempt to add it again will be ignored, even if other details (such as contact name, custom_data, etc.) are different.

To update existing contacts, you must create a new contact list with the updated contact details and then delete the old contact list.

Delete Contact List

Delete a contact list.

DELETE /integrations/contact-list/

Headers

Name	Value
Authorization	Bearer Access Token

Query Parameters

Name	Type	Required	Description
list_id	string	Yes	ID of the Contact List to delete
email	string	Yes	Email of the user

Response

{
 "success": true,
 "message": "string"
}

Assign Contacts

Assign contacts to a user.

PATCH /integrations/assign-contact/

Headers

Name	Value
Authorization	Bearer Access Token
Content-Type	application/json

Query Parameters

Name	Type	Required	Description
email	string	No	The email of Frejun User

Payload

email

string

Email of the user to whom the contacts are being assigned or unassigned

list_id

string

ID of the contact list from which contacts are being assigned or unassigned

contacts

array of string

List of contact phone numbers to assign or unassign (without country code)

Response

{
 "success": true,
 "message": "string"
}

Unassign Contacts

Unassign contacts from a user.

PATCH /integrations/unassign-contact/

Headers

Name	Value
Authorization	Bearer Access Token
Content-Type	application/json

Query Parameters

Name	Type	Required	Description
email	string	No	The email of Frejun User

Payload

email

string

Email of the user to whom the contacts are being assigned or unassigned

list_id

string

ID of the contact list from which contacts are being assigned or unassigned

contacts

array of string

List of contact phone numbers to assign or unassign (without country code)

Response

{
 "success": true,
 "message": "string"
}