Skip to main content
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 '{
  "customerId": "<string>",
  "number": 123,
  "name": "<string>",
  "objectManagerId": "<string>",
  "address": {
    "street": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "country": "<string>"
  },
  "contact": {
    "phone": "<string>",
    "email": "jsmith@example.com",
    "fax": "<string>"
  },
  "description": "<string>",
  "securityCode": "<string>",
  "key": "<string>",
  "tags": [
    "<string>"
  ]
}'
{
  "_id": "<string>"
}

Authorizations

x-API-Key
string
header
required

Body

application/json

Customer object data

address
object
required
customerId
string<objectid>

Customer ID (optional - will create new customer if not provided)

number
integer

Object number (auto-generated if not provided)

name
string

Object name

objectManagerId
string<objectid>

Object manager user ID

contact
object
description
string
securityCode
string
key
string
tags
string[]

Response

Customer object created successfully

_id
string<objectid>