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

# Preview Consumer Profile EcoLetter

> Return the rendered HTML content for a normal EcoLetter History row. Template fields are swapped against the routed consumer account, matching the Consumer Profile modal preview. CFPB template rows must use the CFPB PDF download endpoint instead.



## OpenAPI

````yaml /api/creditor.openapi.yaml get /manage-consumers/{consumer}/e-letters/{consumerELetter}
openapi: 3.1.0
info:
  title: YouNegotiate Creditor API
  version: '2.0'
  description: >-
    Stateless API endpoints for creditor portal authentication and account
    access.
servers:
  - url: https://api.creditor.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public creditor domain system and health endpoints.
  - name: Authentication
    description: Creditor registration, login, password, and email verification endpoints.
  - name: Account Settings
    description: >-
      Authenticated creditor profile, contact, operating-hours, and
      profile-image endpoints.
  - name: Account Profile
    description: >-
      Creditor onboarding profile, membership, billing, and setup status
      endpoints.
  - name: Setup Wizard
    description: >-
      Creditor setup wizard status, required-step completion, and optional-step
      completion.
  - name: Dashboard
    description: Creditor dashboard work queues and performance widgets.
  - name: Import / Export
    description: >-
      Creditor consumer import upload sessions, queued imports, history,
      downloads, and failed-row files.
  - name: Membership Settings
    description: >-
      Creditor membership dashboard, plan changes, payment method, cancellation,
      special-plan inquiry, and over-limit retry endpoints.
  - name: Merchant Account
    description: >-
      Existing merchant processor credentials, Tilled onboarding, and merchant
      application endpoints.
  - name: Header Profiles
    description: >-
      CSV header profile upload, mapping, download, and setup wizard completion
      endpoints.
  - name: SFTP Connections
    description: >-
      Creditor-managed SFTP connection profiles for imports, exports, and setup
      wizard completion.
  - name: Sub Accounts
    description: >-
      Creditor-managed sub account list, export, create, update, and delete
      endpoints.
  - name: Pay Terms Offers
    description: >-
      Creditor-managed master, sub-account, group, and group-sub-account Pay
      Terms endpoints.
  - name: Individual Custom Offers
    description: Creditor individual custom offer list endpoints.
  - name: Negotiations
    description: >-
      Creditor negotiation work queues, including notice responses and offer
      review counts.
  - name: Communications / CFPB Validation Letter
    description: >-
      CFPB Validation Letter tables, secure EcoLetter send/resend, CSV export,
      and print/download actions.
  - name: Communications / EcoLetter Template
    description: >-
      Creditor EcoLetter template management for secure eLetter communications
      and campaigns.
  - name: Communications / Groups
    description: >-
      Creditor communication group management for dynamic consumer targeting and
      campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Creditor EcoLetter campaign scheduling, quote, immediate send, and
      delivery queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Creditor campaign tracker reporting, refresh, and consumer export
      endpoints.
  - name: Consumer Profiles
    description: Creditor Consumer Profiles list, filter options, and CSV export endpoints.
  - name: Terms & Conditions
    description: Creditor-managed master and sub-account Terms & Conditions templates.
  - name: About Us & Contact
    description: Creditor-managed company About Us content shown to consumers.
  - name: Logo & Links
    description: >-
      Creditor-managed master and sub-account personalized logo colors, size,
      and consumer link metadata.
  - name: Users
    description: >-
      Master creditor user management, invitations, and account deletion
      endpoints.
paths:
  /manage-consumers/{consumer}/e-letters/{consumerELetter}:
    get:
      tags:
        - Consumer Profiles
      summary: Preview Consumer Profile EcoLetter
      description: >-
        Return the rendered HTML content for a normal EcoLetter History row.
        Template fields are swapped against the routed consumer account,
        matching the Consumer Profile modal preview. CFPB template rows must use
        the CFPB PDF download endpoint instead.
      operationId: creditorPreviewManageConsumerELetter
      parameters:
        - name: consumer
          in: path
          required: true
          description: Consumer account ID.
          schema:
            type: integer
        - name: consumerELetter
          in: path
          required: true
          description: Consumer EcoLetter row ID from the EcoLetter History list response.
          schema:
            type: integer
      responses:
        '200':
          description: Rendered EcoLetter content returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManageConsumerELetterPreviewResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/ActiveMembershipRequired'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: >-
            The EcoLetter row is a CFPB template and must be downloaded as a
            PDF.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ManageConsumerELetterPreviewResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/ManageConsumerELetterPreview'
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ManageConsumerELetterPreview:
      type: object
      additionalProperties: false
      required:
        - id
        - e_letter_id
        - content
      properties:
        id:
          type: integer
          example: 120
        e_letter_id:
          type: integer
          example: 84
        content:
          type: string
          description: >-
            Rendered HTML content after EcoLetter template fields are swapped
            against the consumer account.
          example: <p>Hello Jane, please review your secure e-letter.</p>
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ActiveMembershipRequired:
      description: Authenticated creditor does not have an active membership.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: An active membership is required.
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````