Skip to main content

Contacts API

The Contacts API enables you to programmatically manage your organization’s address book, customer phone numbers, segment tags, internal notes, and arbitrary custom key-value attributes. Contacts serve as the primary audience foundation for outbound WhatsApp campaigns and Voice AI telephony dispatching.

Key Capabilities

Individual Contact Management

Create, update, and delete individual customer records with phone numbers, names, and notes.

Dynamic Segmentation

Assign string tags (e.g. vip, trial_user, q3_leads) to power selective campaign targeting.

Arbitrary Custom Fields

Store extensible JSON key-value data (e.g. account_id, company, tier) for dynamic template variable interpolation.

High-Speed Bulk Ingestion

Upload CSV or Excel spreadsheets containing thousands of contacts with automated duplicate updating and validation error reporting.

Contact Model Schema

Each contact in Sayvy AI is scoped to your organization and contains:

Multi-Tenant Security & Isolation

All contact operations are strictly isolated by organization context. Attempting to update or delete a contact ID belonging to another organization returns a 404 Not Found response to avoid leaking identifier existence.

Available Endpoints


Previous
Create contact
POST /api/v1/contacts
Next