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

# Edit a workspace objection

> Update supplied fields with last-write-wins semantics; omitted fields stay unchanged and null clears nullable fields. Cannot move a letter to another filing. Answered status requires a response submission from this filing; reopening requires clearing answeredBySubmissionId. Requires edit access to a managed filing. No triage or SERFF action is triggered.



## OpenAPI

````yaml /openapi.json patch /objections/{id}
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://api.effectiveai.app/api/v2
    description: Production
security:
  - bearerAuth: []
paths:
  /objections/{id}:
    patch:
      tags:
        - Objections
      summary: Edit a workspace objection
      description: >-
        Update supplied fields with last-write-wins semantics; omitted fields
        stay unchanged and null clears nullable fields. Cannot move a letter to
        another filing. Answered status requires a response submission from this
        filing; reopening requires clearing answeredBySubmissionId. Requires
        edit access to a managed filing. No triage or SERFF action is triggered.
      operationId: updateObjection
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2ObjectionUpdate'
      responses:
        '200':
          description: Workspace record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Objection'
        '400':
          description: Invalid request, fields, or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: Insufficient permission for this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: >-
            Filing, objection, item, comment, or reference missing or
            inaccessible.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: Read-only filing, duplicate sequence number, or dependent record.
          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:
    V2ObjectionUpdate:
      type: object
      properties:
        seq:
          type: integer
          minimum: 1
          maximum: 2147483647
          description: Positive letter or item number, unique within its parent.
        receivedAt:
          type: string
          format: date-time
          description: UTC timestamp when the letter was received.
        reviewerName:
          type: string
          nullable: true
          minLength: 1
          maxLength: 20000
          pattern: \S
        dueDate:
          type: string
          nullable: true
          format: date
          description: Response due date, YYYY-MM-DD; null when not set.
        stateStatus:
          type: string
          nullable: true
          minLength: 1
          maxLength: 20000
          pattern: \S
          description: Regulator status text, preserved as supplied; null when not set.
        status:
          type: string
          enum:
            - open
            - answered
        answeredBySubmissionId:
          type: string
          nullable: true
          format: uuid
          description: >-
            Response submission belonging to this filing. Required only when
            status is answered.
      additionalProperties: false
    V2Objection:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Workspace objection ID. Use /objections/{id} for detail and triage.
        filingId:
          type: string
          format: uuid
        seq:
          type: integer
          minimum: 1
          maximum: 2147483647
          description: Positive letter or item number, unique within its parent.
        receivedAt:
          type: string
          format: date-time
          description: UTC timestamp when the letter was received.
        reviewerName:
          type: string
          nullable: true
          minLength: 1
          pattern: \S
        dueDate:
          type: string
          nullable: true
          format: date
          description: Response due date, YYYY-MM-DD; null when not set.
        stateStatus:
          type: string
          nullable: true
          minLength: 1
          pattern: \S
          description: Regulator status text, preserved as supplied; null when not set.
        status:
          type: string
          enum:
            - open
            - answered
        answeredBySubmissionId:
          type: string
          nullable: true
          format: uuid
          description: >-
            Response submission belonging to this filing. Required only when
            status is answered.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - filingId
        - seq
        - receivedAt
        - reviewerName
        - dueDate
        - stateStatus
        - status
        - answeredBySubmissionId
        - 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.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          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.