cURL
curl --request POST \
--url https://app.revyops.com/api/public/v2/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"email": "<string>",
"linkedin_url": "<string>",
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"job_title": "<string>",
"company_id": 123,
"contact_custom_fields_input": [
{
"field_name": "<string>",
"field_value": "<string>"
}
],
"origin": "<string>",
"contact_status": "<string>",
"do_not_contact": "<string>",
"email_status_source": "<string>",
"email_status_checked_at": "2023-11-07T05:31:56Z",
"email_status_live": true
}
'import requests
url = "https://app.revyops.com/api/public/v2/contacts"
payload = {
"email": "<string>",
"linkedin_url": "<string>",
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"job_title": "<string>",
"company_id": 123,
"contact_custom_fields_input": [
{
"field_name": "<string>",
"field_value": "<string>"
}
],
"origin": "<string>",
"contact_status": "<string>",
"do_not_contact": "<string>",
"email_status_source": "<string>",
"email_status_checked_at": "2023-11-07T05:31:56Z",
"email_status_live": True
}
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({
email: '<string>',
linkedin_url: '<string>',
phone: '<string>',
first_name: '<string>',
last_name: '<string>',
job_title: '<string>',
company_id: 123,
contact_custom_fields_input: [{field_name: '<string>', field_value: '<string>'}],
origin: '<string>',
contact_status: '<string>',
do_not_contact: '<string>',
email_status_source: '<string>',
email_status_checked_at: '2023-11-07T05:31:56Z',
email_status_live: true
})
};
fetch('https://app.revyops.com/api/public/v2/contacts', 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.revyops.com/api/public/v2/contacts",
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' => '<string>',
'linkedin_url' => '<string>',
'phone' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'job_title' => '<string>',
'company_id' => 123,
'contact_custom_fields_input' => [
[
'field_name' => '<string>',
'field_value' => '<string>'
]
],
'origin' => '<string>',
'contact_status' => '<string>',
'do_not_contact' => '<string>',
'email_status_source' => '<string>',
'email_status_checked_at' => '2023-11-07T05:31:56Z',
'email_status_live' => true
]),
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.revyops.com/api/public/v2/contacts"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"job_title\": \"<string>\",\n \"company_id\": 123,\n \"contact_custom_fields_input\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ],\n \"origin\": \"<string>\",\n \"contact_status\": \"<string>\",\n \"do_not_contact\": \"<string>\",\n \"email_status_source\": \"<string>\",\n \"email_status_checked_at\": \"2023-11-07T05:31:56Z\",\n \"email_status_live\": true\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.revyops.com/api/public/v2/contacts")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"job_title\": \"<string>\",\n \"company_id\": 123,\n \"contact_custom_fields_input\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ],\n \"origin\": \"<string>\",\n \"contact_status\": \"<string>\",\n \"do_not_contact\": \"<string>\",\n \"email_status_source\": \"<string>\",\n \"email_status_checked_at\": \"2023-11-07T05:31:56Z\",\n \"email_status_live\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.revyops.com/api/public/v2/contacts")
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 \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"job_title\": \"<string>\",\n \"company_id\": 123,\n \"contact_custom_fields_input\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ],\n \"origin\": \"<string>\",\n \"contact_status\": \"<string>\",\n \"do_not_contact\": \"<string>\",\n \"email_status_source\": \"<string>\",\n \"email_status_checked_at\": \"2023-11-07T05:31:56Z\",\n \"email_status_live\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"updated_time": "2023-11-07T05:31:56Z",
"first_name": "<string>",
"last_name": "<string>",
"origin": "<string>",
"first_campaign_email_sent": "2023-11-07T05:31:56Z",
"last_campaign_email_sent": "2023-11-07T05:31:56Z",
"last_reply_received": "2023-11-07T05:31:56Z",
"previous_status": "<string>",
"status_changed_at": "2023-11-07T05:31:56Z",
"email_status": "<string>",
"email_statuses": [
{
"source": "<string>",
"status": "<string>",
"raw_value": "<string>",
"live": true,
"observed_at": "2023-11-07T05:31:56Z",
"status_changed_at": "2023-11-07T05:31:56Z"
}
],
"email": "<string>",
"linkedin_url": "<string>",
"phone": "<string>",
"job_title": "<string>",
"company_id": 123,
"contact_custom_fields": [
{
"id": 123,
"updated_time": "2023-11-07T05:31:56Z",
"field_name": "<string>",
"field_value": "<string>"
}
],
"contact_status": "<string>"
}Contacts
Create Contact
Creates a new contact using email, LinkedIn URL, phone, or multiple identifiers. company_id accepts an integer ID or a domain string to auto-resolve the company. Returns the created contact on success. With more than one of email, linkedin_url and phone in the body, email_status, email_status_source, email_status_checked_at and email_status_live are ignored; set the status afterwards with PATCH /public/v2/contacts/ on the email contact. To add an identifier to a person that already exists, send person_id with exactly one of email, linkedin_url or phone: it is saved as another contact on that person (201), returns the existing contact if the person already has the value (200), and is refused with 409 when another person holds it.
POST
/
public
/
v2
/
contacts
cURL
curl --request POST \
--url https://app.revyops.com/api/public/v2/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"email": "<string>",
"linkedin_url": "<string>",
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"job_title": "<string>",
"company_id": 123,
"contact_custom_fields_input": [
{
"field_name": "<string>",
"field_value": "<string>"
}
],
"origin": "<string>",
"contact_status": "<string>",
"do_not_contact": "<string>",
"email_status_source": "<string>",
"email_status_checked_at": "2023-11-07T05:31:56Z",
"email_status_live": true
}
'import requests
url = "https://app.revyops.com/api/public/v2/contacts"
payload = {
"email": "<string>",
"linkedin_url": "<string>",
"phone": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"job_title": "<string>",
"company_id": 123,
"contact_custom_fields_input": [
{
"field_name": "<string>",
"field_value": "<string>"
}
],
"origin": "<string>",
"contact_status": "<string>",
"do_not_contact": "<string>",
"email_status_source": "<string>",
"email_status_checked_at": "2023-11-07T05:31:56Z",
"email_status_live": True
}
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({
email: '<string>',
linkedin_url: '<string>',
phone: '<string>',
first_name: '<string>',
last_name: '<string>',
job_title: '<string>',
company_id: 123,
contact_custom_fields_input: [{field_name: '<string>', field_value: '<string>'}],
origin: '<string>',
contact_status: '<string>',
do_not_contact: '<string>',
email_status_source: '<string>',
email_status_checked_at: '2023-11-07T05:31:56Z',
email_status_live: true
})
};
fetch('https://app.revyops.com/api/public/v2/contacts', 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.revyops.com/api/public/v2/contacts",
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' => '<string>',
'linkedin_url' => '<string>',
'phone' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'job_title' => '<string>',
'company_id' => 123,
'contact_custom_fields_input' => [
[
'field_name' => '<string>',
'field_value' => '<string>'
]
],
'origin' => '<string>',
'contact_status' => '<string>',
'do_not_contact' => '<string>',
'email_status_source' => '<string>',
'email_status_checked_at' => '2023-11-07T05:31:56Z',
'email_status_live' => true
]),
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.revyops.com/api/public/v2/contacts"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"job_title\": \"<string>\",\n \"company_id\": 123,\n \"contact_custom_fields_input\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ],\n \"origin\": \"<string>\",\n \"contact_status\": \"<string>\",\n \"do_not_contact\": \"<string>\",\n \"email_status_source\": \"<string>\",\n \"email_status_checked_at\": \"2023-11-07T05:31:56Z\",\n \"email_status_live\": true\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.revyops.com/api/public/v2/contacts")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"job_title\": \"<string>\",\n \"company_id\": 123,\n \"contact_custom_fields_input\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ],\n \"origin\": \"<string>\",\n \"contact_status\": \"<string>\",\n \"do_not_contact\": \"<string>\",\n \"email_status_source\": \"<string>\",\n \"email_status_checked_at\": \"2023-11-07T05:31:56Z\",\n \"email_status_live\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.revyops.com/api/public/v2/contacts")
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 \"email\": \"<string>\",\n \"linkedin_url\": \"<string>\",\n \"phone\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"job_title\": \"<string>\",\n \"company_id\": 123,\n \"contact_custom_fields_input\": [\n {\n \"field_name\": \"<string>\",\n \"field_value\": \"<string>\"\n }\n ],\n \"origin\": \"<string>\",\n \"contact_status\": \"<string>\",\n \"do_not_contact\": \"<string>\",\n \"email_status_source\": \"<string>\",\n \"email_status_checked_at\": \"2023-11-07T05:31:56Z\",\n \"email_status_live\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"updated_time": "2023-11-07T05:31:56Z",
"first_name": "<string>",
"last_name": "<string>",
"origin": "<string>",
"first_campaign_email_sent": "2023-11-07T05:31:56Z",
"last_campaign_email_sent": "2023-11-07T05:31:56Z",
"last_reply_received": "2023-11-07T05:31:56Z",
"previous_status": "<string>",
"status_changed_at": "2023-11-07T05:31:56Z",
"email_status": "<string>",
"email_statuses": [
{
"source": "<string>",
"status": "<string>",
"raw_value": "<string>",
"live": true,
"observed_at": "2023-11-07T05:31:56Z",
"status_changed_at": "2023-11-07T05:31:56Z"
}
],
"email": "<string>",
"linkedin_url": "<string>",
"phone": "<string>",
"job_title": "<string>",
"company_id": 123,
"contact_custom_fields": [
{
"id": 123,
"updated_time": "2023-11-07T05:31:56Z",
"field_name": "<string>",
"field_value": "<string>"
}
],
"contact_status": "<string>"
}Authorizations
Query Parameters
Format of custom fields in response. NESTED returns array of objects with id, field_name, field_value. FLAT returns object with field names as keys.
Available options:
FLAT, NESTED Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Mix in before ModelSerializer. save() hands email_status to the store, whose trigger sets the column.
office- Officemobile- Mobilehome- Homedirect- Directfax- Faxurl- URLother- Other
Available options:
office, mobile, home, direct, fax, url, other Show child attributes
Show child attributes
valid- Validinvalid- Invalidrisky- Riskycatchall- Catchallunknown- Unknownbounced- Bouncedunsubscribed- Unsubscribed
Available options:
valid, invalid, risky, catchall, unknown, bounced, unsubscribed Who reported email_status: api (default), an integration such as millionverifier, or a source the workspace added. revyops is kept for hand edits in the app and is refused. With a source, email_status must be one of the standard values, and an empty email_status removes only that source's result.
When the source checked the email, ISO 8601 with a timezone such as Z or +02:00; defaults to now. A time older than the source's stored result is ignored.
True when the result comes from a real send, bounce, call or hand edit rather than a check. Defaults to false; bounced and unsubscribed are always live.
Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?