Get Started Here
CONTACTS API
Lahabali Contacts API helps you manage contacts that are identified by a unique random ID. Using this ID, you can create, view, update, or delete contacts. This API works as a collection of customer-specific contacts that allows you to group them and assign custom values that you can later use when sending SMS template messages.
The Contacts API uses HTTP verbs and a RESTful endpoint structure with an access key that is used as the API Authorization. Request and response payloads are formatted as JSON using UTF-8 encoding and URL encoded values.
API Endpoint
Markup
https://panel.lahabali.com/api/v3/contacts
Parameters
PARAMETER | REQUIRED | DESCRIPTION |
Authorization | When calling our API, send your api token with the authentication type set as Bearer (Example: Authorization: Bearer {api_token}) | |
Accept | Set to application/json |
Create a contact
Creates a new contact object. Lahabali returns the created contact object with each request.
API Endpoint
Markup
https://panel.lahabali.com/api/v3/contacts/{group_id}/store
Parameters
PARAMETER | REQUIRED | TYPE | DESCRIPTION |
group_id | string | Contact Groups uid | |
phone | number | The phone number of the contact. | |
first_name | No | string | The first name of the contact. |
last_name | No | string | The last name of the contact. |
Example request
PHP
curl -X POST https://panel.lahabali.com/api/v3/contacts/6065ecdc9184a/store \
-H 'Authorization: Bearer 7|xs6pv2dspHJq8sWLhrpNFH5YLilMRQcVxLwSw2Sd' \
-d "phone=31612345678"
Returns
Returns a contact object if the request was successful.
JSON
{
"status": "success",
"data": "contacts data with all details",
}
If the request failed, an error object will be returned.
JSON
{
"status": "error",
"message" : "A human-readable description of the error."
}
View a contact
Retrieves the information of an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation or receiving.
API Endpoint
Markup
https://panel.lahabali.com/api/v3/contacts/{group_id}/search/{uid}
Parameters
PARAMETER | REQUIRED | TYPE | DESCRIPTION |
group_id | string | Contact Groups uid | |
uid | string | Contact uid |
Example request
PHP
curl -X POST https://panel.lahabali.com/api/v3/contacts/6065ecdc9184a/search/606732aec8705 \
-H 'Authorization: Bearer 7|xs6pv2dspHJq8sWLhrpNFH5YLilMRQcVxLwSw2Sd'
Returns
Returns a contact object if the request was successful.
JSON
{
"status": "success",
"data": "contacts data with all details",
}
If the request failed, an error object will be returned.
JSON
{
"status": "error",
"message" : "A human-readable description of the error."
}
Update a contact
Updates an existing contact. You only need to supply the unique uid of contact and contact group uid that was returned upon creation.
API Endpoint
Markup
https://panel.lahabali.com/api/v3/contacts/{group_id}/update/{uid}
Parameters
PARAMETER | REQUIRED | TYPE | DESCRIPTION |
group_id | string | Contact Groups uid | |
uid | string | Contact uid | |
phone | number | The phone number of the contact. | |
first_name | No | string | The first name of the contact. |
last_name | No | string | The last name of the contact. |
Example request
PHP
curl -X PATCH https://panel.lahabali.com/api/v3/contacts/6065ecdc9184a/update/606732aec8705 \
-H 'Authorization: Bearer 7|xs6pv2dspHJq8sWLhrpNFH5YLilMRQcVxLwSw2Sd' \
-d "phone=31612345678"
Returns
Returns a contact object if the request was successful.
JSON
{
"status": "success",
"data": "contacts data with all details",
}
If the request failed, an error object will be returned.
JSON
{
"status": "error",
"message" : "A human-readable description of the error."
}
Delete a contact
Deletes an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation.
API Endpoint
Markup
https://panel.lahabali.com/api/v3/contacts/{group_id}/delete/{uid}
Parameters
PARAMETER | REQUIRED | TYPE | DESCRIPTION |
group_id | string | Contact Groups uid | |
uid | string | Contact uid |
Example request
PHP
curl -X DELETE https://panel.lahabali.com/api/v3/contacts/6065ecdc9184a/delete/606732aec8705 \
-H 'Authorization: Bearer 7|xs6pv2dspHJq8sWLhrpNFH5YLilMRQcVxLwSw2Sd'
Returns
Returns a contact object if the request was successful.
JSON
{
"status": "success",
"data": "contacts data with all details",
}
If the request failed, an error object will be returned.
JSON
{
"status": "error",
"message" : "A human-readable description of the error."
}
View all contacts in group API Endpoint
Markup
https://panel.lahabali.com/api/v3/contacts/{group_id}/all
Parameters
PARAMETER | REQUIRED | TYPE | DESCRIPTION |
group_id | string | Contact Groups uid |
Example request
PHP
curl -X POST https://panel.lahabali.com/api/v3/contacts/6065ecdc9184a/all \
-H 'Authorization: Bearer 7|xs6pv2dspHJq8sWLhrpNFH5YLilMRQcVxLwSw2Sd'
Returns
Returns a contact object if the request was successful.
JSON
{
"status": "success",
"data": "contacts data with pagination",
}
If the request failed, an error object will be returned.
JSON
{
"status": "error",
"message" : "A human-readable description of the error."
}
