STstreakyc
Pipelines

Update pipeline field

Changed on

Updates a field's name, default value, options, or AI settings.

post/v1/pipelines/{pipelineKey}/fields/{fieldKey}

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v1/pipelines/{pipelineKey}/fields/{fieldKey}
  • Auth
    HTTP bearer

Path parameters

fieldKeystring required
pipelineKeystring required

Query parameters

addOnlyboolean

Append dropdown or tag options while retaining existing options. Defaults to false.

Request body

namestring nullable

New field name.

defaultValuestring nullable

New default value or formula.

Response

OK

keystring required

Field key within the pipeline.

namestring required

Field name.

type'TEXT_INPUT' | 'DROPDOWN' | 'CHECKBOX' | 'DATE' | 'PERSON' | 'FORMULA' | 'TAG' | 'TEAM_CONTACT' | 'TEAM_ORGANIZATION' required
defaultValueunknown
lastDefaultValueUpdatedTimestampinteger nullable

Timestamp when the default value last changed, in epoch milliseconds.

lastUpdatedTimestampinteger nullable

Timestamp when this field last changed, in epoch milliseconds.

Example response

{
  "lastDefaultValueUpdatedTimestamp": 1646870400000,
  "lastUpdatedTimestamp": 1646870400000
}

Changes