Update a pipeline

post https://api.streak.com/api/v1/pipelines/{pipelineKey}

This call lets you edit the properties of a pipeline.

time	status	user agent
Retrieving recent requests…

Loading…

To change the fields or the stages property, you must use different endpoints. The fields and stages are only provided as a convenience here. The necessary endpoints are specified in the Field and Stage section of this document.

🚧
Content Type and Auth
Make sure to include -H "Content-Type: application/json" and your authorization in any request you make on your own.

Path Params

pipelineKey

string

required

The key of the pipeline to be edited

Body Params

name

string

The new name of the pipeline

stageOrder

array of strings

A JSON array containing ordering of stage keys. The elements of this array are allowed to be re-ordered only. The order of this array affects the UI of the pipeline in the Web UI.

stageOrder

orgWide

boolean

A boolean indicating whether this pipeline is shared to everyone in the organization. For Google apps customers this means any other user with the same domain in their email address. This field has no effect for regular Gmail users.

teamKey

string

A new team to share this pipeline

aclEntries

array of objects

This is a JSON array of objects representing who the pipeline is currently shared with. You can add and remove objects in a single update. Each object in this array is required to have 1 property - email. Adding a user to the aclEntries causes them to receive an email informing them that the pipeline has been shared with them.

aclEntries

Responses

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.streak.com/api/v1/pipelines/pipelineKey \
3
     --header 'Content-Type: application/json' \
4
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

🚧Content Type and Auth

200200

400400

🚧
Content Type and Auth