Create customer object
curl --request POST \
--url http://localhost:3000/v2/objects/ \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"address": {
"street": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>"
},
"customerId": "<string>",
"number": 123,
"name": "<string>",
"objectManagerId": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com",
"fax": "<string>"
},
"description": "<string>",
"securityCode": "<string>",
"key": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "http://localhost:3000/v2/objects/"
payload = {
"address": {
"street": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>"
},
"customerId": "<string>",
"number": 123,
"name": "<string>",
"objectManagerId": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com",
"fax": "<string>"
},
"description": "<string>",
"securityCode": "<string>",
"key": "<string>",
"tags": ["<string>"]
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: {street: '<string>', city: '<string>', zip: '<string>', country: '<string>'},
customerId: '<string>',
number: 123,
name: '<string>',
objectManagerId: '<string>',
contact: {phone: '<string>', email: 'jsmith@example.com', fax: '<string>'},
description: '<string>',
securityCode: '<string>',
key: '<string>',
tags: ['<string>']
})
};
fetch('http://localhost:3000/v2/objects/', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/v2/objects/",
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([
'address' => [
'street' => '<string>',
'city' => '<string>',
'zip' => '<string>',
'country' => '<string>'
],
'customerId' => '<string>',
'number' => 123,
'name' => '<string>',
'objectManagerId' => '<string>',
'contact' => [
'phone' => '<string>',
'email' => 'jsmith@example.com',
'fax' => '<string>'
],
'description' => '<string>',
'securityCode' => '<string>',
'key' => '<string>',
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-API-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://localhost:3000/v2/objects/"
payload := strings.NewReader("{\n \"address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"customerId\": \"<string>\",\n \"number\": 123,\n \"name\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"fax\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"securityCode\": \"<string>\",\n \"key\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-API-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://localhost:3000/v2/objects/")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"customerId\": \"<string>\",\n \"number\": 123,\n \"name\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"fax\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"securityCode\": \"<string>\",\n \"key\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/objects/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"customerId\": \"<string>\",\n \"number\": 123,\n \"name\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"fax\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"securityCode\": \"<string>\",\n \"key\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>"
}Objects
Create Object
Create a new customer object. If no customer ID is provided, a new customer will be created automatically.
POST
/
objects
/
Create customer object
curl --request POST \
--url http://localhost:3000/v2/objects/ \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"address": {
"street": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>"
},
"customerId": "<string>",
"number": 123,
"name": "<string>",
"objectManagerId": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com",
"fax": "<string>"
},
"description": "<string>",
"securityCode": "<string>",
"key": "<string>",
"tags": [
"<string>"
]
}
'import requests
url = "http://localhost:3000/v2/objects/"
payload = {
"address": {
"street": "<string>",
"city": "<string>",
"zip": "<string>",
"country": "<string>"
},
"customerId": "<string>",
"number": 123,
"name": "<string>",
"objectManagerId": "<string>",
"contact": {
"phone": "<string>",
"email": "jsmith@example.com",
"fax": "<string>"
},
"description": "<string>",
"securityCode": "<string>",
"key": "<string>",
"tags": ["<string>"]
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: {street: '<string>', city: '<string>', zip: '<string>', country: '<string>'},
customerId: '<string>',
number: 123,
name: '<string>',
objectManagerId: '<string>',
contact: {phone: '<string>', email: 'jsmith@example.com', fax: '<string>'},
description: '<string>',
securityCode: '<string>',
key: '<string>',
tags: ['<string>']
})
};
fetch('http://localhost:3000/v2/objects/', 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 => "3000",
CURLOPT_URL => "http://localhost:3000/v2/objects/",
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([
'address' => [
'street' => '<string>',
'city' => '<string>',
'zip' => '<string>',
'country' => '<string>'
],
'customerId' => '<string>',
'number' => 123,
'name' => '<string>',
'objectManagerId' => '<string>',
'contact' => [
'phone' => '<string>',
'email' => 'jsmith@example.com',
'fax' => '<string>'
],
'description' => '<string>',
'securityCode' => '<string>',
'key' => '<string>',
'tags' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-API-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://localhost:3000/v2/objects/"
payload := strings.NewReader("{\n \"address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"customerId\": \"<string>\",\n \"number\": 123,\n \"name\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"fax\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"securityCode\": \"<string>\",\n \"key\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-API-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://localhost:3000/v2/objects/")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"customerId\": \"<string>\",\n \"number\": 123,\n \"name\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"fax\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"securityCode\": \"<string>\",\n \"key\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/objects/")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": {\n \"street\": \"<string>\",\n \"city\": \"<string>\",\n \"zip\": \"<string>\",\n \"country\": \"<string>\"\n },\n \"customerId\": \"<string>\",\n \"number\": 123,\n \"name\": \"<string>\",\n \"objectManagerId\": \"<string>\",\n \"contact\": {\n \"phone\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"fax\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"securityCode\": \"<string>\",\n \"key\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"_id": "<string>"
}Authorizations
API-KeyBearer-Auth
Body
application/json
Customer object data
Show child attributes
Show child attributes
Customer ID (optional - will create new customer if not provided)
Object number (auto-generated if not provided)
Object name
Object manager user ID
Show child attributes
Show child attributes
Response
Customer object created successfully
Was this page helpful?
⌘I

