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

# Create a contact

> Create a new contact. Requires `first_name` and either `company_id` or `company_ids`.

All other fields are optional and can be provided when creating the contact or updated later.

## B2B Portal Login

Include an optional `password` field (min 8 characters) to provision a B2B client portal login.
When `password` is provided, `email` is required. The response will include `has_portal_login: true`
when a portal login is linked.




## OpenAPI

````yaml /api-reference/build.yaml post /contacts
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: Purchase Orders
    description: Get and modify purchase orders
  - 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:
  /contacts:
    post:
      tags:
        - Contacts
      summary: Create a contact
      description: >
        Create a new contact. Requires `first_name` and either `company_id` or
        `company_ids`.


        All other fields are optional and can be provided when creating the
        contact or updated later.


        ## B2B Portal Login


        Include an optional `password` field (min 8 characters) to provision a
        B2B client portal login.

        When `password` is provided, `email` is required. The response will
        include `has_portal_login: true`

        when a portal login is linked.
      operationId: createContact
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - first_name
              properties:
                first_name:
                  type: string
                  maxLength: 255
                  description: Contact's first name
                  example: John
                last_name:
                  type: string
                  maxLength: 255
                  nullable: true
                  description: Contact's last name
                  example: Smith
                company_id:
                  type: integer
                  description: >-
                    ID of the company this contact belongs to (provide either
                    company_id or company_ids)
                  example: 123
                company_ids:
                  type: array
                  description: >-
                    Multiple company associations (alternative to company_id; do
                    not send both)
                  minItems: 1
                  items:
                    type: integer
                  example:
                    - 123
                    - 456
                email:
                  type: string
                  format: email
                  maxLength: 255
                  nullable: true
                  description: Contact's email address
                  example: john.smith@acmecorp.com
                phone_1:
                  type: string
                  maxLength: 255
                  nullable: true
                  description: Contact's primary phone number
                  example: 555-987-6543
                phone_2:
                  type: string
                  maxLength: 255
                  nullable: true
                  description: Contact's secondary phone number
                  example: 555-555-5555
                receiving_bank_name:
                  type: string
                  maxLength: 255
                  nullable: true
                  description: Bank name for receiving payments
                receiving_bank_address:
                  type: string
                  maxLength: 255
                  nullable: true
                  description: Bank address for receiving payments
                is_primary:
                  type: boolean
                  nullable: true
                  description: Whether this is the primary contact for the company
                  example: false
                receive_quotation_pdf:
                  type: boolean
                  nullable: true
                  description: Whether the contact should receive quotation PDFs
                  example: false
                receive_purchase_order_pdf:
                  type: boolean
                  nullable: true
                  description: Whether the contact should receive purchase order PDFs
                  example: false
                receive_purchase_order_invoice_pdf:
                  type: boolean
                  nullable: true
                  description: >-
                    Whether the contact should receive purchase order invoice
                    PDFs
                  example: false
                tags:
                  type: array
                  nullable: true
                  description: Tags to associate with the contact
                  items:
                    type: string
                    maxLength: 255
                  example:
                    - sales
                    - primary
                password:
                  type: string
                  format: password
                  minLength: 8
                  maxLength: 255
                  description: >-
                    Optional. Creates a B2B portal login when `email` is also
                    provided. Required: `email` must be set when `password` is
                    provided.
      responses:
        '201':
          description: Contact successfully created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        description: Unique identifier for the contact
                        example: '789123'
                      created_at:
                        type: string
                        format: date-time
                        description: When the contact was created
                        example: '2023-03-15T14:30:00Z'
                      updated_at:
                        type: string
                        format: date-time
                        description: When the contact was last updated
                        example: '2023-03-15T14:30:00Z'
                      status:
                        type: string
                        description: Current status of the contact
                        example: active
                      first_name:
                        type: string
                        description: Contact's first name
                        example: John
                      last_name:
                        type: string
                        description: Contact's last name
                        example: Smith
                      email:
                        type: string
                        format: email
                        description: Contact's email address
                        example: john.smith@acmecorp.com
                      phone:
                        type: string
                        description: Contact's primary phone number
                        example: 555-987-6543
                      phone_2:
                        type: string
                        description: Contact's secondary phone number
                        example: 555-555-5555
                      full_name:
                        type: string
                        description: Contact's full name
                        example: John Smith
                      company_id:
                        type: string
                        description: ID of the company this contact belongs to
                        example: '123456'
                      company:
                        type: object
                        description: Company information for this contact
                        properties:
                          id:
                            type: string
                            example: '123456'
                          name:
                            type: string
                            example: Acme Corporation
                      is_primary:
                        type: boolean
                        description: Whether this is the primary contact for the company
                        example: true
                      receive_quotation_pdf:
                        type: boolean
                        description: Whether the contact should receive quotation PDFs
                        example: false
                      receive_purchase_order_pdf:
                        type: boolean
                        description: Whether the contact should receive purchase order PDFs
                        example: false
                      receive_purchase_order_invoice_pdf:
                        type: boolean
                        description: >-
                          Whether the contact should receive purchase order
                          invoice PDFs
                        example: false
                      has_portal_login:
                        type: boolean
                        description: >-
                          True when the contact has a linked B2B client portal
                          login
                        example: false
                      companies:
                        type: array
                        description: Companies associated with this contact (when loaded)
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              type: string
                              nullable: true
                            is_primary:
                              type: boolean
                            receive_quotation_pdf:
                              type: boolean
                            receive_purchase_order_pdf:
                              type: boolean
                            receive_purchase_order_invoice_pdf:
                              type: boolean
                      tags:
                        type: array
                        description: Tags associated with the contact
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              type: string
                            description:
                              type: string
                              nullable: true
                            icon:
                              type: string
                              nullable: true
                            color:
                              type: string
                              nullable: true
        '401':
          description: Authentication credentials were missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
                  message:
                    type: string
                    example: Authentication credentials are missing or invalid
                  status_code:
                    type: integer
                    example: 401
        '403':
          description: You do not have permission to perform this action
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Forbidden
                  message:
                    type: string
                    example: You do not have permission to access this resource
                  status_code:
                    type: integer
                    example: 403
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
      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.

````