> ## 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. # Update a contact > Update an existing contact's information. **All fields are optional**, allowing partial updates. ## Update Behavior - **No fields are required** - you can update just one field or multiple fields - Only fields provided in the request will be updated; all other fields remain unchanged - `company_id` is optional - if not provided, the existing company association will be preserved - If `company_id` is provided, it must be a valid, non-empty integer that exists in the system - Changing the `company_id` will move the contact to the new company ## B2B Portal Login Include `password` (min 8 characters) to create or update the B2B client portal login. The contact must have an `email` set (either existing or provided in the same request). Changing `email` without `password` on a contact that already has a portal login will update the linked login's email to match (422 if that email is already used by another login). ## Examples ``` # Update only email POST /contacts/123 { "email": "newemail@example.com" } # Update multiple fields POST /contacts/123 { "first_name": "Updated", "last_name": "Name", "phone_1": "555-1234" } # Change company association POST /contacts/123 { "company_id": 456 } # Update without changing company (company_id omitted) POST /contacts/123 { "email": "updated@example.com", "is_primary": true } ``` ## OpenAPI ````yaml /api-reference/build.yaml post /contacts/{contactId} 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/{contactId}: post: tags: - Contacts summary: Update a contact description: > Update an existing contact's information. **All fields are optional**, allowing partial updates. ## Update Behavior - **No fields are required** - you can update just one field or multiple fields - Only fields provided in the request will be updated; all other fields remain unchanged - `company_id` is optional - if not provided, the existing company association will be preserved - If `company_id` is provided, it must be a valid, non-empty integer that exists in the system - Changing the `company_id` will move the contact to the new company ## B2B Portal Login Include `password` (min 8 characters) to create or update the B2B client portal login. The contact must have an `email` set (either existing or provided in the same request). Changing `email` without `password` on a contact that already has a portal login will update the linked login's email to match (422 if that email is already used by another login). ## Examples ``` # Update only email POST /contacts/123 { "email": "newemail@example.com" } # Update multiple fields POST /contacts/123 { "first_name": "Updated", "last_name": "Name", "phone_1": "555-1234" } # Change company association POST /contacts/123 { "company_id": 456 } # Update without changing company (company_id omitted) POST /contacts/123 { "email": "updated@example.com", "is_primary": true } ``` operationId: updateContact parameters: - name: contactId in: path required: true schema: type: integer description: The unique identifier of the contact requestBody: required: true content: application/json: schema: type: object properties: first_name: type: string maxLength: 255 nullable: true 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 nullable: true description: > ID of the company this contact belongs to. **For updates:** - Optional - if not provided, the existing company association will be preserved - If provided, must be a valid, non-empty integer that exists in the system - Cannot be an empty string or null if included in the request - Changing the `company_id` will move the contact to the new company example: 123 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 company_ids: type: array description: Multiple company associations (alternative to company_id) minItems: 1 items: type: integer password: type: string format: password minLength: 8 maxLength: 255 description: > Optional. Creates or updates the B2B client portal login for this contact. The contact must have an `email` set (either existing or provided in the same request). Changing `email` without `password` on a contact that already has a portal login will update the linked login's email to match. examples: partial_update_email: summary: Update only email description: >- Update just the email address, leaving all other fields unchanged value: email: newemail@example.com partial_update_name: summary: Update name fields description: Update first and last name without changing other fields value: first_name: Updated last_name: Name change_company: summary: Change company association description: Move contact to a different company value: company_id: 456 multiple_fields: summary: Update multiple fields description: Update several fields at once value: first_name: John last_name: Doe email: john.doe@example.com phone_1: 555-1234 is_primary: true set_portal_password: summary: Set B2B portal password description: Create or update the B2B portal login for a contact value: password: securePass1 change_email_with_portal: summary: Change email (syncs linked portal login) description: >- Changing email on a contact with an existing portal login updates the login email value: email: new.address@example.com empty_request: summary: Empty request body description: >- Send an empty object - no fields will be updated (request will succeed) value: {} responses: '200': description: Contact successfully updated 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 '404': description: The requested resource was not found content: application/json: schema: type: object properties: error: type: string example: Not Found message: type: string example: The requested resource could not be found status_code: type: integer example: 404 '422': description: Validation error content: application/json: schema: type: object properties: message: type: string errors: type: object additionalProperties: type: array items: type: string examples: invalid_email: summary: Invalid email format value: message: The given data was invalid. errors: email: - The email must be a valid email address. invalid_company_id: summary: Invalid company ID value: message: The given data was invalid. errors: company_id: - The specified company does not exist. empty_company_id: summary: Empty company ID value: message: The given data was invalid. errors: company_id: - Company ID cannot be empty if provided. 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. ````