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

# Mint and email a supplier portal link

> Mint a one-click portal link per contact and email each one. The link lets a
supplier open the purchase order without an account or password and respond
to it — accepting, rejecting, or proposing different quantities, prices or
ship dates.

One single-use token and one email per contact — never one email to several
addresses, because the first click would lock the other recipients out and
the audit trail could not say who responded. A contact whose email fails at
send time appears in `failed` without stopping the others; if nothing could
be sent, the response is a `400`.

Rate limited to **20 requests per minute**.




## OpenAPI

````yaml /api-reference/build.yaml post /purchase-orders/{purchaseOrderId}/supplier-portal-link
openapi: 3.0.0
info:
  title: Luminous API
  version: 1.0.0
  description: API documentation for Luminous
servers:
  - url: https://{companyName}.api.joinluminous.com/external/api/v1
    variables:
      companyName:
        default: companyName
        description: Your company-specific subdomain
security: []
tags:
  - name: Products
    description: Get and manage products
  - name: Pricing
    description: Manage price schedules, levels, and customizations
  - name: BOMs
    description: Manage Bills of Materials (BOMs)
  - name: Labels
    description: Label rendering via Labelary ZPL service
  - name: Companies
    description: Manage business accounts and their associated data
  - name: Contacts
    description: Manage contact information for individuals
  - name: Suppliers
    description: Manage suppliers (factories) — vendors used on purchase orders
  - name: Supplier SKUs
    description: Manage per-supplier SKU and unit-cost overrides for products
  - name: Locations
    description: Manage warehouses and locations
  - name: Inventory
    description: Get and adjust product stock levels
  - name: Lots
    description: Create, update, and delete product lots (batches)
  - name: Transfer Orders
    description: Manage transfer orders
  - name: Fulfillment Orders
    description: Manage fulfillment orders and picklists
  - name: Fulfillment Priority Lists
    description: Configure fulfillment routing priority lists
  - name: Purchase Orders
    description: Get and modify purchase orders
  - name: Supplier Portal
    description: >-
      Read a supplier's response to a purchase order and control the one-click
      portal link
  - name: Receiving Reports
    description: Manage receiving reports
  - name: Payment Obligations
    description: Manage payment obligations for purchase orders
  - name: Sales Orders
    description: Manage sales orders and sales order shipments
  - name: Purgatory
    description: >-
      Inspect and resolve non-posted sales orders in the purgatory staging
      workflow
  - name: PickFlow Shipping
    description: >-
      Provider-agnostic shipping rates, services, packages, and label purchase
      for PickFlow
  - name: Cycle Counts
    description: >-
      Create, drive, and post PickFlow cycle counts — batches, per-warehouse
      sessions, and CSV import/export
  - name: Print Stations
    description: List paired print stations and enqueue print jobs to them
  - name: Invoices
    description: Get and manage invoices
  - name: Work Orders
    description: >-
      Manage work orders — production lifecycle, steps, materials, links,
      shipments, and comments
  - name: Production Batches
    description: Group and manage work orders as production batches
  - name: Bills
    description: >-
      Accounts payable bill management, payments, attachments, allocations, and
      variance
  - name: Prepayments
    description: Manage vendor prepayments and applications
  - name: Vendor Credits
    description: Manage vendor credits and applications
  - name: Vendor Returns
    description: Manage vendor returns and credit generation
  - name: Customer Returns
    description: Manage customer returns (sales returns), receiving, and restock behavior
  - name: Stock Snapshot
    description: Point-in-time stock snapshots with export support
  - name: Consumption
    description: Consumption reports and exports
  - name: Inventory Aging
    description: Cost-layer-based inventory aging reports
  - name: Bills Reports
    description: Accounts payable bills aging reports
  - name: Forecast
    description: Materialized forecast data
  - name: Reports
    description: Close the books, inventory discrepancy, transaction COGS, and EDI reports
  - name: Tags
    description: Add/remove tags across various resources
  - name: Custom Fields
    description: Get and set custom fields across various resources
  - name: Currency
    description: Currency configuration, exchange rates, and conversion
  - name: Integration Mappings
    description: Manage integration mappings for external systems
  - name: Integration Field Mappings
    description: Manage field-level mappings between Luminous and external systems
paths:
  /purchase-orders/{purchaseOrderId}/supplier-portal-link:
    post:
      tags:
        - Supplier Portal
      summary: Mint and email a supplier portal link
      description: >
        Mint a one-click portal link per contact and email each one. The link
        lets a

        supplier open the purchase order without an account or password and
        respond

        to it — accepting, rejecting, or proposing different quantities, prices
        or

        ship dates.


        One single-use token and one email per contact — never one email to
        several

        addresses, because the first click would lock the other recipients out
        and

        the audit trail could not say who responded. A contact whose email fails
        at

        send time appears in `failed` without stopping the others; if nothing
        could

        be sent, the response is a `400`.


        Rate limited to **20 requests per minute**.
      operationId: sendSupplierPortalLink
      parameters:
        - in: path
          name: purchaseOrderId
          required: true
          schema:
            type: integer
          description: Purchase order ID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                contact_details_ids:
                  type: array
                  nullable: true
                  description: >
                    Limit delivery to these contacts. Omit to send to every
                    contact on the supplier. A contact that does not belong to
                    this purchase order's supplier is rejected — one contact row
                    can belong to several suppliers, so the pair is validated
                    rather than the id trusted.
                  items:
                    type: integer
                    minimum: 1
      responses:
        '200':
          description: At least one link was sent.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: string
                    example: Portal link sent.
                  data:
                    type: object
                    properties:
                      sent:
                        type: array
                        items:
                          type: string
                          format: email
                        example:
                          - ops@supplier.example
                      failed:
                        type: array
                        items:
                          type: string
                          format: email
                        example: []
        '400':
          description: No links could be sent, or the supplier has no emailable contact
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Purchase order not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '429':
          description: Rate limited (20 requests per minute)
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate using a bearer token. To create a token, navigate to
        /settings/api-tokens and click Create API Token.

````