Skip to main content
POST
/
v1
/
contacts
/
fields
/
bulk
/
update
Bulk update contact fields
curl --request POST \
  --url https://api.octolane.com/v1/contacts/fields/bulk/update \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "property_name": "<string>",
    "name": "<string>",
    "current_name": "<string>",
    "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 definition patches. Maximum 100 items.

Required array length: 1 - 100 elements
​
id
string<uuid>
​
attribute_id
string<uuid>

Alias for id when updating pipeline fields.

​
property_name
string

Stable field identifier. This value cannot be changed by update APIs. If supplied with id or attribute_id, it must match the stored field property_name exactly.

Pattern: ^[a-z][a-z0-9_]*$
​
name
string

New display name.

​
current_name
string

New display name.

​
attribute_type
enum<string>

Can be changed only for custom fields, not system fields.

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
​
metadata
object
​
order
integer | null
Required range: x >= 1
​
is_hidden
boolean

Response

Contact fields were updated.

​
success
boolean
Example:

true

​
message
string
​
data
any

Endpoint-specific response payload.