PATCH /v1/pipelines/{pipeline_id}

Family: Pipelines · Operation ID: v1_update_pipeline

Access

Workspace API key: Authorization: Bearer <key>. The key is scoped to its workspace; the backend checks operation permissions and quota.

Open pipelines

Required scope: pipelines.write

Create a key in Developer settings. Set API_BASE_URL to the current app origin.

Request example

curl --fail-with-body -X PATCH "$API_BASE_URL/v1/pipelines/{pipeline_id}" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

Replace each {parameter} segment in the path with its URL-encoded value.

Parameters

[
  {
    "description": "Pipeline identifier",
    "in": "path",
    "name": "pipeline_id",
    "required": true,
    "schema": {
      "format": "int64",
      "type": "integer"
    }
  }
]

Request body · application/json

{
  "$ref": "#/components/schemas/UpdatePipelineInput",
  "definition": {
    "example": {
      "delivery": {
        "dashboard": true,
        "max_attempts": 5,
        "retry_backoff_seconds": 300,
        "webhook": null
      },
      "name": "Weekly Cleanup",
      "policy": {
        "missed_run_window_hours": 24
      },
      "schedule": {
        "cron": "0 9 * * 1",
        "timezone": "UTC"
      },
      "source": {
        "list_id": 123,
        "type": "list_snapshot"
      },
      "status": "active",
      "verification": {
        "delta_mode": true,
        "freshness_days": 30
      }
    },
    "properties": {
      "delivery": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PipelineDeliveryConfig"
          }
        ],
        "nullable": true
      },
      "name": {
        "nullable": true,
        "type": "string"
      },
      "policy": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PipelinePolicyConfig"
          }
        ],
        "nullable": true
      },
      "schedule": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PipelineSchedule"
          }
        ],
        "nullable": true
      },
      "source": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PipelineSource"
          }
        ],
        "nullable": true
      },
      "status": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PipelineStatus"
          }
        ],
        "nullable": true
      },
      "verification": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PipelineVerificationSettings"
          }
        ],
        "nullable": true
      }
    },
    "type": "object"
  }
}

Responses

200

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineView"
      }
    }
  },
  "description": "Pipeline updated"
}

400

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Bad request"
}

403

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Forbidden"
}

404

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Not found"
}

500

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Internal server error"
}

503

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/PipelineErrorResponse"
      }
    }
  },
  "description": "Service unavailable"
}

default

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract