Contacts

Manage contacts, tags, and contact lists.

Create, update, and organize your contacts with tags and lists. Contacts can be used across email, SMS, and WhatsApp channels for targeted messaging.

Endpoints

Method	Description	Permission
GET	List contacts (paginated)	contacts.read
GET	List all tags	contacts.read
GET	List contact lists	contacts.read
GET	Get a single contact	contacts.read
POST	Create a new contact	contacts.write
PATCH	Update a contact	contacts.write
DELETE	Delete a contact	contacts.write

List Contacts

GET /api/v1/contacts

Request

Response

{
  "success": true,
  "data": [
    {
      "id": "contact-uuid-1",
      "email": "alice@example.com",
      "firstName": "Alice",
      "lastName": "Dupont",
      "phone": "+33612345678",
      "tags": ["vip", "newsletter"],
      "created_at": "2026-03-10T08:00:00Z"
    },
    {
      "id": "contact-uuid-2",
      "email": "bob@example.com",
      "firstName": "Bob",
      "lastName": "Martin",
      "phone": "+33698765432",
      "tags": ["vip"],
      "created_at": "2026-03-12T14:30:00Z"
    }
  ],
  "meta": { "page": 1, "per_page": 20, "total": 156, "total_pages": 8 }
}

json

Create Contact

POST /api/v1/contacts

Request

Response

{
  "success": true,
  "data": {
    "id": "contact-uuid-new",
    "email": "jane@example.com",
    "firstName": "Jane",
    "lastName": "Smith",
    "phone": "+33611223344",
    "tags": ["customer", "newsletter"],
    "created_at": "2026-03-18T10:00:00Z"
  }
}

json