Skip to main content

Lists & Contact Management

Professional contact management with advanced segmentation capabilities.

Creating a List​

POST /comm-api/api/lists
Content-Type: application/json
X-Tenant-Id: your-tenant-uuid

{
  "name": "Newsletter Subscribers",
  "description": "Monthly newsletter contacts"
}

Importing Contacts​

Import contacts via CSV with validation and deduplication:

POST /comm-api/api/lists/{id}/contacts/import
Content-Type: multipart/form-data
X-Tenant-Id: your-tenant-uuid

file: contacts.csv

CSV Format​

email,name,phone,identity_type,identity_name
[email protected],Alice Smith,+12025550111,individual,
[email protected],Billing Dept,+442071234567,company,ACME Ltd
[email protected],Support Team,,company,StartupCo

All fields except email are optional.

Managing Contacts​

List All Contacts​

GET /comm-api/api/lists/{id}/contacts?page=1&pageSize=50
X-Tenant-Id: your-tenant-uuid

Contact Features​

  • CSV Import & Export — Bulk operations with validation and deduplication
  • Contact Segmentation — Organize contacts into targeted lists
  • Real-time Validation — Email format validation and duplicate detection
  • Contact Profiles — Rich contact data with custom fields and engagement history

Exporting Contacts​

Download complete contact lists with all fields for backup, migration, or analysis:

GET /comm-api/api/lists/{id}/contacts/export
X-Tenant-Id: your-tenant-uuid

GDPR Data Portability​

Comprehensive data export per contact including:

  • Contact profile and custom fields
  • List memberships and join dates
  • Campaign participation history
  • Email interaction tracking (opens, clicks)
  • Unsubscribe events and suppression status

GDPR exports are delivered securely as email attachments to protect personal data.

Contact Deletion with Anonymization​

Right to Erasure (Article 17) — Delete contacts while preserving anonymized campaign statistics. This ensures your aggregate analytics remain accurate while fully removing personal data.