> ## 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.

# Process email unsubscribe link

> Browser redirect endpoint for signed unsubscribe links generated in consumer automated template emails. A valid link records the consumer email opt-out, removes pending scheduled communications for the consumer, disables consumer-profile email permission, and redirects to the configured consumer frontend login with `unsubscribe=success`. Invalid, expired, or tampered links redirect to the same login page with `unsubscribe=invalid`.



## OpenAPI

````yaml /api/consumer.openapi.yaml get /unsubscribe-email/{data}
openapi: 3.1.0
info:
  title: YouNegotiate Consumer API
  version: '2.0'
  description: >-
    Stateless API endpoints for consumer portal authentication and account
    access.
servers:
  - url: https://api.consumer.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public consumer domain system and health endpoints.
  - name: Authentication
    description: >-
      Consumer identity matching, contact capture, OTP verification, token
      creation, and logout endpoints.
  - name: Profile - My ecoAddress
    description: Consumer profile tab for signed-in identity / ecoAddress context.
  - name: Profile - Communication Controls
    description: >-
      Consumer profile tab for communication permissions, email/mobile changes,
      and email/mobile verification.
  - name: Profile - My Billing Details
    description: >-
      Consumer profile tab for billing name and billing address details used for
      payment verification.
  - name: Profile - Personalize My Portal
    description: Consumer profile tab for portal colors and profile image personalization.
  - name: Accounts
    description: Consumer-owned account list and account detail endpoints.
  - name: Bill Pay Wallet
    description: >-
      Consumer Bill Pay Wallet saved payment profiles and scheduled payment
      method update endpoints.
  - name: Upcoming Payments
    description: >-
      Consumer My Bill Pay Calendar upcoming-payment rows and calendar display
      data.
  - name: Calendar Sync
    description: >-
      Consumer Google and Microsoft calendar connection, OAuth callback, and
      live-update endpoints.
  - name: Gift Registry
    description: >-
      Consumer Bill Pay Gift Registry account list, shared registry, and Helping
      Hand link endpoints.
  - name: EcoMailbox
    description: Consumer MyEcoMailBox list endpoints and unread sidebar badge state.
  - name: Notice Responses
    description: >-
      Consumer My Account notice-response wizard endpoints for sender details
      and account details.
paths:
  /unsubscribe-email/{data}:
    get:
      tags:
        - System
      summary: Process email unsubscribe link
      description: >-
        Browser redirect endpoint for signed unsubscribe links generated in
        consumer automated template emails. A valid link records the consumer
        email opt-out, removes pending scheduled communications for the
        consumer, disables consumer-profile email permission, and redirects to
        the configured consumer frontend login with `unsubscribe=success`.
        Invalid, expired, or tampered links redirect to the same login page with
        `unsubscribe=invalid`.
      operationId: consumerUnsubscribeEmail
      parameters:
        - name: data
          in: path
          required: true
          description: >-
            Encrypted unsubscribe payload generated by the backend email
            template.
          schema:
            type: string
          example: encrypted-payload
        - name: signature
          in: query
          required: true
          description: Laravel URL signature generated by the backend.
          schema:
            type: string
          example: signed
      responses:
        '302':
          description: >-
            Redirects to the consumer frontend login page with either
            `unsubscribe=success` or `unsubscribe=invalid`.
          headers:
            Location:
              description: Consumer frontend login URL with unsubscribe status.
              schema:
                type: string
                format: uri
              example: https://app.consumer.younegotiate.com/login?unsubscribe=success

````