Skip to main content
POST
Create property definition

Authorizations

Authorization
string
header
required

API key authentication via Bearer token

Headers

idempotency-key
string

Key that makes this request safe to retry. Reuse the same value when retrying a request that may already have succeeded — the original response is replayed with an Idempotency-Replay: true header. Use a new value for a new operation.

Required string length: 1 - 255
Example:

"9f8c2b1a-4d3e-4a6b-8c1d-2e3f4a5b6c7d"

Body

application/json
key
string
required
Pattern: ^[a-z][a-z0-9_]{0,62}$
label
string
required
Minimum string length: 1
valueType
enum<string>
required
Available options:
text,
number,
boolean,
date,
url,
select,
multi_select
objectTypes
enum<string>[]
required
Minimum array length: 1
Available options:
contact,
customer,
business
description
string | null
options
string[] | null
Minimum array length: 1
Minimum string length: 1

Response

Property definition created successfully

data
object
required
meta
object
Last modified on October 6, 2026