Contacts Module

Other Modules

@php $apiDocs = [ ['route' => 'wpbox.api.docs', 'label' => 'Wpbox', 'icon_class' => 'group-hover:text-emerald-500', 'link_class' => 'hover:text-emerald-600 hover:bg-emerald-50'], ['route' => 'shop.api.docs', 'label' => 'Shop', 'icon_class' => 'group-hover:text-blue-500', 'link_class' => 'hover:text-blue-600 hover:bg-blue-50'], ['route' => 'verification.api.docs', 'label' => 'Verification', 'icon_class' => 'group-hover:text-purple-500', 'link_class' => 'hover:text-purple-600 hover:bg-purple-50'], ['route' => 'contacts.api.docs', 'label' => 'Contacts', 'icon_class' => 'group-hover:text-orange-500', 'link_class' => 'hover:text-orange-600 hover:bg-orange-50'], ['route' => 'ai.api.docs', 'label' => 'AI', 'icon_class' => 'group-hover:text-indigo-500', 'link_class' => 'hover:text-indigo-600 hover:bg-indigo-50'], ]; $currentRoute = Route::currentRouteName(); @endphp @foreach($apiDocs as $doc) @if (Route::has($doc['route']) && $currentRoute !== $doc['route']) {{ $doc['label'] }} API Docs @endif @endforeach

Contacts API Download .md

v1.0 REST API

Contacts API Reference

Manage your audience, segment customers into groups, and synchronize external CRM data seamlessly with WACM.

Download as Markdown

Base URL

{{ url('api/v1/contacts') }}

Authentication

Like other WACM APIs, the Contacts API requires a Bearer Token via the HTTP Header.

HTTP Header (Required)

Send the token securely in the Authorization request header.

Example Request Header

Authorization: Bearer YOUR_API_TOKEN

Contacts

GET /api/v1/contacts

Retrieve a paginated list of contacts. Add ?update_from=YYYY-MM-DD HH:MM:SS to filter recently modified contacts. Use ?page=1&limit=15 for pagination, and ?search=QUERY to search by name or phone.

POST /api/v1/contacts

Create or upsert a contact by phone number.

Parameters

Parameter	Description
phone Req	Contact phone number with country code.
name	Full name.
email	Email address.
{custom_field_name}	Any custom field attached to your company can be sent directly as a property (e.g. "email").

PUT /api/v1/contacts/{id}

DEL /api/v1/contacts/{id}

Update an existing contact or delete a contact.

Request: Upsert Contact POST Payload

{
  "phone": "1234567890",
  "name": "Jane Doe",
  "email": "jane@example.com",
  "company": "Acme Corp"
}