curl --request POST \
--url https://app.pipecorn.com/api/v2/contacts/report_email \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"linkedin_url": "https://www.linkedin.com/in/william-hewish",
"email": "william.hewish@acme.com",
"find_replacement": true,
"webhook_url": "<string>"
}
'import requests
url = "https://app.pipecorn.com/api/v2/contacts/report_email"
payload = {
"linkedin_url": "https://www.linkedin.com/in/william-hewish",
"email": "william.hewish@acme.com",
"find_replacement": True,
"webhook_url": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
linkedin_url: 'https://www.linkedin.com/in/william-hewish',
email: 'william.hewish@acme.com',
find_replacement: true,
webhook_url: '<string>'
})
};
fetch('https://app.pipecorn.com/api/v2/contacts/report_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://app.pipecorn.com/api/v2/contacts/report_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([
'linkedin_url' => 'https://www.linkedin.com/in/william-hewish',
'email' => 'william.hewish@acme.com',
'find_replacement' => true,
'webhook_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <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://app.pipecorn.com/api/v2/contacts/report_email"
payload := strings.NewReader("{\n \"linkedin_url\": \"https://www.linkedin.com/in/william-hewish\",\n \"email\": \"william.hewish@acme.com\",\n \"find_replacement\": true,\n \"webhook_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<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://app.pipecorn.com/api/v2/contacts/report_email")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"linkedin_url\": \"https://www.linkedin.com/in/william-hewish\",\n \"email\": \"william.hewish@acme.com\",\n \"find_replacement\": true,\n \"webhook_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pipecorn.com/api/v2/contacts/report_email")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"linkedin_url\": \"https://www.linkedin.com/in/william-hewish\",\n \"email\": \"william.hewish@acme.com\",\n \"find_replacement\": true,\n \"webhook_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"enrichment_id": "8f1c2a4e-5b6d-4e7f-9a0b-1c2d3e4f5a6b",
"reported": true,
"replacement": "searching",
"status_url": "https://app.pipecorn.com/api/v2/contacts/8f1c2a4e-5b6d-4e7f-9a0b-1c2d3e4f5a6b"
}{
"error": "Missing required keys: reason"
}{
"error": "Email not found on this contact"
}{
"error": "A request with this Idempotency-Key is still being processed",
"code": "idempotency_key_in_use"
}{
"error": "Invalid email, use a full address (e.g. jane@acme.com)"
}Report a wrong email address
Flag an email Pipecorn returned as wrong and search for another one
curl --request POST \
--url https://app.pipecorn.com/api/v2/contacts/report_email \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"linkedin_url": "https://www.linkedin.com/in/william-hewish",
"email": "william.hewish@acme.com",
"find_replacement": true,
"webhook_url": "<string>"
}
'import requests
url = "https://app.pipecorn.com/api/v2/contacts/report_email"
payload = {
"linkedin_url": "https://www.linkedin.com/in/william-hewish",
"email": "william.hewish@acme.com",
"find_replacement": True,
"webhook_url": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
linkedin_url: 'https://www.linkedin.com/in/william-hewish',
email: 'william.hewish@acme.com',
find_replacement: true,
webhook_url: '<string>'
})
};
fetch('https://app.pipecorn.com/api/v2/contacts/report_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://app.pipecorn.com/api/v2/contacts/report_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([
'linkedin_url' => 'https://www.linkedin.com/in/william-hewish',
'email' => 'william.hewish@acme.com',
'find_replacement' => true,
'webhook_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <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://app.pipecorn.com/api/v2/contacts/report_email"
payload := strings.NewReader("{\n \"linkedin_url\": \"https://www.linkedin.com/in/william-hewish\",\n \"email\": \"william.hewish@acme.com\",\n \"find_replacement\": true,\n \"webhook_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<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://app.pipecorn.com/api/v2/contacts/report_email")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"linkedin_url\": \"https://www.linkedin.com/in/william-hewish\",\n \"email\": \"william.hewish@acme.com\",\n \"find_replacement\": true,\n \"webhook_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.pipecorn.com/api/v2/contacts/report_email")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"linkedin_url\": \"https://www.linkedin.com/in/william-hewish\",\n \"email\": \"william.hewish@acme.com\",\n \"find_replacement\": true,\n \"webhook_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"enrichment_id": "8f1c2a4e-5b6d-4e7f-9a0b-1c2d3e4f5a6b",
"reported": true,
"replacement": "searching",
"status_url": "https://app.pipecorn.com/api/v2/contacts/8f1c2a4e-5b6d-4e7f-9a0b-1c2d3e4f5a6b"
}{
"error": "Missing required keys: reason"
}{
"error": "Email not found on this contact"
}{
"error": "A request with this Idempotency-Key is still being processed",
"code": "idempotency_key_in_use"
}{
"error": "Invalid email, use a full address (e.g. jane@acme.com)"
}Flow
- Send the contact’s
linkedin_url, the wrongemailand areason. - The response says whether a new search started (
replacement: "searching"). - Poll
status_urluntilstatusisfinished, or wait for the webhook. It carries the new address inemail(orpersonal_email), or no address when none was found.
curl -X POST https://app.pipecorn.com/api/v2/contacts/report_email \
-H "X-API-Key: $PIPECORN_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"linkedin_url": "https://www.linkedin.com/in/william-hewish",
"email": "william.hewish@acme.com",
"reason": "wrong_domain",
"webhook_url": "https://example.com/pipecorn/emails"
}'
Credits
Reporting is free. The new search costs what an enrichment of the same type costs, and only when it finds an address: 3 credits for a work email, 9 for a personal email. A personal email search also needs the account’s consent to personal email enrichment. Send"find_replacement": false to report the
address without searching.Authorizations
Your API key
Headers
A unique value you generate per operation, such as a UUID. Retrying with the same key and the same body returns the stored response instead of running the request again, so a retry after a timeout never charges twice. Successful responses are kept for 24 hours; a failed request is not stored and can be retried with the same key.
255"4f1c2e9a-8a7d-4c1b-9f63-2d6e0b5a7c11"
Body
LinkedIn profile URL of the contact, as sent to the enrichment.
"https://www.linkedin.com/in/william-hewish"
The wrong address, as Pipecorn returned it: a work email or a personal email. Use the full address.
"william.hewish@acme.com"
invalid_address: the address bounces or does not exist. wrong_domain: the address is at a company the person no longer works for, or at the wrong company. wrong_person: the address belongs to someone else.
invalid_address, wrong_domain, wrong_person Search for another address. Send false to only report the address.
Where to send the result of the new search. Defaults to the webhook_url of the original enrichment.
Response
The address is reported
The contact's enrichment ID, for GET /contacts/{id}
Always true
searching: a new email search of the same type is running. other_email_kept: the contact still has another verified email of the same type, so no search ran. not_allowed: your plan or role does not allow this email enrichment, or the account has not consented to personal email enrichment. insufficient_credits: fewer credits left than the search costs (3 for a work email, 9 for a personal email). skipped: you sent find_replacement: false.
searching, other_email_kept, not_allowed, insufficient_credits, skipped GET /contacts/{id} for this contact
Was this page helpful?