Create Companies
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/contacts/companies \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"globalCompanyId": "<string>",
"categoryIds": [
"<string>"
],
"domain": "<string>",
"tags": [],
"notes": "<string>",
"ratingQuality": 3,
"ratingLeadTime": 3,
"ratingPricing": 3,
"website": "<string>",
"accountNumber": "<string>",
"vatTaxId": "<string>",
"registrationNumber": "<string>",
"portalUrl": "<string>",
"portalLogin": "<string>",
"creditLimit": "<string>",
"minOrderAmount": "<string>",
"standardDiscountPct": "<string>",
"defaultLeadTimeDays": 1825
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/contacts/companies"
payload = {
"name": "<string>",
"globalCompanyId": "<string>",
"categoryIds": ["<string>"],
"domain": "<string>",
"tags": [],
"notes": "<string>",
"ratingQuality": 3,
"ratingLeadTime": 3,
"ratingPricing": 3,
"website": "<string>",
"accountNumber": "<string>",
"vatTaxId": "<string>",
"registrationNumber": "<string>",
"portalUrl": "<string>",
"portalLogin": "<string>",
"creditLimit": "<string>",
"minOrderAmount": "<string>",
"standardDiscountPct": "<string>",
"defaultLeadTimeDays": 1825
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
globalCompanyId: '<string>',
categoryIds: ['<string>'],
domain: '<string>',
tags: [],
notes: '<string>',
ratingQuality: 3,
ratingLeadTime: 3,
ratingPricing: 3,
website: '<string>',
accountNumber: '<string>',
vatTaxId: '<string>',
registrationNumber: '<string>',
portalUrl: '<string>',
portalLogin: '<string>',
creditLimit: '<string>',
minOrderAmount: '<string>',
standardDiscountPct: '<string>',
defaultLeadTimeDays: 1825
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/contacts/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.specurate.com/api/v1/workspaces/{workspaceId}/contacts/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' => '<string>',
'globalCompanyId' => '<string>',
'categoryIds' => [
'<string>'
],
'domain' => '<string>',
'tags' => [
],
'notes' => '<string>',
'ratingQuality' => 3,
'ratingLeadTime' => 3,
'ratingPricing' => 3,
'website' => '<string>',
'accountNumber' => '<string>',
'vatTaxId' => '<string>',
'registrationNumber' => '<string>',
'portalUrl' => '<string>',
'portalLogin' => '<string>',
'creditLimit' => '<string>',
'minOrderAmount' => '<string>',
'standardDiscountPct' => '<string>',
'defaultLeadTimeDays' => 1825
]),
CURLOPT_HTTPHEADER => [
"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.specurate.com/api/v1/workspaces/{workspaceId}/contacts/companies"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"globalCompanyId\": \"<string>\",\n \"categoryIds\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"tags\": [],\n \"notes\": \"<string>\",\n \"ratingQuality\": 3,\n \"ratingLeadTime\": 3,\n \"ratingPricing\": 3,\n \"website\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"vatTaxId\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"portalUrl\": \"<string>\",\n \"portalLogin\": \"<string>\",\n \"creditLimit\": \"<string>\",\n \"minOrderAmount\": \"<string>\",\n \"standardDiscountPct\": \"<string>\",\n \"defaultLeadTimeDays\": 1825\n}")
req, _ := http.NewRequest("POST", url, payload)
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.specurate.com/api/v1/workspaces/{workspaceId}/contacts/companies")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"globalCompanyId\": \"<string>\",\n \"categoryIds\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"tags\": [],\n \"notes\": \"<string>\",\n \"ratingQuality\": 3,\n \"ratingLeadTime\": 3,\n \"ratingPricing\": 3,\n \"website\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"vatTaxId\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"portalUrl\": \"<string>\",\n \"portalLogin\": \"<string>\",\n \"creditLimit\": \"<string>\",\n \"minOrderAmount\": \"<string>\",\n \"standardDiscountPct\": \"<string>\",\n \"defaultLeadTimeDays\": 1825\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/contacts/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"globalCompanyId\": \"<string>\",\n \"categoryIds\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"tags\": [],\n \"notes\": \"<string>\",\n \"ratingQuality\": 3,\n \"ratingLeadTime\": 3,\n \"ratingPricing\": 3,\n \"website\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"vatTaxId\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"portalUrl\": \"<string>\",\n \"portalLogin\": \"<string>\",\n \"creditLimit\": \"<string>\",\n \"minOrderAmount\": \"<string>\",\n \"standardDiscountPct\": \"<string>\",\n \"defaultLeadTimeDays\": 1825\n}"
response = http.request(request)
puts response.read_body{
"categories": [
{
"id": "<string>",
"name": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"domain": "<string>",
"tags": [
"<string>"
],
"status": "preferred",
"notes": "<string>",
"ratingQuality": 123,
"ratingLeadTime": 123,
"ratingPricing": 123,
"website": "<string>",
"accountNumber": "<string>",
"vatTaxId": "<string>",
"registrationNumber": "<string>",
"portalUrl": "<string>",
"portalLogin": "<string>",
"portalPasswordSet": true,
"paymentTerms": "net_30",
"creditLimit": "<string>",
"minOrderAmount": "<string>",
"standardDiscountPct": "<string>",
"defaultLeadTimeDays": 123,
"primaryPerson": {
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"identity": {
"globalCompany": {
"id": "<string>",
"name": "<string>",
"primaryType": "brand",
"legalName": "<string>",
"country": "<string>",
"aliases": [
"<string>"
],
"domains": [
"<string>"
],
"retiredAt": "<string>"
},
"version": 123,
"suggestion": {
"candidates": [
{
"company": {
"id": "<string>",
"name": "<string>",
"primaryType": "brand",
"legalName": "<string>",
"country": "<string>",
"aliases": [
"<string>"
],
"domains": [
"<string>"
],
"retiredAt": "<string>"
},
"nameMatch": true,
"matchingHosts": [
"<string>"
],
"typeMatch": true
}
],
"expectedVersion": 123,
"evidenceFingerprint": "<string>"
}
}
}Companies
Create Companies
POST
/
v1
/
workspaces
/
{workspaceId}
/
contacts
/
companies
Create Companies
curl --request POST \
--url https://app.specurate.com/api/v1/workspaces/{workspaceId}/contacts/companies \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"globalCompanyId": "<string>",
"categoryIds": [
"<string>"
],
"domain": "<string>",
"tags": [],
"notes": "<string>",
"ratingQuality": 3,
"ratingLeadTime": 3,
"ratingPricing": 3,
"website": "<string>",
"accountNumber": "<string>",
"vatTaxId": "<string>",
"registrationNumber": "<string>",
"portalUrl": "<string>",
"portalLogin": "<string>",
"creditLimit": "<string>",
"minOrderAmount": "<string>",
"standardDiscountPct": "<string>",
"defaultLeadTimeDays": 1825
}
'import requests
url = "https://app.specurate.com/api/v1/workspaces/{workspaceId}/contacts/companies"
payload = {
"name": "<string>",
"globalCompanyId": "<string>",
"categoryIds": ["<string>"],
"domain": "<string>",
"tags": [],
"notes": "<string>",
"ratingQuality": 3,
"ratingLeadTime": 3,
"ratingPricing": 3,
"website": "<string>",
"accountNumber": "<string>",
"vatTaxId": "<string>",
"registrationNumber": "<string>",
"portalUrl": "<string>",
"portalLogin": "<string>",
"creditLimit": "<string>",
"minOrderAmount": "<string>",
"standardDiscountPct": "<string>",
"defaultLeadTimeDays": 1825
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
globalCompanyId: '<string>',
categoryIds: ['<string>'],
domain: '<string>',
tags: [],
notes: '<string>',
ratingQuality: 3,
ratingLeadTime: 3,
ratingPricing: 3,
website: '<string>',
accountNumber: '<string>',
vatTaxId: '<string>',
registrationNumber: '<string>',
portalUrl: '<string>',
portalLogin: '<string>',
creditLimit: '<string>',
minOrderAmount: '<string>',
standardDiscountPct: '<string>',
defaultLeadTimeDays: 1825
})
};
fetch('https://app.specurate.com/api/v1/workspaces/{workspaceId}/contacts/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.specurate.com/api/v1/workspaces/{workspaceId}/contacts/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' => '<string>',
'globalCompanyId' => '<string>',
'categoryIds' => [
'<string>'
],
'domain' => '<string>',
'tags' => [
],
'notes' => '<string>',
'ratingQuality' => 3,
'ratingLeadTime' => 3,
'ratingPricing' => 3,
'website' => '<string>',
'accountNumber' => '<string>',
'vatTaxId' => '<string>',
'registrationNumber' => '<string>',
'portalUrl' => '<string>',
'portalLogin' => '<string>',
'creditLimit' => '<string>',
'minOrderAmount' => '<string>',
'standardDiscountPct' => '<string>',
'defaultLeadTimeDays' => 1825
]),
CURLOPT_HTTPHEADER => [
"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.specurate.com/api/v1/workspaces/{workspaceId}/contacts/companies"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"globalCompanyId\": \"<string>\",\n \"categoryIds\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"tags\": [],\n \"notes\": \"<string>\",\n \"ratingQuality\": 3,\n \"ratingLeadTime\": 3,\n \"ratingPricing\": 3,\n \"website\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"vatTaxId\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"portalUrl\": \"<string>\",\n \"portalLogin\": \"<string>\",\n \"creditLimit\": \"<string>\",\n \"minOrderAmount\": \"<string>\",\n \"standardDiscountPct\": \"<string>\",\n \"defaultLeadTimeDays\": 1825\n}")
req, _ := http.NewRequest("POST", url, payload)
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.specurate.com/api/v1/workspaces/{workspaceId}/contacts/companies")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"globalCompanyId\": \"<string>\",\n \"categoryIds\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"tags\": [],\n \"notes\": \"<string>\",\n \"ratingQuality\": 3,\n \"ratingLeadTime\": 3,\n \"ratingPricing\": 3,\n \"website\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"vatTaxId\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"portalUrl\": \"<string>\",\n \"portalLogin\": \"<string>\",\n \"creditLimit\": \"<string>\",\n \"minOrderAmount\": \"<string>\",\n \"standardDiscountPct\": \"<string>\",\n \"defaultLeadTimeDays\": 1825\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.specurate.com/api/v1/workspaces/{workspaceId}/contacts/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"globalCompanyId\": \"<string>\",\n \"categoryIds\": [\n \"<string>\"\n ],\n \"domain\": \"<string>\",\n \"tags\": [],\n \"notes\": \"<string>\",\n \"ratingQuality\": 3,\n \"ratingLeadTime\": 3,\n \"ratingPricing\": 3,\n \"website\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"vatTaxId\": \"<string>\",\n \"registrationNumber\": \"<string>\",\n \"portalUrl\": \"<string>\",\n \"portalLogin\": \"<string>\",\n \"creditLimit\": \"<string>\",\n \"minOrderAmount\": \"<string>\",\n \"standardDiscountPct\": \"<string>\",\n \"defaultLeadTimeDays\": 1825\n}"
response = http.request(request)
puts response.read_body{
"categories": [
{
"id": "<string>",
"name": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"domain": "<string>",
"tags": [
"<string>"
],
"status": "preferred",
"notes": "<string>",
"ratingQuality": 123,
"ratingLeadTime": 123,
"ratingPricing": 123,
"website": "<string>",
"accountNumber": "<string>",
"vatTaxId": "<string>",
"registrationNumber": "<string>",
"portalUrl": "<string>",
"portalLogin": "<string>",
"portalPasswordSet": true,
"paymentTerms": "net_30",
"creditLimit": "<string>",
"minOrderAmount": "<string>",
"standardDiscountPct": "<string>",
"defaultLeadTimeDays": 123,
"primaryPerson": {
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>"
},
"createdAt": "<string>",
"updatedAt": "<string>",
"identity": {
"globalCompany": {
"id": "<string>",
"name": "<string>",
"primaryType": "brand",
"legalName": "<string>",
"country": "<string>",
"aliases": [
"<string>"
],
"domains": [
"<string>"
],
"retiredAt": "<string>"
},
"version": 123,
"suggestion": {
"candidates": [
{
"company": {
"id": "<string>",
"name": "<string>",
"primaryType": "brand",
"legalName": "<string>",
"country": "<string>",
"aliases": [
"<string>"
],
"domains": [
"<string>"
],
"retiredAt": "<string>"
},
"nameMatch": true,
"matchingHosts": [
"<string>"
],
"typeMatch": true
}
],
"expectedVersion": 123,
"evidenceFingerprint": "<string>"
}
}
}Path Parameters
Body
application/json
Required string length:
1 - 255Show child attributes
Show child attributes
Pattern:
^[1-9]\d{0,18}$Maximum array length:
100Pattern:
^\d+$Maximum string length:
2048Available options:
client, manufacturer, vendor, consultants_contractors, warehouse, facility_management Available options:
preferred, approved, pending_approval, inactive Required string length:
1 - 2000Required range:
1 <= x <= 5Required range:
1 <= x <= 5Required range:
1 <= x <= 5Required string length:
1 - 2048Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 2048Required string length:
1 - 255Available options:
net_30, net_60, due_on_receipt, deposit_50 Pattern:
^\d{1,10}(\.\d{1,2})?$Pattern:
^\d{1,10}(\.\d{1,2})?$Pattern:
^\d{1,3}(\.\d{1,4})?$Required range:
0 <= x <= 3650Response
201 - application/json
Show child attributes
Show child attributes
Available options:
preferred, approved, pending_approval, inactive Available options:
net_30, net_60, due_on_receipt, deposit_50 Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I