Pipelines

Create pipeline field

Changed on

Creates a custom field in a pipeline.

post/v2/pipelines/{pipelineKey}/fields

Request

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

Path parameters

pipelineKeystring required

Request body

namestring required

Field name.

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

Initial default value. Currently only used for formula fields.

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