Skip to content

Update a Pipeline
Stable

Request

Security
SCAPIAuthToken
Path
pipeline_idstringrequired

ID of the Pipeline

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

Responses

Updated Pipeline Information

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