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

# Edit or replace a working document reference

> Set supplied fields with last-write-wins semantics. Send both schedule fields as null to unassign an item. Replacing artifactId changes the working reference only. The item must belong to this filing; it cannot be moved. Retained submission versions are unchanged. Requires filing edit permission.



## OpenAPI

````yaml /openapi.json patch /managed-filings/{filingId}/items/{itemId}
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /managed-filings/{filingId}/items/{itemId}:
    patch:
      tags:
        - Managed Filings
      summary: Edit or replace a working document reference
      description: >-
        Set supplied fields with last-write-wins semantics. Send both schedule
        fields as null to unassign an item. Replacing artifactId changes the
        working reference only. The item must belong to this filing; it cannot
        be moved. Retained submission versions are unchanged. Requires filing
        edit permission.
      operationId: updateManagedFilingItem
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: filingId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: itemId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ManagedFilingItemUpdate'
      responses:
        '200':
          description: Updated item.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2ManagedFilingItem'
        '400':
          description: Invalid fields or request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: A write-capable user credential and edit access are required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: >-
            Filing, item, reference, or registered record type is missing or
            inaccessible.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            Read-only filing, occupied schedule position, dependency, or
            concurrent change.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '415':
          description: Content-Type must be application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency temporarily unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2ManagedFilingItemUpdate:
      type: object
      properties:
        artifactId:
          type: string
          format: uuid
        scheduleType:
          type: string
          nullable: true
          enum:
            - form
            - rate
            - rule
            - supporting_document
            - null
        scheduleSeqNo:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
          maximum: 2147483647
        context:
          type: string
          nullable: true
          minLength: 1
          maxLength: 20000
        attachments:
          type: array
          items:
            type: object
            properties:
              artifactId:
                type: string
                format: uuid
              artifactName:
                type: string
                minLength: 1
                maxLength: 1024
            required:
              - artifactId
              - artifactName
            additionalProperties: false
          maxItems: 100
          description: >-
            Related working files follow current content. Version pinning
            happens when recording a submission.
      additionalProperties: false
    V2ManagedFilingItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
        filingId:
          type: string
          format: uuid
        artifactId:
          type: string
          format: uuid
        artifactVersionId:
          type: string
          nullable: true
        scheduleType:
          type: string
          nullable: true
          enum:
            - form
            - rate
            - rule
            - supporting_document
            - null
        scheduleSeqNo:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
        context:
          type: string
          nullable: true
        attachments:
          type: array
          items:
            type: object
            properties:
              artifactId:
                type: string
                format: uuid
              artifactVersionId:
                type: string
                nullable: true
              artifactVersionNumber:
                type: integer
                minimum: 0
                exclusiveMinimum: true
              artifactName:
                type: string
            required:
              - artifactId
              - artifactVersionId
              - artifactName
            additionalProperties: false
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - filingId
        - artifactId
        - artifactVersionId
        - scheduleType
        - scheduleSeqNo
        - context
        - attachments
        - createdAt
        - updatedAt
      additionalProperties: false
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.