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

# Create a shareable link

> Generate a shareable link for tenants to order services at a specific address. The link can be shared via email or SMS. Tenants can use the link to browse available offers and place orders without needing to create an account.



## OpenAPI

````yaml https://api.offergrid.io/openapi-reseller post /reseller/links
openapi: 3.0.0
info:
  title: OfferGrid API
  description: >-
    **Reseller API** - Browse service catalog and place orders on behalf of
    customers.


    As a reseller, you can:

    - Browse available service offerings from providers

    - Filter offers by category, price, location, and search terms

    - View detailed offer information including pricing and features

    - Place orders for customers (single or multi-provider orders)

    - Track order status and fulfillment progress

    - Cancel pending orders
  version: '1.0'
  contact: {}
servers:
  - url: https://api.offergrid.io
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
tags:
  - name: reseller-catalog
    description: 'Reseller: Browse available service offerings'
  - name: reseller-availability
    description: 'Reseller: Find offers available at a service address'
  - name: reseller-orders
    description: 'Reseller: Place and manage orders'
  - name: reseller-customers
    description: 'Reseller: Manage customers and leads'
  - name: reseller-links
    description: 'Reseller: Manage shareable customer links'
paths:
  /reseller/links:
    post:
      tags:
        - reseller-links
      summary: Create a shareable link
      description: >-
        Generate a shareable link for tenants to order services at a specific
        address. The link can be shared via email or SMS. Tenants can use the
        link to browse available offers and place orders without needing to
        create an account.
      operationId: ResellerLinksController_create
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLinkDto'
      responses:
        '201':
          description: Link successfully created
      security:
        - api-key: []
components:
  schemas:
    CreateLinkDto:
      type: object
      properties:
        address:
          description: Service address for the tenant
          allOf:
            - $ref: '#/components/schemas/AddressDto'
        propertyName:
          type: string
          description: Property name or description
          example: Sunset Apartments Unit 205
        moveInDate:
          type: string
          description: Expected move-in date (ISO 8601)
          example: '2025-02-01'
      required:
        - address
      title: Create Link Request
    AddressDto:
      type: object
      properties:
        street:
          type: string
          example: 123 Main Street
        unit:
          type: string
          example: Unit 205
        city:
          type: string
          example: Austin
        state:
          type: string
          example: TX
        zipCode:
          type: string
          example: '78701'
        country:
          type: string
          example: US
          default: US
      required:
        - street
        - city
        - state
        - zipCode
        - country
      title: Address
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Team API key for authentication. Your team role
        (provider/reseller/hybrid) determines which endpoints you can access.

````