Skip to content

Update a Pipeline Stage
Stable

Request

Updates the details of an existing Pipeline Stage.

Send a PUT request with the updated Stage fields to modify a step in the pipeline; the response returns the updated Stage object.

About Stages

A Stage is one ordered step in a Pipeline. Its own configuration is managed separately from the Target Lists and Operation Lists attached to it, which are updated through their own dedicated endpoints.

Security
pipelines_SCAPIAuthToken
Path
pipeline_idstringrequired

ID of the Pipeline

stage_idstringrequired

ID of the Stage

Bodyapplication/jsonrequired
namestring
descriptionstring
timeout_secondsnumber, (int32)
cURL
curl -i -X PUT \
  'https://api.esper.io/_mock/openapi/pipelines/v0/pipelines/{pipeline_id}/stages/{stage_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "timeout_seconds": 0
  }'

Responses

Updated Stage Information

Bodyapplication/json
codeinteger
messagestring
contentobject(pipelines_Stage)
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "id": "string",
    "enterprise_id": "string",
    "pipeline_id": "string",
    "description": "string",
    "name": "string",
    "timeout_seconds": 0,
    "created_by": 0,
    "updated_by": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}