Create One Customer
curl --request POST \
--url https://api.upwell.com/api/rest/customers \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"addresses": {},
"addressesLastUpdatedAt": "2023-11-07T05:31:56Z",
"billToCode": "<string>",
"billToCustomerId": "<string>",
"billToSource": "<string>",
"ccEmailAddresses": [
"<string>"
],
"childCustomers": {},
"collectorId": "<string>",
"contacts": {},
"contactsLastUpdatedAt": "2023-11-07T05:31:56Z",
"customerEmailSettings": {},
"customerIntegrationSettings": {},
"customerRule": {},
"deletedAt": "<unknown>",
"deliveryRoutingRules": {},
"emailAddress": "<string>",
"invoiceSplitRules": {},
"isActive": true,
"mergedIntoCustomer": {},
"mergedIntoCustomerId": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"paymentDiscountTerms": "<unknown>",
"paymentLineItems": {},
"remittanceLineItems": {},
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"statementSchedules": {},
"tmsBalanceCents": "<unknown>",
"tmsCustomerType": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/customers"
payload = { "input": {
"addresses": {},
"addressesLastUpdatedAt": "2023-11-07T05:31:56Z",
"billToCode": "<string>",
"billToCustomerId": "<string>",
"billToSource": "<string>",
"ccEmailAddresses": ["<string>"],
"childCustomers": {},
"collectorId": "<string>",
"contacts": {},
"contactsLastUpdatedAt": "2023-11-07T05:31:56Z",
"customerEmailSettings": {},
"customerIntegrationSettings": {},
"customerRule": {},
"deletedAt": "<unknown>",
"deliveryRoutingRules": {},
"emailAddress": "<string>",
"invoiceSplitRules": {},
"isActive": True,
"mergedIntoCustomer": {},
"mergedIntoCustomerId": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"paymentDiscountTerms": "<unknown>",
"paymentLineItems": {},
"remittanceLineItems": {},
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"statementSchedules": {},
"tmsBalanceCents": "<unknown>",
"tmsCustomerType": "<string>"
} }
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({
input: {
addresses: {},
addressesLastUpdatedAt: '2023-11-07T05:31:56Z',
billToCode: '<string>',
billToCustomerId: '<string>',
billToSource: '<string>',
ccEmailAddresses: ['<string>'],
childCustomers: {},
collectorId: '<string>',
contacts: {},
contactsLastUpdatedAt: '2023-11-07T05:31:56Z',
customerEmailSettings: {},
customerIntegrationSettings: {},
customerRule: {},
deletedAt: '<unknown>',
deliveryRoutingRules: {},
emailAddress: '<string>',
invoiceSplitRules: {},
isActive: true,
mergedIntoCustomer: {},
mergedIntoCustomerId: '<string>',
metadata: '<unknown>',
name: '<string>',
paymentDiscountTerms: '<unknown>',
paymentLineItems: {},
remittanceLineItems: {},
sourceSystem: '<string>',
sourceSystemId: '<string>',
statementSchedules: {},
tmsBalanceCents: '<unknown>',
tmsCustomerType: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/customers', 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/customers",
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' => [
],
'addressesLastUpdatedAt' => '2023-11-07T05:31:56Z',
'billToCode' => '<string>',
'billToCustomerId' => '<string>',
'billToSource' => '<string>',
'ccEmailAddresses' => [
'<string>'
],
'childCustomers' => [
],
'collectorId' => '<string>',
'contacts' => [
],
'contactsLastUpdatedAt' => '2023-11-07T05:31:56Z',
'customerEmailSettings' => [
],
'customerIntegrationSettings' => [
],
'customerRule' => [
],
'deletedAt' => '<unknown>',
'deliveryRoutingRules' => [
],
'emailAddress' => '<string>',
'invoiceSplitRules' => [
],
'isActive' => true,
'mergedIntoCustomer' => [
],
'mergedIntoCustomerId' => '<string>',
'metadata' => '<unknown>',
'name' => '<string>',
'paymentDiscountTerms' => '<unknown>',
'paymentLineItems' => [
],
'remittanceLineItems' => [
],
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'statementSchedules' => [
],
'tmsBalanceCents' => '<unknown>',
'tmsCustomerType' => '<string>'
]
]),
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://api.upwell.com/api/rest/customers"
payload := strings.NewReader("{\n \"input\": {\n \"addresses\": {},\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"billToCode\": \"<string>\",\n \"billToCustomerId\": \"<string>\",\n \"billToSource\": \"<string>\",\n \"ccEmailAddresses\": [\n \"<string>\"\n ],\n \"childCustomers\": {},\n \"collectorId\": \"<string>\",\n \"contacts\": {},\n \"contactsLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"customerEmailSettings\": {},\n \"customerIntegrationSettings\": {},\n \"customerRule\": {},\n \"deletedAt\": \"<unknown>\",\n \"deliveryRoutingRules\": {},\n \"emailAddress\": \"<string>\",\n \"invoiceSplitRules\": {},\n \"isActive\": true,\n \"mergedIntoCustomer\": {},\n \"mergedIntoCustomerId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"paymentDiscountTerms\": \"<unknown>\",\n \"paymentLineItems\": {},\n \"remittanceLineItems\": {},\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"statementSchedules\": {},\n \"tmsBalanceCents\": \"<unknown>\",\n \"tmsCustomerType\": \"<string>\"\n }\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://api.upwell.com/api/rest/customers")
.header("Content-Type", "application/json")
.body("{\n \"input\": {\n \"addresses\": {},\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"billToCode\": \"<string>\",\n \"billToCustomerId\": \"<string>\",\n \"billToSource\": \"<string>\",\n \"ccEmailAddresses\": [\n \"<string>\"\n ],\n \"childCustomers\": {},\n \"collectorId\": \"<string>\",\n \"contacts\": {},\n \"contactsLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"customerEmailSettings\": {},\n \"customerIntegrationSettings\": {},\n \"customerRule\": {},\n \"deletedAt\": \"<unknown>\",\n \"deliveryRoutingRules\": {},\n \"emailAddress\": \"<string>\",\n \"invoiceSplitRules\": {},\n \"isActive\": true,\n \"mergedIntoCustomer\": {},\n \"mergedIntoCustomerId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"paymentDiscountTerms\": \"<unknown>\",\n \"paymentLineItems\": {},\n \"remittanceLineItems\": {},\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"statementSchedules\": {},\n \"tmsBalanceCents\": \"<unknown>\",\n \"tmsCustomerType\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/customers")
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 \"input\": {\n \"addresses\": {},\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"billToCode\": \"<string>\",\n \"billToCustomerId\": \"<string>\",\n \"billToSource\": \"<string>\",\n \"ccEmailAddresses\": [\n \"<string>\"\n ],\n \"childCustomers\": {},\n \"collectorId\": \"<string>\",\n \"contacts\": {},\n \"contactsLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"customerEmailSettings\": {},\n \"customerIntegrationSettings\": {},\n \"customerRule\": {},\n \"deletedAt\": \"<unknown>\",\n \"deliveryRoutingRules\": {},\n \"emailAddress\": \"<string>\",\n \"invoiceSplitRules\": {},\n \"isActive\": true,\n \"mergedIntoCustomer\": {},\n \"mergedIntoCustomerId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"paymentDiscountTerms\": \"<unknown>\",\n \"paymentLineItems\": {},\n \"remittanceLineItems\": {},\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"statementSchedules\": {},\n \"tmsBalanceCents\": \"<unknown>\",\n \"tmsCustomerType\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"createCustomer": {
"addresses": [
{
"city": "<string>",
"id": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
}
],
"balance": "<unknown>",
"billToCustomerId": "<string>",
"ccEmailAddresses": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"customerRule": {
"dueOption": 123,
"id": "<string>"
},
"emailAddress": "<string>",
"id": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"overdueBalance": "<unknown>",
"overdueInvoiceCount": 123,
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Customers
Create One Customer
Create a new customer.
Integration note: POST errors with 400 Uniqueness violation if a customer with this (sourceSystem, sourceSystemId) pair already exists. Use PUT /api/rest/customers/{id} (or PUT /api/rest/customers/by-source-system-id/{id}) for updates. See Integration patterns.
POST
/
api
/
rest
/
customers
Create One Customer
curl --request POST \
--url https://api.upwell.com/api/rest/customers \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"addresses": {},
"addressesLastUpdatedAt": "2023-11-07T05:31:56Z",
"billToCode": "<string>",
"billToCustomerId": "<string>",
"billToSource": "<string>",
"ccEmailAddresses": [
"<string>"
],
"childCustomers": {},
"collectorId": "<string>",
"contacts": {},
"contactsLastUpdatedAt": "2023-11-07T05:31:56Z",
"customerEmailSettings": {},
"customerIntegrationSettings": {},
"customerRule": {},
"deletedAt": "<unknown>",
"deliveryRoutingRules": {},
"emailAddress": "<string>",
"invoiceSplitRules": {},
"isActive": true,
"mergedIntoCustomer": {},
"mergedIntoCustomerId": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"paymentDiscountTerms": "<unknown>",
"paymentLineItems": {},
"remittanceLineItems": {},
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"statementSchedules": {},
"tmsBalanceCents": "<unknown>",
"tmsCustomerType": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/customers"
payload = { "input": {
"addresses": {},
"addressesLastUpdatedAt": "2023-11-07T05:31:56Z",
"billToCode": "<string>",
"billToCustomerId": "<string>",
"billToSource": "<string>",
"ccEmailAddresses": ["<string>"],
"childCustomers": {},
"collectorId": "<string>",
"contacts": {},
"contactsLastUpdatedAt": "2023-11-07T05:31:56Z",
"customerEmailSettings": {},
"customerIntegrationSettings": {},
"customerRule": {},
"deletedAt": "<unknown>",
"deliveryRoutingRules": {},
"emailAddress": "<string>",
"invoiceSplitRules": {},
"isActive": True,
"mergedIntoCustomer": {},
"mergedIntoCustomerId": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"paymentDiscountTerms": "<unknown>",
"paymentLineItems": {},
"remittanceLineItems": {},
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"statementSchedules": {},
"tmsBalanceCents": "<unknown>",
"tmsCustomerType": "<string>"
} }
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({
input: {
addresses: {},
addressesLastUpdatedAt: '2023-11-07T05:31:56Z',
billToCode: '<string>',
billToCustomerId: '<string>',
billToSource: '<string>',
ccEmailAddresses: ['<string>'],
childCustomers: {},
collectorId: '<string>',
contacts: {},
contactsLastUpdatedAt: '2023-11-07T05:31:56Z',
customerEmailSettings: {},
customerIntegrationSettings: {},
customerRule: {},
deletedAt: '<unknown>',
deliveryRoutingRules: {},
emailAddress: '<string>',
invoiceSplitRules: {},
isActive: true,
mergedIntoCustomer: {},
mergedIntoCustomerId: '<string>',
metadata: '<unknown>',
name: '<string>',
paymentDiscountTerms: '<unknown>',
paymentLineItems: {},
remittanceLineItems: {},
sourceSystem: '<string>',
sourceSystemId: '<string>',
statementSchedules: {},
tmsBalanceCents: '<unknown>',
tmsCustomerType: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/customers', 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/customers",
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' => [
],
'addressesLastUpdatedAt' => '2023-11-07T05:31:56Z',
'billToCode' => '<string>',
'billToCustomerId' => '<string>',
'billToSource' => '<string>',
'ccEmailAddresses' => [
'<string>'
],
'childCustomers' => [
],
'collectorId' => '<string>',
'contacts' => [
],
'contactsLastUpdatedAt' => '2023-11-07T05:31:56Z',
'customerEmailSettings' => [
],
'customerIntegrationSettings' => [
],
'customerRule' => [
],
'deletedAt' => '<unknown>',
'deliveryRoutingRules' => [
],
'emailAddress' => '<string>',
'invoiceSplitRules' => [
],
'isActive' => true,
'mergedIntoCustomer' => [
],
'mergedIntoCustomerId' => '<string>',
'metadata' => '<unknown>',
'name' => '<string>',
'paymentDiscountTerms' => '<unknown>',
'paymentLineItems' => [
],
'remittanceLineItems' => [
],
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'statementSchedules' => [
],
'tmsBalanceCents' => '<unknown>',
'tmsCustomerType' => '<string>'
]
]),
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://api.upwell.com/api/rest/customers"
payload := strings.NewReader("{\n \"input\": {\n \"addresses\": {},\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"billToCode\": \"<string>\",\n \"billToCustomerId\": \"<string>\",\n \"billToSource\": \"<string>\",\n \"ccEmailAddresses\": [\n \"<string>\"\n ],\n \"childCustomers\": {},\n \"collectorId\": \"<string>\",\n \"contacts\": {},\n \"contactsLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"customerEmailSettings\": {},\n \"customerIntegrationSettings\": {},\n \"customerRule\": {},\n \"deletedAt\": \"<unknown>\",\n \"deliveryRoutingRules\": {},\n \"emailAddress\": \"<string>\",\n \"invoiceSplitRules\": {},\n \"isActive\": true,\n \"mergedIntoCustomer\": {},\n \"mergedIntoCustomerId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"paymentDiscountTerms\": \"<unknown>\",\n \"paymentLineItems\": {},\n \"remittanceLineItems\": {},\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"statementSchedules\": {},\n \"tmsBalanceCents\": \"<unknown>\",\n \"tmsCustomerType\": \"<string>\"\n }\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://api.upwell.com/api/rest/customers")
.header("Content-Type", "application/json")
.body("{\n \"input\": {\n \"addresses\": {},\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"billToCode\": \"<string>\",\n \"billToCustomerId\": \"<string>\",\n \"billToSource\": \"<string>\",\n \"ccEmailAddresses\": [\n \"<string>\"\n ],\n \"childCustomers\": {},\n \"collectorId\": \"<string>\",\n \"contacts\": {},\n \"contactsLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"customerEmailSettings\": {},\n \"customerIntegrationSettings\": {},\n \"customerRule\": {},\n \"deletedAt\": \"<unknown>\",\n \"deliveryRoutingRules\": {},\n \"emailAddress\": \"<string>\",\n \"invoiceSplitRules\": {},\n \"isActive\": true,\n \"mergedIntoCustomer\": {},\n \"mergedIntoCustomerId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"paymentDiscountTerms\": \"<unknown>\",\n \"paymentLineItems\": {},\n \"remittanceLineItems\": {},\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"statementSchedules\": {},\n \"tmsBalanceCents\": \"<unknown>\",\n \"tmsCustomerType\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/customers")
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 \"input\": {\n \"addresses\": {},\n \"addressesLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"billToCode\": \"<string>\",\n \"billToCustomerId\": \"<string>\",\n \"billToSource\": \"<string>\",\n \"ccEmailAddresses\": [\n \"<string>\"\n ],\n \"childCustomers\": {},\n \"collectorId\": \"<string>\",\n \"contacts\": {},\n \"contactsLastUpdatedAt\": \"2023-11-07T05:31:56Z\",\n \"customerEmailSettings\": {},\n \"customerIntegrationSettings\": {},\n \"customerRule\": {},\n \"deletedAt\": \"<unknown>\",\n \"deliveryRoutingRules\": {},\n \"emailAddress\": \"<string>\",\n \"invoiceSplitRules\": {},\n \"isActive\": true,\n \"mergedIntoCustomer\": {},\n \"mergedIntoCustomerId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"name\": \"<string>\",\n \"paymentDiscountTerms\": \"<unknown>\",\n \"paymentLineItems\": {},\n \"remittanceLineItems\": {},\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"statementSchedules\": {},\n \"tmsBalanceCents\": \"<unknown>\",\n \"tmsCustomerType\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"createCustomer": {
"addresses": [
{
"city": "<string>",
"id": "<string>",
"stateOrProvince": "<string>",
"streetLine1": "<string>",
"streetLine2": "<string>",
"zipOrPostalCode": "<string>"
}
],
"balance": "<unknown>",
"billToCustomerId": "<string>",
"ccEmailAddresses": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"customerRule": {
"dueOption": 123,
"id": "<string>"
},
"emailAddress": "<string>",
"id": "<string>",
"metadata": "<unknown>",
"name": "<string>",
"overdueBalance": "<unknown>",
"overdueInvoiceCount": 123,
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Headers
Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY
Body
application/json
Query parameters can also be provided in the request body as a JSON object
input type for inserting data into table "customers"
Show child attributes
Show child attributes
Response
200 - application/json
Responses for POST /api/rest/customers
columns and relationships of "customers"
Show child attributes
Show child attributes
⌘I