Skip to main content

Contact Lists

Retrieve Contact Lists

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

GET/api/v1/integrations/contact-list/

Headers

NameValue
AuthorizationBearer Access Token

Query Parameters

email
required
string <email>

Email of FreJun user

list_id
required
string

Contact List ID

{}

Response

{
"success": true,
"message": "Successfully retrieved contacts lists for [email protected]",
"data": [
{
"id": 100,
"title": "CONTACT LIST",
"total_contacts": 10,
"assigned_contacts": 0,
"created_at": "2025-04-10T17:54:54.566061",
"updated_at": "2025-04-10T17:54:54.566085"
}
]
}

Create Contact List

Create a new contact list.

POST/api/v1/integrations/contact-list/

Headers

NameValue
AuthorizationBearer Access Token
Content-Typeapplication/json

Payload

user
required
string <email>

Email of FreJun user

title
required
string

Title of the contact list

required
Array of objects (ContactItem)

List of contacts to add to the contact list

{
  • "title": "string",
  • "contacts": [
    ]
}

Response

{
"success": true,
"message": "Request successfully submitted for creating Contact list",
"contact_list_id": "abc123def456"
}

Update Contact List

Update an existing contact list.

PATCH/api/v1/integrations/contact-list/

Headers

NameValue
AuthorizationBearer Access Token
Content-Typeapplication/json

Payload

email
string <email>

Email of FreJun user

list_id
string

Contact List ID

Array of objects (ContactOperation)

List of contact operations to perform

{
  • "email": "[email protected]",
  • "list_id": "string",
  • "enquiries": [
    ]
}

Response

{
"success": true,
"message": "Request successfully submitted for updating Contact list"
}

Delete Contact List

Delete a contact list.

DELETE/api/v1/integrations/contact-list/

Headers

NameValue
AuthorizationBearer Access Token

Query Parameters

email
required
string <email>

Email of FreJun user

list_id
required
string

Contact List ID

{}

Assign Contacts

Assign contacts to a user.

PATCH/api/v1/integrations/assign-contact/

Headers

NameValue
AuthorizationBearer Access Token
Content-Typeapplication/json

Payload

contacts
Array of strings

List of contact phone numbers to assign

email
string <email>

Email of the FreJun user to assign the contacts to

list_id
string

ID of the contact list containing the contacts

{}

Response

{
"success": true,
"message": "Successfully Assigned contacts"
}

Unassign Contacts

Unassign contacts from a user.

PATCH/api/v1/integrations/unassign-contact/

Headers

NameValue
AuthorizationBearer Access Token
Content-Typeapplication/json

Payload

contacts
Array of strings

List of contact phone numbers to unassign

email
string <email>

Email of the FreJun user to unassign the contacts to

list_id
string

ID of the contact list containing the contacts

{}

Response

{
"success": true,
"message": "Successfully Unassigned contacts"
}