{!! __('locale.description.contacts_api', ['brandname' => config('app.name')]) !!}

                                
                                    {{ route('api.contacts.index') }}

{{ __('locale.developers.parameter') }}	{{ __('locale.labels.required') }}	{{ __('locale.labels.description') }}
Authorization	{{ __('locale.labels.yes') }}	When calling our API, send your api token with the authentication type set as `Bearer` (Example: `Authorization: Bearer {api_token}`)
Accept	{{ __('locale.labels.yes') }}	Set to `application/json`

Create a contact

Creates a new contact object. {{ config('app.name') }} returns the created contact object with each request.

                                
                                    {{config('app.url')}}/api/v3/contacts/{group_id}/store

{{ __('locale.developers.parameter') }}	{{ __('locale.labels.required') }}	{{ __('locale.labels.type') }}	{{ __('locale.labels.description') }}
group_id	{{ __('locale.labels.yes') }}	string	Contact Groups `uid`
PHONE	{{ __('locale.labels.yes') }}	number	The phone number of the contact.
OTHER_FIELDS	{{ __('locale.labels.no') }}	string	All Contact's other fields: FIRST_NAME (?), LAST_NAME (?),... (depending on the contact group fields configuration)

Example request

                                
curl -X POST {{ route('api.contact.store', ['group_id' => '6065ecdc9184a']) }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"PHONE":"8801721970168",
"FIRST_NAME":"Jhon",
"LAST_NAME":"Doe",
}'

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

                                
{
    "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.

                                
                                    {{config('app.url')}}/api/v3/contacts/{group_id}/search/{uid}

{{ __('locale.developers.parameter') }}	{{ __('locale.labels.required') }}	{{ __('locale.labels.type') }}	{{ __('locale.labels.description') }}
group_id	{{ __('locale.labels.yes') }}	string	Contact Groups `uid`
uid	{{ __('locale.labels.yes') }}	string	Contact `uid`

Example request

                                
curl -X POST {{ route('api.contact.search', ['group_id' => '6065ecdc9184a', 'uid' => '606732aec8705']) }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

                                
{
    "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.

                                
                                    {{config('app.url')}}/api/v3/contacts/{group_id}/update/{uid}

{{ __('locale.developers.parameter') }}	{{ __('locale.labels.required') }}	{{ __('locale.labels.type') }}	{{ __('locale.labels.description') }}
group_id	{{ __('locale.labels.yes') }}	string	Contact Groups `uid`
uid	{{ __('locale.labels.yes') }}	string	Contact `uid`
PHONE	{{ __('locale.labels.yes') }}	number	The phone number of the contact.
OTHER_FIELDS	{{ __('locale.labels.no') }}	string	All Contact's other fields: FIRST_NAME (?), LAST_NAME (?),... (depending on the contact group fields configuration)

Example request

                                
curl -X PATCH {{ route('api.contact.update', ['group_id' => '6065ecdc9184a', 'uid' => '606732aec8705']) }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"PHONE":"8801721970168",
"FIRST_NAME":"Jhon",
"LAST_NAME":"Doe",
}'

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

                                
{
    "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.

                                
                                    {{config('app.url')}}/api/v3/contacts/{group_id}/delete/{uid}

{{ __('locale.developers.parameter') }}	{{ __('locale.labels.required') }}	{{ __('locale.labels.type') }}	{{ __('locale.labels.description') }}
group_id	{{ __('locale.labels.yes') }}	string	Contact Groups `uid`
uid	{{ __('locale.labels.yes') }}	string	Contact `uid`

Example request

                                
curl -X DELETE {{ route('api.contact.delete', ['group_id' => '6065ecdc9184a', 'uid' => '606732aec8705']) }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

View all contacts in group

                                
                                    {{config('app.url')}}/api/v3/contacts/{group_id}/all

{{ __('locale.developers.parameter') }}	{{ __('locale.labels.required') }}	{{ __('locale.labels.type') }}	{{ __('locale.labels.description') }}
group_id	{{ __('locale.labels.yes') }}	string	Contact Groups `uid`

Example request

                                
curl -X POST {{ route('api.contact.all', ['group_id' => '6065ecdc9184a']) }} \
-H 'Authorization: Bearer {{ Auth::user()->api_token }}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \

Returns

Returns a contact object if the request was successful.

                                
{
    "status": "success",
    "data": "contacts data with pagination",
}

If the request failed, an error object will be returned.

                                
{
    "status": "error",
    "message" : "A human-readable description of the error."
}