This document outlines the steps and specifications required to integrate your Email Marketing System (EMS) with Raptor. The integration facilitates syncing email addresses from the EMS, assigning them a unique identifier
Authentication & Access
Before starting the integration, ensure you have the following credentials provided by our support team:
-
API Key
-
Email Marketing ID
These are required to authenticate all requests to the Raptor API.
Integration Flow
The integration consists of the following synchronization processes:
-
-
Sync email addresses to fetch or create unique
ReaId
values using the/GetOrCreate
API endpoint.
-
Use the acquired
ReaId
values to map contacts in your EMS for targeted marketing and tracking.
-
Step-by-Step Setup
1. Prepare Email Addresses
From your EMS, extract the list of email addresses you want to sync. You can batch up to 1000 email addresses per request.
2. Call /GetOrCreate
Endpoint
Use the following API endpoint to retrieve or create ReaIds for each email address:
Request
-
Method:
POST
-
Endpoint:
/GetOrCreate
-
Headers:
-
Authorization: Bearer <Your-API-Key>
-
Content-Type: application/json
-
Request Body:
json { |
-
Maximum of 1000 valid email addresses per request.
-
Invalid or malformed email addresses will be ignored.
-
If no valid email addresses are sent, an error will be returned.
Response Example:
json { |
3. Map ReaId
to EMS Contacts
Once ReaId
values are returned, map them to the corresponding contacts in your EMS system. This allows the EMS to reference the correct identifiers and making it possible to create personalized email recommendations.
🔍 Note: Read about the next steps for setting up ReaId synchronization here.
Error Handling
-
400 Bad Request – No valid email addresses provided.