Create or resolve an account
Creates an account from a domain, or returns the existing account when the domain is already present. Additional account fields are persisted as system or custom attributes when supported.
POST
/
v1
/
accounts
Create or resolve an account
curl --request POST \
--url https://api.octolane.com/v1/accounts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"domain": "acme.com",
"name": "Acme",
"industry": "<string>",
"logo": "<string>",
"linkedin": "<string>",
"twitter": "<string>",
"twitter_followers": 123,
"description": "<string>",
"primary_location": "<string>",
"founded": 5499.5,
"estimated_revenue": 123,
"total_fund_raised": 123,
"employee_range": "<string>",
"type": "<string>",
"tags": [
"<string>"
],
"first_email_interaction": "2023-11-07T05:31:56Z",
"last_email_interaction": "2023-11-07T05:31:56Z",
"first_meeting_interaction": "2023-11-07T05:31:56Z",
"last_meeting_interaction": "2023-11-07T05:31:56Z",
"last_interaction": "2023-11-07T05:31:56Z",
"next_meeting": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.octolane.com/v1/accounts"
payload = {
"domain": "acme.com",
"name": "Acme",
"industry": "<string>",
"logo": "<string>",
"linkedin": "<string>",
"twitter": "<string>",
"twitter_followers": 123,
"description": "<string>",
"primary_location": "<string>",
"founded": 5499.5,
"estimated_revenue": 123,
"total_fund_raised": 123,
"employee_range": "<string>",
"type": "<string>",
"tags": ["<string>"],
"first_email_interaction": "2023-11-07T05:31:56Z",
"last_email_interaction": "2023-11-07T05:31:56Z",
"first_meeting_interaction": "2023-11-07T05:31:56Z",
"last_meeting_interaction": "2023-11-07T05:31:56Z",
"last_interaction": "2023-11-07T05:31:56Z",
"next_meeting": "2023-11-07T05:31:56Z"
}
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({
domain: 'acme.com',
name: 'Acme',
industry: '<string>',
logo: '<string>',
linkedin: '<string>',
twitter: '<string>',
twitter_followers: 123,
description: '<string>',
primary_location: '<string>',
founded: 5499.5,
estimated_revenue: 123,
total_fund_raised: 123,
employee_range: '<string>',
type: '<string>',
tags: ['<string>'],
first_email_interaction: '2023-11-07T05:31:56Z',
last_email_interaction: '2023-11-07T05:31:56Z',
first_meeting_interaction: '2023-11-07T05:31:56Z',
last_meeting_interaction: '2023-11-07T05:31:56Z',
last_interaction: '2023-11-07T05:31:56Z',
next_meeting: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.octolane.com/v1/accounts', 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://api.octolane.com/v1/accounts",
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([
'domain' => 'acme.com',
'name' => 'Acme',
'industry' => '<string>',
'logo' => '<string>',
'linkedin' => '<string>',
'twitter' => '<string>',
'twitter_followers' => 123,
'description' => '<string>',
'primary_location' => '<string>',
'founded' => 5499.5,
'estimated_revenue' => 123,
'total_fund_raised' => 123,
'employee_range' => '<string>',
'type' => '<string>',
'tags' => [
'<string>'
],
'first_email_interaction' => '2023-11-07T05:31:56Z',
'last_email_interaction' => '2023-11-07T05:31:56Z',
'first_meeting_interaction' => '2023-11-07T05:31:56Z',
'last_meeting_interaction' => '2023-11-07T05:31:56Z',
'last_interaction' => '2023-11-07T05:31:56Z',
'next_meeting' => '2023-11-07T05:31:56Z'
]),
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://api.octolane.com/v1/accounts"
payload := strings.NewReader("{\n \"domain\": \"acme.com\",\n \"name\": \"Acme\",\n \"industry\": \"<string>\",\n \"logo\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"twitter_followers\": 123,\n \"description\": \"<string>\",\n \"primary_location\": \"<string>\",\n \"founded\": 5499.5,\n \"estimated_revenue\": 123,\n \"total_fund_raised\": 123,\n \"employee_range\": \"<string>\",\n \"type\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"first_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"first_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_interaction\": \"2023-11-07T05:31:56Z\",\n \"next_meeting\": \"2023-11-07T05:31:56Z\"\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://api.octolane.com/v1/accounts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"acme.com\",\n \"name\": \"Acme\",\n \"industry\": \"<string>\",\n \"logo\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"twitter_followers\": 123,\n \"description\": \"<string>\",\n \"primary_location\": \"<string>\",\n \"founded\": 5499.5,\n \"estimated_revenue\": 123,\n \"total_fund_raised\": 123,\n \"employee_range\": \"<string>\",\n \"type\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"first_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"first_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_interaction\": \"2023-11-07T05:31:56Z\",\n \"next_meeting\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.octolane.com/v1/accounts")
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 \"domain\": \"acme.com\",\n \"name\": \"Acme\",\n \"industry\": \"<string>\",\n \"logo\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"twitter_followers\": 123,\n \"description\": \"<string>\",\n \"primary_location\": \"<string>\",\n \"founded\": 5499.5,\n \"estimated_revenue\": 123,\n \"total_fund_raised\": 123,\n \"employee_range\": \"<string>\",\n \"type\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"first_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"first_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_interaction\": \"2023-11-07T05:31:56Z\",\n \"next_meeting\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": "<unknown>"
}{
"success": true,
"message": "<string>",
"data": "<unknown>"
}{
"success": false,
"message": "Validation failed",
"statusCode": 400
}{
"success": false,
"message": "Validation failed",
"statusCode": 400
}{
"success": false,
"message": "Validation failed",
"statusCode": 400
}Also use this to look up an account by domain. This endpoint is idempotent. If an account with the given
domain already exists, it returns that existing account instead of creating a duplicate. So sending a POST with just a domain is a safe way to resolve or fetch an account by its domain.Need to find accounts by other criteria, or match many at once? Use Search accounts for filtered search.Authorizations
Personal API key. Requests act as the workspace member who created the key, with that member's current access, and stop working when the key is disabled or its creator leaves the workspace.
Body
application/json
Account payload.
Company domain.
Example:
"acme.com"
Example:
"Acme"
Required range:
1000 <= x <= 9999Was this page helpful?
⌘I
Create or resolve an account
curl --request POST \
--url https://api.octolane.com/v1/accounts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"domain": "acme.com",
"name": "Acme",
"industry": "<string>",
"logo": "<string>",
"linkedin": "<string>",
"twitter": "<string>",
"twitter_followers": 123,
"description": "<string>",
"primary_location": "<string>",
"founded": 5499.5,
"estimated_revenue": 123,
"total_fund_raised": 123,
"employee_range": "<string>",
"type": "<string>",
"tags": [
"<string>"
],
"first_email_interaction": "2023-11-07T05:31:56Z",
"last_email_interaction": "2023-11-07T05:31:56Z",
"first_meeting_interaction": "2023-11-07T05:31:56Z",
"last_meeting_interaction": "2023-11-07T05:31:56Z",
"last_interaction": "2023-11-07T05:31:56Z",
"next_meeting": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.octolane.com/v1/accounts"
payload = {
"domain": "acme.com",
"name": "Acme",
"industry": "<string>",
"logo": "<string>",
"linkedin": "<string>",
"twitter": "<string>",
"twitter_followers": 123,
"description": "<string>",
"primary_location": "<string>",
"founded": 5499.5,
"estimated_revenue": 123,
"total_fund_raised": 123,
"employee_range": "<string>",
"type": "<string>",
"tags": ["<string>"],
"first_email_interaction": "2023-11-07T05:31:56Z",
"last_email_interaction": "2023-11-07T05:31:56Z",
"first_meeting_interaction": "2023-11-07T05:31:56Z",
"last_meeting_interaction": "2023-11-07T05:31:56Z",
"last_interaction": "2023-11-07T05:31:56Z",
"next_meeting": "2023-11-07T05:31:56Z"
}
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({
domain: 'acme.com',
name: 'Acme',
industry: '<string>',
logo: '<string>',
linkedin: '<string>',
twitter: '<string>',
twitter_followers: 123,
description: '<string>',
primary_location: '<string>',
founded: 5499.5,
estimated_revenue: 123,
total_fund_raised: 123,
employee_range: '<string>',
type: '<string>',
tags: ['<string>'],
first_email_interaction: '2023-11-07T05:31:56Z',
last_email_interaction: '2023-11-07T05:31:56Z',
first_meeting_interaction: '2023-11-07T05:31:56Z',
last_meeting_interaction: '2023-11-07T05:31:56Z',
last_interaction: '2023-11-07T05:31:56Z',
next_meeting: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.octolane.com/v1/accounts', 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://api.octolane.com/v1/accounts",
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([
'domain' => 'acme.com',
'name' => 'Acme',
'industry' => '<string>',
'logo' => '<string>',
'linkedin' => '<string>',
'twitter' => '<string>',
'twitter_followers' => 123,
'description' => '<string>',
'primary_location' => '<string>',
'founded' => 5499.5,
'estimated_revenue' => 123,
'total_fund_raised' => 123,
'employee_range' => '<string>',
'type' => '<string>',
'tags' => [
'<string>'
],
'first_email_interaction' => '2023-11-07T05:31:56Z',
'last_email_interaction' => '2023-11-07T05:31:56Z',
'first_meeting_interaction' => '2023-11-07T05:31:56Z',
'last_meeting_interaction' => '2023-11-07T05:31:56Z',
'last_interaction' => '2023-11-07T05:31:56Z',
'next_meeting' => '2023-11-07T05:31:56Z'
]),
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://api.octolane.com/v1/accounts"
payload := strings.NewReader("{\n \"domain\": \"acme.com\",\n \"name\": \"Acme\",\n \"industry\": \"<string>\",\n \"logo\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"twitter_followers\": 123,\n \"description\": \"<string>\",\n \"primary_location\": \"<string>\",\n \"founded\": 5499.5,\n \"estimated_revenue\": 123,\n \"total_fund_raised\": 123,\n \"employee_range\": \"<string>\",\n \"type\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"first_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"first_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_interaction\": \"2023-11-07T05:31:56Z\",\n \"next_meeting\": \"2023-11-07T05:31:56Z\"\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://api.octolane.com/v1/accounts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"acme.com\",\n \"name\": \"Acme\",\n \"industry\": \"<string>\",\n \"logo\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"twitter_followers\": 123,\n \"description\": \"<string>\",\n \"primary_location\": \"<string>\",\n \"founded\": 5499.5,\n \"estimated_revenue\": 123,\n \"total_fund_raised\": 123,\n \"employee_range\": \"<string>\",\n \"type\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"first_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"first_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_interaction\": \"2023-11-07T05:31:56Z\",\n \"next_meeting\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.octolane.com/v1/accounts")
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 \"domain\": \"acme.com\",\n \"name\": \"Acme\",\n \"industry\": \"<string>\",\n \"logo\": \"<string>\",\n \"linkedin\": \"<string>\",\n \"twitter\": \"<string>\",\n \"twitter_followers\": 123,\n \"description\": \"<string>\",\n \"primary_location\": \"<string>\",\n \"founded\": 5499.5,\n \"estimated_revenue\": 123,\n \"total_fund_raised\": 123,\n \"employee_range\": \"<string>\",\n \"type\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"first_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_email_interaction\": \"2023-11-07T05:31:56Z\",\n \"first_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_meeting_interaction\": \"2023-11-07T05:31:56Z\",\n \"last_interaction\": \"2023-11-07T05:31:56Z\",\n \"next_meeting\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": "<unknown>"
}{
"success": true,
"message": "<string>",
"data": "<unknown>"
}{
"success": false,
"message": "Validation failed",
"statusCode": 400
}{
"success": false,
"message": "Validation failed",
"statusCode": 400
}{
"success": false,
"message": "Validation failed",
"statusCode": 400
}