Skip to main content
POST
/
api
/
v1
/
object-types
Create object type
curl --request POST \
  --url https://voxworks.ai/api/v1/object-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type_name": "property",
  "display_name": "Property",
  "description": "Property records imported from a CRM",
  "validation_mode": "strict",
  "unique_by_contact": false,
  "schema": {
    "address": "string",
    "bedrooms": "number"
  }
}
'
{
  "success": true,
  "object_type_id": "<string>",
  "object_type": {
    "id": "<string>",
    "type_name": "<string>",
    "display_name": "<string>",
    "description": "<string>",
    "schema": {},
    "unique_by_contact": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.voxworks.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key from Voxworks, sent as Authorization: Bearer YOUR_API_KEY.

Body

application/json
type_name
string
required
Pattern: ^[a-z][a-z0-9_]*$
display_name
string
required
schema
object
required
description
string
Maximum string length: 1000
validation_mode
enum<string>
default:off
Available options:
off,
warn,
strict
unique_by_contact
boolean
default:false

Response

Object type created.

success
boolean
object_type_id
string
object_type
object