curl --request POST \
--url http://127.0.0.1:8080/v1/c/customer \
--header 'Content-Type: application/json' \
--header 'wb-key: <api-key>' \
--data '
{
"addresses": {
"main": {
"address": "221B Baker St",
"city": "London",
"country": "UK",
"zip": "NW1 6XE"
}
},
"emails": {
"main": "sherlock@wingback.com"
},
"name": "Sherlock Holmes"
}
'import requests
url = "http://127.0.0.1:8080/v1/c/customer"
payload = {
"addresses": { "main": {
"address": "221B Baker St",
"city": "London",
"country": "UK",
"zip": "NW1 6XE"
} },
"emails": { "main": "sherlock@wingback.com" },
"name": "Sherlock Holmes"
}
headers = {
"wb-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'wb-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
addresses: {
main: {address: '221B Baker St', city: 'London', country: 'UK', zip: 'NW1 6XE'}
},
emails: {main: 'sherlock@wingback.com'},
name: 'Sherlock Holmes'
})
};
fetch('http://127.0.0.1:8080/v1/c/customer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://127.0.0.1:8080/v1/c/customer",
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([
'addresses' => [
'main' => [
'address' => '221B Baker St',
'city' => 'London',
'country' => 'UK',
'zip' => 'NW1 6XE'
]
],
'emails' => [
'main' => 'sherlock@wingback.com'
],
'name' => 'Sherlock Holmes'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"wb-key: <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 := "http://127.0.0.1:8080/v1/c/customer"
payload := strings.NewReader("{\n \"addresses\": {\n \"main\": {\n \"address\": \"221B Baker St\",\n \"city\": \"London\",\n \"country\": \"UK\",\n \"zip\": \"NW1 6XE\"\n }\n },\n \"emails\": {\n \"main\": \"sherlock@wingback.com\"\n },\n \"name\": \"Sherlock Holmes\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("wb-key", "<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("http://127.0.0.1:8080/v1/c/customer")
.header("wb-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"addresses\": {\n \"main\": {\n \"address\": \"221B Baker St\",\n \"city\": \"London\",\n \"country\": \"UK\",\n \"zip\": \"NW1 6XE\"\n }\n },\n \"emails\": {\n \"main\": \"sherlock@wingback.com\"\n },\n \"name\": \"Sherlock Holmes\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8080/v1/c/customer")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["wb-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"addresses\": {\n \"main\": {\n \"address\": \"221B Baker St\",\n \"city\": \"London\",\n \"country\": \"UK\",\n \"zip\": \"NW1 6XE\"\n }\n },\n \"emails\": {\n \"main\": \"sherlock@wingback.com\"\n },\n \"name\": \"Sherlock Holmes\"\n}"
response = http.request(request)
puts response.read_body"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"Create New Customer
The API creates a new customer within Wingback or updates an existing one.
curl --request POST \
--url http://127.0.0.1:8080/v1/c/customer \
--header 'Content-Type: application/json' \
--header 'wb-key: <api-key>' \
--data '
{
"addresses": {
"main": {
"address": "221B Baker St",
"city": "London",
"country": "UK",
"zip": "NW1 6XE"
}
},
"emails": {
"main": "sherlock@wingback.com"
},
"name": "Sherlock Holmes"
}
'import requests
url = "http://127.0.0.1:8080/v1/c/customer"
payload = {
"addresses": { "main": {
"address": "221B Baker St",
"city": "London",
"country": "UK",
"zip": "NW1 6XE"
} },
"emails": { "main": "sherlock@wingback.com" },
"name": "Sherlock Holmes"
}
headers = {
"wb-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'wb-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
addresses: {
main: {address: '221B Baker St', city: 'London', country: 'UK', zip: 'NW1 6XE'}
},
emails: {main: 'sherlock@wingback.com'},
name: 'Sherlock Holmes'
})
};
fetch('http://127.0.0.1:8080/v1/c/customer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://127.0.0.1:8080/v1/c/customer",
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([
'addresses' => [
'main' => [
'address' => '221B Baker St',
'city' => 'London',
'country' => 'UK',
'zip' => 'NW1 6XE'
]
],
'emails' => [
'main' => 'sherlock@wingback.com'
],
'name' => 'Sherlock Holmes'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"wb-key: <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 := "http://127.0.0.1:8080/v1/c/customer"
payload := strings.NewReader("{\n \"addresses\": {\n \"main\": {\n \"address\": \"221B Baker St\",\n \"city\": \"London\",\n \"country\": \"UK\",\n \"zip\": \"NW1 6XE\"\n }\n },\n \"emails\": {\n \"main\": \"sherlock@wingback.com\"\n },\n \"name\": \"Sherlock Holmes\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("wb-key", "<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("http://127.0.0.1:8080/v1/c/customer")
.header("wb-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"addresses\": {\n \"main\": {\n \"address\": \"221B Baker St\",\n \"city\": \"London\",\n \"country\": \"UK\",\n \"zip\": \"NW1 6XE\"\n }\n },\n \"emails\": {\n \"main\": \"sherlock@wingback.com\"\n },\n \"name\": \"Sherlock Holmes\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://127.0.0.1:8080/v1/c/customer")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["wb-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"addresses\": {\n \"main\": {\n \"address\": \"221B Baker St\",\n \"city\": \"London\",\n \"country\": \"UK\",\n \"zip\": \"NW1 6XE\"\n }\n },\n \"emails\": {\n \"main\": \"sherlock@wingback.com\"\n },\n \"name\": \"Sherlock Holmes\"\n}"
response = http.request(request)
puts response.read_body"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"Authorizations
Body
Used to either create a new Customer, or modify an existing Customer
When id is empty, will create a new customer, while
setting id will modify an existing customer
Physical address. Used by both Customer and WbCustomer entities.
Show child attributes
Show child attributes
Customer Reference. May contain a reference to an external system
Emails associated with this customer
Show child attributes
Show child attributes
Unique identifier of an object. Consists of object class prefix and a UUID
"Cust_c40bea18-c0c9-44b1-bd0c-43f5283e1670"
Key-value customer metadata with string values.
Show child attributes
Show child attributes
Name of the Customer
Additional notes for the customer
Extra information that impacts customer's taxation
Show child attributes
Show child attributes
Response
Updated