Create company
curl --request POST \
--url https://api.upwell.com/api/rest/companies \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"addresses": {
"data": [
{
"canonicalAddressId": "<string>",
"city": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"customerId": "<string>",
"locationCodeId": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"zipOrPostalCode": "<string>"
}
]
},
"dunsNumber": "<string>",
"logoUrl": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"primaryEmailAddress": "<string>",
"primaryPhone": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"termsOfService": "<string>",
"website": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/companies"
payload = { "input": {
"addresses": { "data": [
{
"canonicalAddressId": "<string>",
"city": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"customerId": "<string>",
"locationCodeId": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"zipOrPostalCode": "<string>"
}
] },
"dunsNumber": "<string>",
"logoUrl": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"primaryEmailAddress": "<string>",
"primaryPhone": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"termsOfService": "<string>",
"website": "<string>"
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
input: {
addresses: {
data: [
{
canonicalAddressId: '<string>',
city: '<string>',
companyId: '<string>',
companyName: '<string>',
customerId: '<string>',
locationCodeId: '<string>',
name: '<string>',
phoneNumber: '<string>',
stateOrProvince: '<string>',
streetLine1: '<string>',
streetLine2: '<string>',
streetLine3: '<string>',
zipOrPostalCode: '<string>'
}
]
},
dunsNumber: '<string>',
logoUrl: '<string>',
mcNumber: '<string>',
name: '<string>',
primaryEmailAddress: '<string>',
primaryPhone: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
sourceSystemMeta: '<unknown>',
termsOfService: '<string>',
website: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/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://api.upwell.com/api/rest/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([
'input' => [
'addresses' => [
'data' => [
[
'canonicalAddressId' => '<string>',
'city' => '<string>',
'companyId' => '<string>',
'companyName' => '<string>',
'customerId' => '<string>',
'locationCodeId' => '<string>',
'name' => '<string>',
'phoneNumber' => '<string>',
'stateOrProvince' => '<string>',
'streetLine1' => '<string>',
'streetLine2' => '<string>',
'streetLine3' => '<string>',
'zipOrPostalCode' => '<string>'
]
]
],
'dunsNumber' => '<string>',
'logoUrl' => '<string>',
'mcNumber' => '<string>',
'name' => '<string>',
'primaryEmailAddress' => '<string>',
'primaryPhone' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'sourceSystemMeta' => '<unknown>',
'termsOfService' => '<string>',
'website' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.upwell.com/api/rest/companies"
payload := strings.NewReader("{\n \"input\": {\n \"addresses\": {\n \"data\": [\n {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n ]\n },\n \"dunsNumber\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"primaryEmailAddress\": \"<string>\",\n \"primaryPhone\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"termsOfService\": \"<string>\",\n \"website\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.upwell.com/api/rest/companies")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"input\": {\n \"addresses\": {\n \"data\": [\n {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n ]\n },\n \"dunsNumber\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"primaryEmailAddress\": \"<string>\",\n \"primaryPhone\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"termsOfService\": \"<string>\",\n \"website\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"input\": {\n \"addresses\": {\n \"data\": [\n {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n ]\n },\n \"dunsNumber\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"primaryEmailAddress\": \"<string>\",\n \"primaryPhone\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"termsOfService\": \"<string>\",\n \"website\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"createCompany": {
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"dunsNumber": "<string>",
"id": "<string>",
"logoUrl": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"primaryEmailAddress": "<string>",
"primaryPhone": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"termsOfService": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"website": "<string>"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}Companies
Create company
Create a new company record.
POST
/
api
/
rest
/
companies
Create company
curl --request POST \
--url https://api.upwell.com/api/rest/companies \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"addresses": {
"data": [
{
"canonicalAddressId": "<string>",
"city": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"customerId": "<string>",
"locationCodeId": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"zipOrPostalCode": "<string>"
}
]
},
"dunsNumber": "<string>",
"logoUrl": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"primaryEmailAddress": "<string>",
"primaryPhone": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"termsOfService": "<string>",
"website": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/companies"
payload = { "input": {
"addresses": { "data": [
{
"canonicalAddressId": "<string>",
"city": "<string>",
"companyId": "<string>",
"companyName": "<string>",
"customerId": "<string>",
"locationCodeId": "<string>",
"name": "<string>",
"phoneNumber": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"streetLine3": "<string>",
"zipOrPostalCode": "<string>"
}
] },
"dunsNumber": "<string>",
"logoUrl": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"primaryEmailAddress": "<string>",
"primaryPhone": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"termsOfService": "<string>",
"website": "<string>"
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
input: {
addresses: {
data: [
{
canonicalAddressId: '<string>',
city: '<string>',
companyId: '<string>',
companyName: '<string>',
customerId: '<string>',
locationCodeId: '<string>',
name: '<string>',
phoneNumber: '<string>',
stateOrProvince: '<string>',
streetLine1: '<string>',
streetLine2: '<string>',
streetLine3: '<string>',
zipOrPostalCode: '<string>'
}
]
},
dunsNumber: '<string>',
logoUrl: '<string>',
mcNumber: '<string>',
name: '<string>',
primaryEmailAddress: '<string>',
primaryPhone: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
sourceSystemMeta: '<unknown>',
termsOfService: '<string>',
website: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/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://api.upwell.com/api/rest/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([
'input' => [
'addresses' => [
'data' => [
[
'canonicalAddressId' => '<string>',
'city' => '<string>',
'companyId' => '<string>',
'companyName' => '<string>',
'customerId' => '<string>',
'locationCodeId' => '<string>',
'name' => '<string>',
'phoneNumber' => '<string>',
'stateOrProvince' => '<string>',
'streetLine1' => '<string>',
'streetLine2' => '<string>',
'streetLine3' => '<string>',
'zipOrPostalCode' => '<string>'
]
]
],
'dunsNumber' => '<string>',
'logoUrl' => '<string>',
'mcNumber' => '<string>',
'name' => '<string>',
'primaryEmailAddress' => '<string>',
'primaryPhone' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'sourceSystemMeta' => '<unknown>',
'termsOfService' => '<string>',
'website' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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://api.upwell.com/api/rest/companies"
payload := strings.NewReader("{\n \"input\": {\n \"addresses\": {\n \"data\": [\n {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n ]\n },\n \"dunsNumber\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"primaryEmailAddress\": \"<string>\",\n \"primaryPhone\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"termsOfService\": \"<string>\",\n \"website\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.upwell.com/api/rest/companies")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"input\": {\n \"addresses\": {\n \"data\": [\n {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n ]\n },\n \"dunsNumber\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"primaryEmailAddress\": \"<string>\",\n \"primaryPhone\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"termsOfService\": \"<string>\",\n \"website\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/companies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"input\": {\n \"addresses\": {\n \"data\": [\n {\n \"canonicalAddressId\": \"<string>\",\n \"city\": \"<string>\",\n \"companyId\": \"<string>\",\n \"companyName\": \"<string>\",\n \"customerId\": \"<string>\",\n \"locationCodeId\": \"<string>\",\n \"name\": \"<string>\",\n \"phoneNumber\": \"<string>\",\n \"stateOrProvince\": \"<string>\",\n \"streetLine1\": \"<string>\",\n \"streetLine2\": \"<string>\",\n \"streetLine3\": \"<string>\",\n \"zipOrPostalCode\": \"<string>\"\n }\n ]\n },\n \"dunsNumber\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"mcNumber\": \"<string>\",\n \"name\": \"<string>\",\n \"primaryEmailAddress\": \"<string>\",\n \"primaryPhone\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"termsOfService\": \"<string>\",\n \"website\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"createCompany": {
"createdAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"dunsNumber": "<string>",
"id": "<string>",
"logoUrl": "<string>",
"mcNumber": "<string>",
"name": "<string>",
"primaryEmailAddress": "<string>",
"primaryPhone": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"termsOfService": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"website": "<string>"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}Authorizations
Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.
Body
application/json
Query parameters can also be provided in the request body as a JSON object
input type for inserting data into table "companies"
Show child attributes
Show child attributes
Response
Responses for POST /api/rest/companies
Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.
Show child attributes
Show child attributes
⌘I