STstreakyc
Pipelines

Create pipeline

Changed on

Creates a basic pipeline.

post/v2/pipelines

Request

  • Base URL
    https://api.streak.com/api
  • URL
    https://api.streak.com/api/v2/pipelines
  • Auth
    HTTP bearer

Request body

namestring required

Pipeline name.

teamKeystring required

Key for the team that will own the pipeline.

stagesstring[] required

Stage names in display order.

iconstring nullable

Pipeline icon name.

descriptionstring nullable

Pipeline description.

templateTypestring nullable

Template identifier associated with the pipeline.

defaultPermissionSetNamestring nullable

Default permission set for users without an explicit assignment.

sharingRestrictedToTeamboolean nullable

Whether sharing is restricted to members of the owning team.

Response

The created pipeline.

keystring required

Key for this pipeline.

teamKeystring nullable

Key for the team that owns this pipeline.

creatorKeystring required

Key for the user who created this pipeline.

namestring required

Pipeline name.

iconstring required

Pipeline icon name.

descriptionstring nullable

Pipeline description.

sharingRestrictedToTeamboolean nullable

Whether sharing is restricted to the team.

stagesobject required

Stages in this pipeline, keyed by stage key.

stageOrderstring[] required

The display order of the stages

stageColorTheme'DEFAULT' | 'STREAK' | 'RAINBOW_SATURATED' | 'RAINBOW_FADED' | 'TRAFFIC_LIGHT_SATURATED' | 'TRAFFIC_LIGHT_FADED' | 'LAKESIDE_SATURATED' | 'LAKESIDE_FADED' | 'SUNSET_SATURATED' | 'SUNSET_FADED' | 'SUMMER_SATURATED' | 'SUMMER_FADED' | 'HALLOWEEN_SATURATED' | 'HALLOWEEN_FADED' | 'GREYSCALE' | 'BLUEGREY' | 'RED' | 'YELLOWORANGE' | 'GREEN' | 'TEAL' | 'CYAN' | 'BLUE' | 'INDIGO' | 'DEEPPURPLE' | 'VIOLET' | 'PINK' required
creationTimestampinteger required

Timestamp when the pipeline was created, in epoch milliseconds.

lastUpdatedTimestampinteger required

Timestamp when the pipeline was last updated, in epoch milliseconds.

formulasLastUpdatedTimestampinteger nullable

Latest formula-definition update timestamp, in epoch milliseconds.

customPermissionSetsobject required

Custom permission sets configured for this pipeline.

defaultPermissionSetNamestring required

Default permission set assigned to users without an explicit assignment.

creationSourceType'HUMAN' | 'SYSTEM_ONBOARDING' | 'AI_PIPELINE_CREATOR' required
boxCountinteger

Current number of boxes in the pipeline.

lastSavedTimestampinteger required

Timestamp when the pipeline was last persisted, in epoch milliseconds.

Example response

{
  "fields": [
    {
      "lastDefaultValueUpdatedTimestamp": 1646870400000,
      "lastUpdatedTimestamp": 1646870400000
    }
  ],
  "creationTimestamp": 1646870400000,
  "lastUpdatedTimestamp": 1646870400000,
  "formulasLastUpdatedTimestamp": 1646870400000,
  "lastSavedTimestamp": 1646870400000
}

Changes