Create a company
curl --request POST \
--url https://app.alvahq.com/api/v1/companies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "",
"domain": "",
"industry": "",
"size": "",
"location": "",
"website": "",
"description": "",
"lifecycleStage": "",
"relationshipType": "",
"primaryEmail": "",
"primaryPhone": "",
"emails": [],
"phones": [],
"linkedinUrl": "",
"foundedYear": null,
"employeeCountRange": "",
"ownerId": "",
"enrichmentIcpId": "",
"tagIds": [],
"notInterestedUntil": "",
"notInterestedReason": "",
"customFields": {}
}
'import requests
url = "https://app.alvahq.com/api/v1/companies"
payload = {
"name": "",
"domain": "",
"industry": "",
"size": "",
"location": "",
"website": "",
"description": "",
"lifecycleStage": "",
"relationshipType": "",
"primaryEmail": "",
"primaryPhone": "",
"emails": [],
"phones": [],
"linkedinUrl": "",
"foundedYear": None,
"employeeCountRange": "",
"ownerId": "",
"enrichmentIcpId": "",
"tagIds": [],
"notInterestedUntil": "",
"notInterestedReason": "",
"customFields": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '',
domain: '',
industry: '',
size: '',
location: '',
website: '',
description: '',
lifecycleStage: '',
relationshipType: '',
primaryEmail: '',
primaryPhone: '',
emails: [],
phones: [],
linkedinUrl: '',
foundedYear: null,
employeeCountRange: '',
ownerId: '',
enrichmentIcpId: '',
tagIds: [],
notInterestedUntil: '',
notInterestedReason: '',
customFields: {}
})
};
fetch('https://app.alvahq.com/api/v1/companies', 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.alvahq.com/api/v1/companies",
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([
'name' => '',
'domain' => '',
'industry' => '',
'size' => '',
'location' => '',
'website' => '',
'description' => '',
'lifecycleStage' => '',
'relationshipType' => '',
'primaryEmail' => '',
'primaryPhone' => '',
'emails' => [
],
'phones' => [
],
'linkedinUrl' => '',
'foundedYear' => null,
'employeeCountRange' => '',
'ownerId' => '',
'enrichmentIcpId' => '',
'tagIds' => [
],
'notInterestedUntil' => '',
'notInterestedReason' => '',
'customFields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.alvahq.com/api/v1/companies"
payload := strings.NewReader("{\n \"name\": \"\",\n \"domain\": \"\",\n \"industry\": \"\",\n \"size\": \"\",\n \"location\": \"\",\n \"website\": \"\",\n \"description\": \"\",\n \"lifecycleStage\": \"\",\n \"relationshipType\": \"\",\n \"primaryEmail\": \"\",\n \"primaryPhone\": \"\",\n \"emails\": [],\n \"phones\": [],\n \"linkedinUrl\": \"\",\n \"foundedYear\": null,\n \"employeeCountRange\": \"\",\n \"ownerId\": \"\",\n \"enrichmentIcpId\": \"\",\n \"tagIds\": [],\n \"notInterestedUntil\": \"\",\n \"notInterestedReason\": \"\",\n \"customFields\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.alvahq.com/api/v1/companies")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"\",\n \"domain\": \"\",\n \"industry\": \"\",\n \"size\": \"\",\n \"location\": \"\",\n \"website\": \"\",\n \"description\": \"\",\n \"lifecycleStage\": \"\",\n \"relationshipType\": \"\",\n \"primaryEmail\": \"\",\n \"primaryPhone\": \"\",\n \"emails\": [],\n \"phones\": [],\n \"linkedinUrl\": \"\",\n \"foundedYear\": null,\n \"employeeCountRange\": \"\",\n \"ownerId\": \"\",\n \"enrichmentIcpId\": \"\",\n \"tagIds\": [],\n \"notInterestedUntil\": \"\",\n \"notInterestedReason\": \"\",\n \"customFields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.alvahq.com/api/v1/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"\",\n \"domain\": \"\",\n \"industry\": \"\",\n \"size\": \"\",\n \"location\": \"\",\n \"website\": \"\",\n \"description\": \"\",\n \"lifecycleStage\": \"\",\n \"relationshipType\": \"\",\n \"primaryEmail\": \"\",\n \"primaryPhone\": \"\",\n \"emails\": [],\n \"phones\": [],\n \"linkedinUrl\": \"\",\n \"foundedYear\": null,\n \"employeeCountRange\": \"\",\n \"ownerId\": \"\",\n \"enrichmentIcpId\": \"\",\n \"tagIds\": [],\n \"notInterestedUntil\": \"\",\n \"notInterestedReason\": \"\",\n \"customFields\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Acme Corporation",
"domain": "acme.com",
"industry": "Technology",
"size": "51-200",
"location": "London, UK",
"website": "https://acme.com",
"description": "<string>",
"lifecycleStage": "target",
"relationshipType": "customer",
"primaryEmail": "<string>",
"primaryPhone": "<string>",
"emails": [
"<string>"
],
"phones": [
"<string>"
],
"linkedinUrl": "<string>",
"foundedYear": 123,
"employeeCountRange": "<string>",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enrichmentIcpId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"originalName": "<string>",
"customFields": {},
"enrichmentStatus": "<string>",
"enrichmentQueuedAt": "2023-11-07T05:31:56Z",
"enrichmentCompletedAt": "2023-11-07T05:31:56Z",
"lastEnrichedAt": "2023-11-07T05:31:56Z",
"websiteSummary": "<string>",
"linkedinSummary": "<string>",
"emailPattern": "<string>",
"technologies": null,
"socialProfiles": null,
"discoverySourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inboundSource": "<string>",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notInterestedUntil": "2023-11-07T05:31:56Z",
"notInterestedReason": "<string>",
"notInterestedAt": "2023-11-07T05:31:56Z",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
],
"bdrOutreach": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agentName": "<string>",
"status": "<string>",
"lastActivityAt": "2023-11-07T05:31:56Z",
"nextActionNote": "<string>",
"nextActionNoteSource": "<string>",
"nextEvaluationAt": "2023-11-07T05:31:56Z",
"waitForEnrichment": true
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"resource": "<string>"
}{
"error": "Unauthorised",
"message": "Invalid or revoked API key"
}{
"error": "Unprocessable Entity",
"message": "Validation failed",
"details": {
"name": [
"Name is required"
]
}
}{
"error": "Too Many Requests",
"message": "Rate limit exceeded. Maximum 100 requests per minute.",
"retryAfter": 30
}Companies
Create a company
Create a new company in your CRM.
POST
/
api
/
v1
/
companies
Create a company
curl --request POST \
--url https://app.alvahq.com/api/v1/companies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "",
"domain": "",
"industry": "",
"size": "",
"location": "",
"website": "",
"description": "",
"lifecycleStage": "",
"relationshipType": "",
"primaryEmail": "",
"primaryPhone": "",
"emails": [],
"phones": [],
"linkedinUrl": "",
"foundedYear": null,
"employeeCountRange": "",
"ownerId": "",
"enrichmentIcpId": "",
"tagIds": [],
"notInterestedUntil": "",
"notInterestedReason": "",
"customFields": {}
}
'import requests
url = "https://app.alvahq.com/api/v1/companies"
payload = {
"name": "",
"domain": "",
"industry": "",
"size": "",
"location": "",
"website": "",
"description": "",
"lifecycleStage": "",
"relationshipType": "",
"primaryEmail": "",
"primaryPhone": "",
"emails": [],
"phones": [],
"linkedinUrl": "",
"foundedYear": None,
"employeeCountRange": "",
"ownerId": "",
"enrichmentIcpId": "",
"tagIds": [],
"notInterestedUntil": "",
"notInterestedReason": "",
"customFields": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '',
domain: '',
industry: '',
size: '',
location: '',
website: '',
description: '',
lifecycleStage: '',
relationshipType: '',
primaryEmail: '',
primaryPhone: '',
emails: [],
phones: [],
linkedinUrl: '',
foundedYear: null,
employeeCountRange: '',
ownerId: '',
enrichmentIcpId: '',
tagIds: [],
notInterestedUntil: '',
notInterestedReason: '',
customFields: {}
})
};
fetch('https://app.alvahq.com/api/v1/companies', 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.alvahq.com/api/v1/companies",
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([
'name' => '',
'domain' => '',
'industry' => '',
'size' => '',
'location' => '',
'website' => '',
'description' => '',
'lifecycleStage' => '',
'relationshipType' => '',
'primaryEmail' => '',
'primaryPhone' => '',
'emails' => [
],
'phones' => [
],
'linkedinUrl' => '',
'foundedYear' => null,
'employeeCountRange' => '',
'ownerId' => '',
'enrichmentIcpId' => '',
'tagIds' => [
],
'notInterestedUntil' => '',
'notInterestedReason' => '',
'customFields' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.alvahq.com/api/v1/companies"
payload := strings.NewReader("{\n \"name\": \"\",\n \"domain\": \"\",\n \"industry\": \"\",\n \"size\": \"\",\n \"location\": \"\",\n \"website\": \"\",\n \"description\": \"\",\n \"lifecycleStage\": \"\",\n \"relationshipType\": \"\",\n \"primaryEmail\": \"\",\n \"primaryPhone\": \"\",\n \"emails\": [],\n \"phones\": [],\n \"linkedinUrl\": \"\",\n \"foundedYear\": null,\n \"employeeCountRange\": \"\",\n \"ownerId\": \"\",\n \"enrichmentIcpId\": \"\",\n \"tagIds\": [],\n \"notInterestedUntil\": \"\",\n \"notInterestedReason\": \"\",\n \"customFields\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.alvahq.com/api/v1/companies")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"\",\n \"domain\": \"\",\n \"industry\": \"\",\n \"size\": \"\",\n \"location\": \"\",\n \"website\": \"\",\n \"description\": \"\",\n \"lifecycleStage\": \"\",\n \"relationshipType\": \"\",\n \"primaryEmail\": \"\",\n \"primaryPhone\": \"\",\n \"emails\": [],\n \"phones\": [],\n \"linkedinUrl\": \"\",\n \"foundedYear\": null,\n \"employeeCountRange\": \"\",\n \"ownerId\": \"\",\n \"enrichmentIcpId\": \"\",\n \"tagIds\": [],\n \"notInterestedUntil\": \"\",\n \"notInterestedReason\": \"\",\n \"customFields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.alvahq.com/api/v1/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"\",\n \"domain\": \"\",\n \"industry\": \"\",\n \"size\": \"\",\n \"location\": \"\",\n \"website\": \"\",\n \"description\": \"\",\n \"lifecycleStage\": \"\",\n \"relationshipType\": \"\",\n \"primaryEmail\": \"\",\n \"primaryPhone\": \"\",\n \"emails\": [],\n \"phones\": [],\n \"linkedinUrl\": \"\",\n \"foundedYear\": null,\n \"employeeCountRange\": \"\",\n \"ownerId\": \"\",\n \"enrichmentIcpId\": \"\",\n \"tagIds\": [],\n \"notInterestedUntil\": \"\",\n \"notInterestedReason\": \"\",\n \"customFields\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Acme Corporation",
"domain": "acme.com",
"industry": "Technology",
"size": "51-200",
"location": "London, UK",
"website": "https://acme.com",
"description": "<string>",
"lifecycleStage": "target",
"relationshipType": "customer",
"primaryEmail": "<string>",
"primaryPhone": "<string>",
"emails": [
"<string>"
],
"phones": [
"<string>"
],
"linkedinUrl": "<string>",
"foundedYear": 123,
"employeeCountRange": "<string>",
"ownerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enrichmentIcpId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"originalName": "<string>",
"customFields": {},
"enrichmentStatus": "<string>",
"enrichmentQueuedAt": "2023-11-07T05:31:56Z",
"enrichmentCompletedAt": "2023-11-07T05:31:56Z",
"lastEnrichedAt": "2023-11-07T05:31:56Z",
"websiteSummary": "<string>",
"linkedinSummary": "<string>",
"emailPattern": "<string>",
"technologies": null,
"socialProfiles": null,
"discoverySourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"inboundSource": "<string>",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notInterestedUntil": "2023-11-07T05:31:56Z",
"notInterestedReason": "<string>",
"notInterestedAt": "2023-11-07T05:31:56Z",
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
],
"bdrOutreach": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agentName": "<string>",
"status": "<string>",
"lastActivityAt": "2023-11-07T05:31:56Z",
"nextActionNote": "<string>",
"nextActionNoteSource": "<string>",
"nextEvaluationAt": "2023-11-07T05:31:56Z",
"waitForEnrichment": true
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"resource": "<string>"
}{
"error": "Unauthorised",
"message": "Invalid or revoked API key"
}{
"error": "Unprocessable Entity",
"message": "Validation failed",
"details": {
"name": [
"Name is required"
]
}
}{
"error": "Too Many Requests",
"message": "Rate limit exceeded. Maximum 100 requests per minute.",
"retryAfter": 30
}Authorizations
API key from Settings > Developer. Format: alva_sk_...
Body
application/json
Fields marked "required" must be provided; all others are optional. In the interactive playground (the "Test Request" panel) the JSON body is fully editable — type over any value and delete the properties you don't need. Blank fields are ignored, so only the values you provide are sent.
Available options:
target, prospect, lead, customer, evaluating, engaging, negotiating, vendor, partner, supplier Available options:
customer, vendor, partner, supplier, competitor Replaces the company tags. Omit to leave tags unchanged.
Null clears the hold.