Profiles are the central object in Omneo. This guide covers the core CRUD operations and common patterns for working with profiles programmatically.
Creating a profile
A successful response returns the created profile with its id.
Reading a profile
By Omneo profile ID:
By identity (e.g., Shopify customer ID):
Searching profiles
The search endpoint supports name, email, mobile, and other fields. Omneo uses Algolia for instant, typo-tolerant search.
Updating a profile
Syncing profiles (upsert)
The sync endpoint creates a profile if it doesn’t exist, or updates it if it does. It matches on email or mobile phone:
This is the recommended approach for eCommerce integrations where you don’t always know if a profile exists.
Deleting a profile
This soft-deletes the profile. For a full GDPR-compliant erasure, use the Purge endpoint:
Bulk import
For large-scale profile imports, use the batch import endpoint or the CSV import tool in CX Manager under the Import Jobs section.
Content needed: field validation rules, error response reference, and bulk import file format specification.
