Companies
Merge companies
Merges the source company into a target company. All contacts and data are moved to the target; the source is deleted.
POST
/
api
/
v1
/
accounts
/
{account_id}
/
companies
/
{id}
/
merge
Merge companies
curl --request POST \
--url https://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"target_company_id": 15
}
'import requests
url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge"
payload = { "target_company_id": 15 }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({target_company_id: 15})
};
fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge', 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://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge",
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([
'target_company_id' => 15
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_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://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge"
payload := strings.NewReader("{\n \"target_company_id\": 15\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_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://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"target_company_id\": 15\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target_company_id\": 15\n}"
response = http.request(request)
puts response.read_body{
"id": 10,
"name": "Acme Corp",
"domain": "acme.com",
"description": "Global leader in widgets.",
"custom_attributes": {
"industry": "Technology",
"annual_revenue": 500000
},
"contacts_count": 5,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}{
"errors": {
"name": [
"can't be blank"
]
}
}Authorizations
API access token for authentication. Obtain from your Voxys Connect profile settings.
Path Parameters
The numeric ID of the account.
The ID of the source company (will be deleted after merge).
Body
application/json
The ID of the company that will survive the merge. The source company will be deleted.
Example:
15
Response
Merge completed. Returns the surviving target company.
Example:
10
Example:
"Acme Corp"
Example:
"acme.com"
Example:
"Global leader in widgets."
Flexible key-value map of custom attributes defined for the account.
Example:
{
"industry": "Technology",
"annual_revenue": 500000
}
Example:
5
⌘I
Merge companies
curl --request POST \
--url https://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '
{
"target_company_id": 15
}
'import requests
url = "https://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge"
payload = { "target_company_id": 15 }
headers = {
"api_access_token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({target_company_id: 15})
};
fetch('https://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge', 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://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge",
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([
'target_company_id' => 15
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"api_access_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://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge"
payload := strings.NewReader("{\n \"target_company_id\": 15\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_access_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://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge")
.header("api_access_token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"target_company_id\": 15\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://connect.voxys.ai/api/v1/accounts/{account_id}/companies/{id}/merge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"target_company_id\": 15\n}"
response = http.request(request)
puts response.read_body{
"id": 10,
"name": "Acme Corp",
"domain": "acme.com",
"description": "Global leader in widgets.",
"custom_attributes": {
"industry": "Technology",
"annual_revenue": 500000
},
"contacts_count": 5,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}{
"errors": {
"name": [
"can't be blank"
]
}
}
