Sign in

v3

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-273246117.6 KB
CRM

Bulk update pipeline fields

Updates opportunity field definitions for a pipeline in bulk. Identify each field by id/attribute_id or property_name. Opportunity fields are pipeline-scoped, so use this pipeline endpoint. property_name is a stable identifier and cannot be renamed; if you include it with id/attribute_id, it must match the stored field property_name exactly.

post/v1/pipelines/{pipeline_id}/fields/bulk/update

Path parameters

pipeline_idstring uuid required

Pipeline ID.

Request body

idstring uuid
attribute_idstring uuid

Alias for id when updating pipeline fields.

property_namestring

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.

namestring

New display name.

current_namestring

New display 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'
metadataobject nullable
orderinteger nullable
is_hiddenboolean

Response

Pipeline fields were updated.

successboolean
messagestring
{"stackTrail":"components:schemas:ApiResponse:properties:data","oasType":"schema","type":"unknown","description":"Endpoint-specific response payload."}

Example response

{
  "success": true
}