The base url is:
@bulk_base/api/v1
Method | URI |
---|---|
POST | /address-book/contacts |
Param | Type | Description |
---|---|---|
phone | string (required) |
Contact Phone Number |
name | string (optional) |
Contact Names |
string (optional) |
Contact Email Address |
{
"name": "Test Contact",
"email": "example@example.com",
"phone": "0716XXXXXX"
}
StatusCode 200
Content
{
"status": true,
"data": {
"id": 1,
"name": "Test Contact",
"email": "example@example.com",
"phone": "0716XXXXXX"
"client_id": 1,
"created_by": 2,
"unique_trace": "Unique_trace",
"updated_at": "2020-01-16 11:05:12",
"created_at": "2020-01-16 11:05:12",
}
}
Method | URI |
---|---|
DELETE | /address-book/contacts/{contact_id} |
{info} Replace {contact_id} with the id that was received when creating the contact
StatusCode 200
Content
{
"status": true,
"message": "Contact Successfully Deleted!"
}
Method | URI |
---|---|
POST | /address-book/groups |
Param | Type | Description |
---|---|---|
name | string (required) |
Name of the Group |
{
"name": "Group 1",
}
StatusCode 200
Content
{
"status": true,
"data": {
"id": 1,
"client_id": 1,
"created_by": 2,
"updated_at": "2020-01-16 10:15:22",
"created_at": "2020-01-16 10:15:22",
"date_created": "16 Jan, 2020",
"contacts_count": 0,
"first_contact": null
}
}
Method | URI |
---|---|
DELETE | /address-book/groups/{group_id} |
{info} Replace {group_id} with the id that was received when creating the group
StatusCode 200
Content
{
"status": true,
"message": "Group and all associated contacts Successfully deleted!"
}