OCoctolane-org
CRM

Bulk create contact fields

Changed on

Creates contact custom field definitions in bulk.

post/v1/contacts/fields/bulk

Request

  • Base URL
    https://api.octolane.com
  • Auth
    API key in header x-api-key

Request body

namestring required
property_namestring

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

attribute_type'string' | 'number' | 'checkbox' | 'date' | 'date_range' | 'rating' | 'timestamp' | 'select' | 'multi_select' | 'currency' | 'percentage' | 'location' | 'time' | 'datetime' | 'email' | 'phone' | 'website' | 'url' | 'radio' | 'team_members' required
metadataobject nullable

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

orderinteger nullable
is_hiddenboolean

Example request

[
  {
    "name": "Customer Tier",
    "property_name": "customer_tier"
  }
]

Response

Contact fields were created.

successboolean
messagestring
dataunknown

Example response

{
  "success": true
}

Changes