Skip to content

Update an Operation List
Stable

Request

⚠️ Android only. Pipelines run on Android devices only.

Fully updates an existing Operation List for a Pipeline stage.

Replaces the Operation List's metadata (name and description) for the specified stage. This is a full-replacement update, so include all writable fields in the request body. Returns the updated Operation List.

About Operation Lists An Operation List groups the individual Operations that a Stage executes. Updating it changes how the list is named and described, but it doesn't reorder or change the Operations inside it. Use the Operations endpoints for that.

Key Fields / Query Parameters

  • stage_id — UUID of the Stage (path parameter)
  • operationlist_id — UUID of the Operation List to update (path parameter)
  • name — Updated name of the Operation List
  • description — Updated description

Common Use Cases

  • Renaming an Operation List after a stage's purpose changes
  • Updating descriptions so pipeline runs are easier to read in reporting

Best Practices

  • Read the current Operation List first so you don't overwrite fields you meant to keep
  • Use the Operations endpoints, not this one, to add, remove, or change actions

Workflow

  1. Call GET /pipelines/v0/stages/{stage_id}/operationlists/ to find the Operation List
  2. Build the full request body with your changes
  3. Call this endpoint and confirm the returned values
Security
pipelines_SCAPIAuthToken
Path
stage_idstringrequired

ID of the Stage

operationlist_idstringrequired

ID of the Operation List

Bodyapplication/jsonrequired
pipeline_idstring
stage_idstring
namestring
descriptionstring
created_bynumber, (int32)
updated_bynumber, (int32)
created_atstring, (date-time)
updated_atstring, (date-time)
cURL
curl -i -X PUT \
  'https://develop-api.esper.io/_mock/openapi/pipelines/v0/stages/{stage_id}/operationlists/{operationlist_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pipeline_id": "string",
    "stage_id": "string",
    "name": "string",
    "description": "string",
    "created_by": 0,
    "updated_by": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }'

Responses

Updated Operation List Information

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