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

# Update Transaction Display Author

> Sets the user-visible `displayAuthor` label on an existing transaction —
the retroactive counterpart of the optional `displayAuthor` field on the
endorse and new-business endpoints, for labeling transactions created
before a label was supplied (e.g. historical imports shown as
"Data Import").

This updates **display metadata only**: policy state is materialized from
the immutable transaction history and cannot be modified here, and audit
attribution (`createdBy`) is never changed. `displayAuthor` is the only
accepted field.

**Required permission:** `policy:update`




## OpenAPI

````yaml /openapi/generated-external-api.yaml patch /api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}:
    patch:
      tags:
        - Field Model Policy Transactions
      summary: Update Transaction Display Author
      description: >
        Sets the user-visible `displayAuthor` label on an existing transaction —

        the retroactive counterpart of the optional `displayAuthor` field on the

        endorse and new-business endpoints, for labeling transactions created

        before a label was supplied (e.g. historical imports shown as

        "Data Import").


        This updates **display metadata only**: policy state is materialized
        from

        the immutable transaction history and cannot be modified here, and audit

        attribution (`createdBy`) is never changed. `displayAuthor` is the only

        accepted field.


        **Required permission:** `policy:update`
      operationId: patchPolicyTransactionDisplayAuthor
      parameters:
        - $ref: '#/components/parameters/companyId'
        - $ref: '#/components/parameters/policyIdPath'
        - $ref: '#/components/parameters/transactionId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - displayAuthor
              properties:
                displayAuthor:
                  type: string
                  maxLength: 255
                  description: >-
                    The user-visible author label (trimmed; must be non-empty).
                    Displayed in place of the creating user's name.
            examples:
              dataImport:
                summary: Label an imported transaction
                value:
                  displayAuthor: Data Import
      responses:
        '200':
          description: The updated transaction
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FMV1PolicyTransactionResponse'
              examples:
                updated:
                  summary: Transaction with the new label
                  value:
                    id: 550e8400-e29b-41d4-a716-446655440020
                    policyId: 550e8400-e29b-41d4-a716-446655440001
                    policyVersion: 2
                    action: ENDORSE
                    effectiveDate: '2025-06-01'
                    transactionTimestamp: '2025-05-28T14:30:00.000Z'
                    createdAt: '2025-05-28T14:30:00.000Z'
                    createdBy: 550e8400-e29b-41d4-a716-446655440090
                    displayAuthor: Data Import
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                emptyLabel:
                  summary: Empty displayAuthor
                  value:
                    error:
                      code: VALIDATION_ERROR
                      message: displayAuthor must not be empty
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Transaction or policy not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                transactionNotFound:
                  summary: Transaction not found
                  value:
                    error:
                      code: NOT_FOUND
                      message: >-
                        Transaction 550e8400-e29b-41d4-a716-446655440099 not
                        found for policy 550e8400-e29b-41d4-a716-446655440001
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
    policyIdPath:
      name: policyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Policy identifier
    transactionId:
      name: transactionId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Transaction identifier
  schemas:
    FMV1PolicyTransactionResponse:
      type: object
      description: >
        A policy transaction in the transaction-based policy model. Each
        transaction

        represents an immutable change set (new business, endorsement,
        cancellation,

        reinstatement, or renewal) that produces a new policy version.
      required:
        - id
        - policyId
        - policyVersion
        - action
        - effectiveDate
        - transactionTimestamp
        - createdAt
        - createdBy
        - displayAuthor
      properties:
        id:
          type: string
          format: uuid
          description: Transaction identifier
        policyId:
          type: string
          format: uuid
          description: Policy identifier
        policyVersion:
          type: integer
          description: Sequential version number produced by this transaction
        action:
          type: string
          enum:
            - NEW_BUSINESS
            - ENDORSE
            - CANCEL
            - REINSTATE
            - RENEW
          description: Type of transaction
        effectiveDate:
          type: string
          format: date
          description: When the transaction takes effect (ISO 8601)
        transactionTimestamp:
          type: string
          format: date-time
          description: When the business decision was made (ISO 8601)
        createdAt:
          type: string
          format: date-time
          description: When the transaction record was created (ISO 8601)
        createdBy:
          type: string
          nullable: true
          description: User ID who created the transaction (null if system-created)
        displayAuthor:
          type: string
          nullable: true
          description: >-
            User-visible author label override (e.g. "Data Import" on historical
            imports). When set, UIs display it in place of the creating user's
            name; audit attribution stays in `createdBy`. Null on normal writes.
        deltas:
          type: array
          description: |
            Per-field deltas that make up this transaction. Only present on the
            get-single-transaction endpoint.
          items:
            $ref: '#/components/schemas/PolicyTransactionDeltaResponse'
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
    PolicyTransactionDeltaResponse:
      type: object
      description: >
        A per-field delta representing a single change applied by a policy
        transaction.

        Each delta targets a specific field path within a date range (segment
        window).
      required:
        - id
        - transactionId
        - startDate
        - endDate
        - path
        - action
        - value
      properties:
        id:
          type: string
          format: uuid
          description: Delta identifier
        transactionId:
          type: string
          format: uuid
          description: Transaction that produced this delta
        startDate:
          type: string
          format: date
          description: Start of the date range this delta applies to (ISO 8601)
        endDate:
          type: string
          format: date
          description: End of the date range this delta applies to (ISO 8601)
        path:
          type: string
          description: >
            Field path within the policy data, always prefixed with `policy.`.
            Collection

            items use predicate addressing — `key[field = 'value']` — which must
            resolve to

            exactly one element (e.g., `policy.annualPremium`,

            `policy.exposures[id =
            '550e8400-e29b-41d4-a716-446655440010'].bedCount`,

            `policy.fullTermPricingInfo`). For NEW_BUSINESS and RENEW

            transactions, the path is simply `policy` representing the entire
            policy blob.
        action:
          type: string
          enum:
            - Add
            - Remove
            - Overwrite
          description: |
            Type of change:
            - `Add` — field was added (new value)
            - `Remove` — field was removed
            - `Overwrite` — field value was overwritten
        value:
          description: >-
            The value associated with this delta. For `Add` and `Overwrite`,
            this is the new value. For `Remove`, this is the value that was
            removed from the collection.
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: UncaughtActionError
                  message: Uncaught error occurred in <actionName>
                  userMessages:
                    - An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Send your raw API key as the `Authorization`
        header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
        NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
        header; those are not accepted.

````