Create Customer
curl --request POST \
--url https://api.example.com/v1/customers \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "John",
"last_name": "Doe",
"company": "US Oil Supply",
"merchant_identifier": "EID-987654-321",
"phone_number": "555-555-555",
"email_address": "email@email.com",
"shipping_address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {},
"initiated_by_user_id": 123
}
'import requests
url = "https://api.example.com/v1/customers"
payload = {
"first_name": "John",
"last_name": "Doe",
"company": "US Oil Supply",
"merchant_identifier": "EID-987654-321",
"phone_number": "555-555-555",
"email_address": "email@email.com",
"shipping_address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {},
"initiated_by_user_id": 123
}
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({
first_name: 'John',
last_name: 'Doe',
company: 'US Oil Supply',
merchant_identifier: 'EID-987654-321',
phone_number: '555-555-555',
email_address: 'email@email.com',
shipping_address: {
name: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>'
},
metadata: {},
initiated_by_user_id: 123
})
};
fetch('https://api.example.com/v1/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.example.com/v1/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([
'first_name' => 'John',
'last_name' => 'Doe',
'company' => 'US Oil Supply',
'merchant_identifier' => 'EID-987654-321',
'phone_number' => '555-555-555',
'email_address' => 'email@email.com',
'shipping_address' => [
'name' => '<string>',
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>'
],
'metadata' => [
],
'initiated_by_user_id' => 123
]),
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.example.com/v1/customers"
payload := strings.NewReader("{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"US Oil Supply\",\n \"merchant_identifier\": \"EID-987654-321\",\n \"phone_number\": \"555-555-555\",\n \"email_address\": \"email@email.com\",\n \"shipping_address\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"metadata\": {},\n \"initiated_by_user_id\": 123\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.example.com/v1/customers")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"US Oil Supply\",\n \"merchant_identifier\": \"EID-987654-321\",\n \"phone_number\": \"555-555-555\",\n \"email_address\": \"email@email.com\",\n \"shipping_address\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"metadata\": {},\n \"initiated_by_user_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/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 \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"US Oil Supply\",\n \"merchant_identifier\": \"EID-987654-321\",\n \"phone_number\": \"555-555-555\",\n \"email_address\": \"email@email.com\",\n \"shipping_address\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"metadata\": {},\n \"initiated_by_user_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"first_name": "John",
"last_name": "Doe",
"company": "US Oil Supply",
"merchant_identifier": "EID-987654-321",
"phone_number": "555-555-555",
"email_address": "email@email.com",
"shipping_address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {}
},
"request_id": "000000000000000000000",
"errors": [
{
"type": "<string>",
"message": null
}
]
}{
"errors": [
{
"type": "<string>",
"message": null
}
],
"request_id": "000000000000000000000"
}Customers
Create Customer
Create a new customer in your vault.
POST
/
v1
/
customers
Create Customer
curl --request POST \
--url https://api.example.com/v1/customers \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "John",
"last_name": "Doe",
"company": "US Oil Supply",
"merchant_identifier": "EID-987654-321",
"phone_number": "555-555-555",
"email_address": "email@email.com",
"shipping_address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {},
"initiated_by_user_id": 123
}
'import requests
url = "https://api.example.com/v1/customers"
payload = {
"first_name": "John",
"last_name": "Doe",
"company": "US Oil Supply",
"merchant_identifier": "EID-987654-321",
"phone_number": "555-555-555",
"email_address": "email@email.com",
"shipping_address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {},
"initiated_by_user_id": 123
}
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({
first_name: 'John',
last_name: 'Doe',
company: 'US Oil Supply',
merchant_identifier: 'EID-987654-321',
phone_number: '555-555-555',
email_address: 'email@email.com',
shipping_address: {
name: '<string>',
line1: '<string>',
line2: '<string>',
city: '<string>',
state: '<string>',
postal_code: '<string>',
country: '<string>'
},
metadata: {},
initiated_by_user_id: 123
})
};
fetch('https://api.example.com/v1/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.example.com/v1/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([
'first_name' => 'John',
'last_name' => 'Doe',
'company' => 'US Oil Supply',
'merchant_identifier' => 'EID-987654-321',
'phone_number' => '555-555-555',
'email_address' => 'email@email.com',
'shipping_address' => [
'name' => '<string>',
'line1' => '<string>',
'line2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal_code' => '<string>',
'country' => '<string>'
],
'metadata' => [
],
'initiated_by_user_id' => 123
]),
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.example.com/v1/customers"
payload := strings.NewReader("{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"US Oil Supply\",\n \"merchant_identifier\": \"EID-987654-321\",\n \"phone_number\": \"555-555-555\",\n \"email_address\": \"email@email.com\",\n \"shipping_address\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"metadata\": {},\n \"initiated_by_user_id\": 123\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.example.com/v1/customers")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"US Oil Supply\",\n \"merchant_identifier\": \"EID-987654-321\",\n \"phone_number\": \"555-555-555\",\n \"email_address\": \"email@email.com\",\n \"shipping_address\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"metadata\": {},\n \"initiated_by_user_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/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 \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"company\": \"US Oil Supply\",\n \"merchant_identifier\": \"EID-987654-321\",\n \"phone_number\": \"555-555-555\",\n \"email_address\": \"email@email.com\",\n \"shipping_address\": {\n \"name\": \"<string>\",\n \"line1\": \"<string>\",\n \"line2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal_code\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"metadata\": {},\n \"initiated_by_user_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"first_name": "John",
"last_name": "Doe",
"company": "US Oil Supply",
"merchant_identifier": "EID-987654-321",
"phone_number": "555-555-555",
"email_address": "email@email.com",
"shipping_address": {
"name": "<string>",
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>"
},
"metadata": {}
},
"request_id": "000000000000000000000",
"errors": [
{
"type": "<string>",
"message": null
}
]
}{
"errors": [
{
"type": "<string>",
"message": null
}
],
"request_id": "000000000000000000000"
}Body
application/jsontext/jsonapplication/*+json
Customers first name.
Maximum string length:
100Pattern:
^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$Customers last name.
Maximum string length:
100Pattern:
^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$Company associated with the customer.
Maximum string length:
100Pattern:
^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$Merchants customer identifier. This field can be used as a reference back to your internal data system.
Maximum string length:
100Pattern:
^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$Customers phone number. This could be a cellular, land line, or a fax number.
Maximum string length:
100Pattern:
^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$Customers email address.
Maximum string length:
100Pattern:
^[0-9A-Za-z _\-\.,`'()@#!?\/\\:;|+=@%&]*$Show child attributes
Show child attributes
Metadata associated with the customer. This is a key value pair.
Show child attributes
Show child attributes
⌘I