Initiate contact email verification
curl --request POST \
--url https://core-api.getaptly.com/api/contacts/verify-email \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"email": "[email protected]",
"emailSubject": "Your access code",
"replyTo": "[email protected]",
"emailHtml": "<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>"
}
'import requests
url = "https://core-api.getaptly.com/api/contacts/verify-email"
payload = {
"email": "[email protected]",
"emailSubject": "Your access code",
"replyTo": "[email protected]",
"emailHtml": "<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>"
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '[email protected]',
emailSubject: 'Your access code',
replyTo: '[email protected]',
emailHtml: '<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>'
})
};
fetch('https://core-api.getaptly.com/api/contacts/verify-email', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core-api.getaptly.com/api/contacts/verify-email",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '[email protected]',
'emailSubject' => 'Your access code',
'replyTo' => '[email protected]',
'emailHtml' => '<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/contacts/verify-email"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"emailSubject\": \"Your access code\",\n \"replyTo\": \"[email protected]\",\n \"emailHtml\": \"<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://core-api.getaptly.com/api/contacts/verify-email")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"emailSubject\": \"Your access code\",\n \"replyTo\": \"[email protected]\",\n \"emailHtml\": \"<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/contacts/verify-email")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"emailSubject\": \"Your access code\",\n \"replyTo\": \"[email protected]\",\n \"emailHtml\": \"<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>\"\n}"
response = http.request(request)
puts response.read_body{
"requestId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"verifyUrl": "/api/contacts/verify-email/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4/confirm"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Contacts
Initiate contact email verification
Looks up an email address against your org’s contact database. If a match is found,
generates a cryptographically strong 6-digit code, sends it to the address, and
returns a requestId and verifyUrl to complete the verification.
The code expires after 10 minutes and can only be used once.
POST
/
api
/
contacts
/
verify-email
Initiate contact email verification
curl --request POST \
--url https://core-api.getaptly.com/api/contacts/verify-email \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"email": "[email protected]",
"emailSubject": "Your access code",
"replyTo": "[email protected]",
"emailHtml": "<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>"
}
'import requests
url = "https://core-api.getaptly.com/api/contacts/verify-email"
payload = {
"email": "[email protected]",
"emailSubject": "Your access code",
"replyTo": "[email protected]",
"emailHtml": "<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>"
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '[email protected]',
emailSubject: 'Your access code',
replyTo: '[email protected]',
emailHtml: '<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>'
})
};
fetch('https://core-api.getaptly.com/api/contacts/verify-email', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core-api.getaptly.com/api/contacts/verify-email",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '[email protected]',
'emailSubject' => 'Your access code',
'replyTo' => '[email protected]',
'emailHtml' => '<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/contacts/verify-email"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"emailSubject\": \"Your access code\",\n \"replyTo\": \"[email protected]\",\n \"emailHtml\": \"<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://core-api.getaptly.com/api/contacts/verify-email")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"emailSubject\": \"Your access code\",\n \"replyTo\": \"[email protected]\",\n \"emailHtml\": \"<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/contacts/verify-email")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"[email protected]\",\n \"emailSubject\": \"Your access code\",\n \"replyTo\": \"[email protected]\",\n \"emailHtml\": \"<p>Your code is <strong>{{ verificationCode }}</strong>. It expires in {{ expirationTime }}.</p>\"\n}"
response = http.request(request)
puts response.read_body{
"requestId": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"verifyUrl": "/api/contacts/verify-email/a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4/confirm"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
ApiKeyHeaderDelegateToken
Body
application/json
The email address to verify.
Subject line for the verification email. Defaults to "Your verification code".
Reply-To address for the verification email.
Custom HTML body for the verification email. Supports two placeholders:
{{ verificationCode }} — replaced with the 6-digit code.
{{ expirationTime }} — replaced with the expiry duration (e.g. "10 minutes").
⌘I