Skip to main content
POST
/
v1
/
contacts
/
fields
/
bulk
Bulk create contact fields
curl --request POST \
  --url https://api.octolane.com/v1/contacts/fields/bulk \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
[
  {
    "name": "Customer Tier",
    "property_name": "customer_tier",
    "metadata": {},
    "order": 2,
    "is_hidden": true
  }
]
'
{
  "success": true,
  "message": "<string>",
  "data": "<unknown>"
}

Authorizations

​
x-api-key
string
header
required

Public API key for the Octolane organization.

Body

application/json

Array of field definitions to create. Maximum 100 items.

Required array length: 1 - 100 elements
​
name
string
required
Example:

"Customer Tier"

​
attribute_type
enum<string>
required
Available options:
string,
number,
checkbox,
date,
date_range,
rating,
timestamp,
select,
multi_select,
currency,
percentage,
location,
time,
datetime,
email,
phone,
website,
url,
radio,
team_members
​
property_name
string

Optional stable field key. If omitted, Octolane generates a unique property name.

Pattern: ^[a-z][a-z0-9_]*$
Example:

"customer_tier"

​
metadata
object

Optional field metadata. For select fields, include select_options with label/value/color/order entries.

​
order
integer | null
Required range: x >= 1
​
is_hidden
boolean

Response

Contact fields were created.

​
success
boolean
Example:

true

​
message
string
​
data
any

Endpoint-specific response payload.