Download OpenAPI specification:Download
These APIs are for AudiencePoint client use only. All API integrations must be approved before access.
AudiencePoint Scoring API
AudiencePoint Event Ingestion API
AudiencePoint Email Verification API
AudiencePoint List Subscription API
AudiencePoint Send Time Optimization (STO) API
AudiencePoint uses an API Key for access to its APIs. Every request to the API must include the X-API-Key
in the header.
AudiencePoint Scoring API supports the hashing of email addresses as a secure way of passing personal information. All hashed emails must use the same hashing algorithm or the hashed values will not return any scores.
Shareable PDF file providing more information on the 'Scores Model'.
Shareable PDF file providing more information on the 'Email Verification Model'.
A JavaScript SDK for the Email Verification API.
emailAddress required | string The email address originally provided in the request body. |
matched required | string Enum: "yes" "no" "invalid" "err" Indicates if an address has any tracked activity in our dataset. |
domain_owner | string The domain name for the mail provider of the email address. |
best_day_of_week | string Enum: "Sunday" "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" The best day of the week to send to this email address. |
best_time_of_day | string Enum: "Morning" "Afternoon" "Evening" "Night" The best time of the day to send to this email address. |
last_touch | string The last time (UTC) this email address had an open or a click event. |
send_time | string [ 0 .. 167 ] The ideal day and time to send to an email address. |
score | string [ 0 .. 5 ] How likely a subscriber is to interact with an email. |
frequency | string Enum: "Hyper-engaged" "No Limit" "Daily" "Weekly" "Monthly" How often an email address typically engages with email across our database. |
codes | string A pipe delimited string containing the industries the subscriber engages with most. |
devices | string Enum: "Desktop" "Tablet" "Mobile" "Unknown" "Unspecified" "Other" A pipe delimited string containing the type of devices an email has engaged with. |
email_clients | string A pipe delimited string containing the type of email clients an email has engaged. |
first_touch | string The first time (UTC) that a subscriber showed activity. |
last_send_no_bounce | string The last time (UTC) that a subscriber was sent an email and no bounce was returned. |
last_seen | string The date and time (UTC) of the most recent record of an open, click, or unsubscribe from a subscriber. |
last_seen_auto_open | string Enum: "TRUE" "FALSE" A boolean value that indicates if the last seen event is an auto-open which would be attributed to Apple MPP, Gmail, or Yahoo Proxies. |
{- "emailAddress": "bigtest39336@ignore.marketing",
- "matched": "yes",
- "domain_owner": "google.com",
- "best_day_of_week": "Monday",
- "best_time_of_day": "Morning",
- "last_touch": "2022-12-14 09:04:00 AM",
- "send_time": "10",
- "score": "5",
- "frequency": "Weekly",
- "codes": "446120|448140|448120",
- "devices": "Mobile|Desktop",
- "email_clients": "Gmail|iOS",
- "first_touch": "2015-10-09 09:04:00 AM",
- "last_send_no_bounce": "2022-12-14 09:04:00 AM",
- "last_seen": "2022-12-14 09:04:00 AM",
- "last_seen_auto_open": "FALSE"
}
email required | string The plaintext or SHA-256 hashed email address of the event. |
type required | string Enum: "Open" "Click" "Send" "SoftBounce" "HardBounce" "Unsubscribe" "Complaint" Indicates the type of email event. |
occurred_at_utc required | string The date and time (UTC) the email event occurred in the format <YYYY-MM-DDThh:mm:ss> |
send_id required | string The send event identifier. |
domain | string The domain of the email address (the part after the '@' symbol). |
client | string Email client the event came from. |
browser | string Internet browser the event came from. |
os | string Operating system the event came from. |
device | string Device the event came from. |
ip_address | string IP address the event came from. |
user_agent | string The characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent. |
machine_open | boolean Default: false This field serves to indicate if an open event was triggered by Apple Mail Privacy Protection (MPP). A value of |
{- "email": "bigtest39336@ignore.marketing",
- "type": "Open",
- "occurred_at_utc": "2023-04-04T04:50:44",
- "send_id": "123",
- "domain": "ignore.marketing",
- "client": "Hotmail",
- "browser": "Chrome",
- "os": "Windows",
- "device": "PC",
- "ip_address": "127.0.0.1",
- "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
- "machine_open": true
}
Email required | string The email address originally provided in the request. |
Result required | string Enum: "Verified" "Invalid" "Spamtrap" "Role" "Caution" "Unknown" "Abandoned" The validation and verification result status of the provided email address. "Verified" - The email address exists. |
Suggestion | string In certain cases where the email address is invalid, a suggestion will be given on how to fix it. |
{- "Email": "testemail@yaho.con",
- "Result": "Invalid",
- "Suggestion": "testemail@yahoo.com"
}
new required | int The number of new email subscriptions added. |
existing required | int The number of requested email subscriptions that were already existing subscriptions. |
invalid required | int The number of requested email subscriptions that could not be subscribed to due to invalid email address/hash format. |
{- "new": 2,
- "existing": 1,
- "invalid": 2
}
required | Array of objects (EmailsWithSendTime) <= 30 items List of email addresses with their send times |
startTimeUtc required | datetime start time of campaign in UTC |
endTimeUtc required | datetime end time of campaign in UTC |
defaultSendTIme | datetime default send time to send to emails in UTC. If not specified in request, set to 20 minutes after endTimeUtc. |
{- "emailAddresses": [
- {
- "email": "anthony.aardvark@audiencepoint.com",
- "sendTime": "2024-04-01T18:00:00"
}
], - "startTimeUtc": "2024-01-01T00:00:00",
- "endTimeUtc": "2024-03-10T22:00:00",
- "defaultSendTIme": "2024-02-17T11:00:00"
}
Endpoint to pass an array of email addresses and have an array of scores returned for each address
X-API-Key | string Example: 349:u1QHNv2rLn2tFdAo6TUIP8r2fnjH0YRg7epsEdN0 |
JSON Object containing an array of plain text or SH-256 email addresses and an optional array of scores to return
emailAddresses | Array of strings <email address OR SHA-256> <= 30 items [ items <email address OR SHA-256 > ] Array of plain text or SHA-256 email addresses |
scoreSelection | Array of strings <score names> [ items <score names > ] Optional array of specific scores to be returned. If this parameter is not proivded or is empty, all scores will be returned. Score options - |
{- "emailAddresses": [
- "bigtest39336@ignore.marketing",
- "testAddress2@audiencepoint.com",
- "dd302c5570d6ba576c2e3292e7f870a06583a794c34c8ebe387a6556f81481ae",
- "de7b72a8b13e4b6defd985af1fb4fddb681edd48dbca1d56bb4a86b57d26afeb"
], - "scoreSelection": [
- "domain_owner",
- "score",
- "last_seen"
]
}
[- {
- "emailAddress": "bigtest39336@ignore.marketing",
- "matched": "yes",
- "domain_owner": "google.com",
- "best_day_of_week": "Monday",
- "best_time_of_day": "Morning",
- "last_touch": "2022-12-14 09:04:00 AM",
- "send_time": "10",
- "score": "5",
- "frequency": "Weekly",
- "codes": "446120|448140|448120",
- "devices": "Mobile|Desktop",
- "email_clients": "Gmail|iOS",
- "first_touch": "2015-10-09 09:04:00 AM",
- "last_send_no_bounce": "2022-12-14 09:04:00 AM",
- "last_seen": "2022-12-14 09:04:00 AM",
- "last_seen_auto_open": "FALSE"
}
]
Endpoint to send event data in real time.
X-API-Key | string Example: 349:u1QHNv2rLn2tFdAo6TUIP8r2fnjH0YRg7epsEdN0 |
JSON Object containing an array of email event objects
Array of objects (EmailEvent) <= 30 items Array of email event objects |
{- "events": [
- {
- "email": "bigtest39336@ignore.marketing",
- "type": "Open",
- "occurred_at_utc": "2023-04-04T04:50:44",
- "send_id": "123",
- "domain": "ignore.marketing",
- "client": "Hotmail",
- "browser": "Chrome",
- "os": "Windows",
- "device": "PC",
- "ip_address": "127.0.0.1",
- "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
- "machine_open": true
}
]
}
{- "SequenceNumber": "49641413016779683157064666432340754120125478138187505682",
- "ShardId": "shardId-000000000001"
}
(Method Not Recommended)
GET request method to pass an email address as a query and have a verification result returned.
We recommend using the POST request method because query parameters in a GET request are included as part of the URL (and appear in browsers' address bars). This means they are liable to be recorded, cached, and exposed in ways most other web traffic data is not.
email required | string Example: email=bigtest123@ignore.marketing |
X-API-Key | string Example: 349:u1QHNv2rLn2tFdAo6TUIP8r2fnjH0YRg7epsEdN0 |
var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://api.audiencepoint.com/v1/email-verification?email=testemail@gmail.com"); request.Headers.Add("x-api-key", "YOUR_API_KEY"); var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Result.Content.ReadAsStringAsync());
{- "Email": "testemail@yaho.con",
- "Result": "Invalid",
- "Suggestion": "testemail@yahoo.com"
}
POST request method to verify an email address
X-API-Key | string Example: 349:u1QHNv2rLn2tFdAo6TUIP8r2fnjH0YRg7epsEdN0 |
JSON Object containing a plain text email address
string A plain text email address |
{- "email": "testemail@yaho.con"
}
{- "Email": "testemail@yaho.con",
- "Result": "Invalid",
- "Suggestion": "testemail@yahoo.com"
}
Endpoint to pass an array of email addresses one wishes to subscribe to
X-API-Key | string Example: 349:u1QHNv2rLn2tFdAo6TUIP8r2fnjH0YRg7epsEdN0 |
JSON Object containing an array of plain text or SH-256 email addresses
emailAddresses | Array of strings <email address OR SHA-256> [ items <email address OR SHA-256 > ] Array of plain text or SHA-256 email addresses |
{- "emailAddresses": [
- "bigtest1@ignore.marketing",
- "bigtest2@ignore.marketing",
- "338cd750c961f2ccdd051b7b1d6d3b8c12d5f47f7d1dc31e281fa8a766aa8827",
- "invalid@email",
- "338cd750c961f2ccdd051b7b1d6d3 b8c12d5f47f7d1dc31e281fa8a766aa8827"
]
}
{- "new": 2,
- "existing": 1,
- "invalid": 2
}
Endpoint to pass an array of email addresses, start time in Coordinated Universal Time, end time in Coordinated Universal Time, and an optional default send time. This returns all the email addresses along with their send times, the start time utc, end time utc, and default send time. If default send time is not passed initially, the default send time that is returned is set to 20 minutes after the end time.
X-API-Key | string Example: 349:dLHbIMy3wBb44IQs3sHd1bNorqwwDAF8B85sdJBd |
JSON Object containing an array of plain text or SH-256 email addresses, start time utc, end time utc, and optional default send time
emailAddresses | Array of strings <email address OR SHA-256> <= 30 items [ items <email address OR SHA-256 > ] Array of plain text or SHA-256 email addresses |
startTimeUtc | datetime start time of campaign |
endTimeUtc | datetime end time of campaign |
defaultSendTime | datetime default send time if set |
{- "emailAddresses": [
- "bigtest39336@ignore.marketing",
- "testAddress2@audiencepoint.com",
- "dd302c5570d6ba576c2e3292e7f870a06583a794c34c8ebe387a6556f81481ae",
- "de7b72a8b13e4b6defd985af1fb4fddb681edd48dbca1d56bb4a86b57d26afeb"
], - "startTimeUtc": "2024-01-01T00:00:00",
- "endTimeUtc": "2024-03-10T20:00:00",
- "defaultSendTime": "2024-02-17T11:00:00"
}
[- {
- "emailAddresses": [
- {
- "email": "anthony.aardvark@audiencepoint.com",
- "sendTime": "2024-04-01T18:00:00"
}
], - "startTimeUtc": "2024-01-01T00:00:00",
- "endTimeUtc": "2024-03-10T22:00:00",
- "defaultSendTIme": "2024-02-17T11:00:00"
}
]