> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ionworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update SimplePipeline name/description

> Partially update a SimplePipeline's name and/or description.



## OpenAPI

````yaml https://api.ionworks.com/openapi.json patch /simple_pipelines/{simple_pipeline_id}
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.ionworks.com
    description: Production
security: []
paths:
  /simple_pipelines/{simple_pipeline_id}:
    patch:
      tags:
        - simple_pipeline
      summary: Update SimplePipeline name/description
      description: Partially update a SimplePipeline's name and/or description.
      operationId: update_simple_pipeline_simple_pipelines__simple_pipeline_id__patch
      parameters:
        - name: simple_pipeline_id
          in: path
          required: true
          schema:
            type: string
            title: Simple Pipeline Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SimplePipelineUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimplePipeline'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SimplePipelineUpdateRequest:
      properties:
        name:
          anyOf:
            - type: string
              maxLength: 255
              minLength: 1
            - type: 'null'
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
      type: object
      title: SimplePipelineUpdateRequest
      description: Request body for partially updating a SimplePipeline (name/description).
    SimplePipeline:
      properties:
        id:
          type: string
          title: Id
        project_id:
          type: string
          title: Project Id
        organization_id:
          type: string
          title: Organization Id
        user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: User Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        status:
          $ref: '#/components/schemas/PipelineStatus'
        job_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Job Id
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        error_code:
          anyOf:
            - $ref: '#/components/schemas/JobErrorCode'
            - type: 'null'
        created_by_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By Email
        config_path:
          type: string
          title: Config Path
        result:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Result
      type: object
      required:
        - id
        - project_id
        - organization_id
        - status
        - created_at
        - updated_at
        - config_path
      title: SimplePipeline
      description: Full model for detail responses and DB records.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PipelineStatus:
      type: string
      enum:
        - pending
        - running
        - completed
        - failed
        - canceled
      title: PipelineStatus
    JobErrorCode:
      type: string
      enum:
        - CONFIGURATION_ERROR
        - MODEL_ERROR
        - SOLVER_ERROR
        - EXECUTION_TIMEOUT
        - SUBMISSION_FAILED
        - INTERNAL_ERROR
      title: JobErrorCode
      description: Machine-readable error codes for jobs.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````