curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/contacts/{contactId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "newemail@example.com"
}
'

{
  "data": {
    "id": "789123",
    "created_at": "2023-03-15T14:30:00Z",
    "updated_at": "2023-03-15T14:30:00Z",
    "status": "active",
    "first_name": "John",
    "last_name": "Smith",
    "email": "john.smith@acmecorp.com",
    "phone": "555-987-6543",
    "phone_2": "555-555-5555",
    "full_name": "John Smith",
    "company_id": "123456",
    "company": {
      "id": "123456",
      "name": "Acme Corporation"
    },
    "is_primary": true,
    "receive_quotation_pdf": false,
    "receive_purchase_order_pdf": false,
    "receive_purchase_order_invoice_pdf": false,
    "has_portal_login": false,
    "companies": [
      {
        "id": 123,
        "name": "<string>",
        "is_primary": true,
        "receive_quotation_pdf": true,
        "receive_purchase_order_pdf": true,
        "receive_purchase_order_invoice_pdf": true
      }
    ],
    "tags": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "color": "<string>"
      }
    ]
  }
}

Contacts

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
}

POST

contacts

{contactId}

curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/contacts/{contactId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "newemail@example.com"
}
'

{
  "data": {
    "id": "789123",
    "created_at": "2023-03-15T14:30:00Z",
    "updated_at": "2023-03-15T14:30:00Z",
    "status": "active",
    "first_name": "John",
    "last_name": "Smith",
    "email": "john.smith@acmecorp.com",
    "phone": "555-987-6543",
    "phone_2": "555-555-5555",
    "full_name": "John Smith",
    "company_id": "123456",
    "company": {
      "id": "123456",
      "name": "Acme Corporation"
    },
    "is_primary": true,
    "receive_quotation_pdf": false,
    "receive_purchase_order_pdf": false,
    "receive_purchase_order_invoice_pdf": false,
    "has_portal_login": false,
    "companies": [
      {
        "id": 123,
        "name": "<string>",
        "is_primary": true,
        "receive_quotation_pdf": true,
        "receive_purchase_order_pdf": true,
        "receive_purchase_order_invoice_pdf": true
      }
    ],
    "tags": [
      {
        "id": 123,
        "name": "<string>",
        "description": "<string>",
        "icon": "<string>",
        "color": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

contactId

integer

required

The unique identifier of the contact

Body

application/json

first_name

string | null

Contact's first name

Maximum string length: 255

Example:

"John"

last_name

string | null

Contact's last name

Maximum string length: 255

Example:

"Smith"

company_id

integer | null

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

string<email> | null

Contact's email address

Maximum string length: 255

Example:

"john.smith@acmecorp.com"

phone_1

string | null

Contact's primary phone number

Maximum string length: 255

Example:

"555-987-6543"

phone_2

string | null

Contact's secondary phone number

Maximum string length: 255

Example:

"555-555-5555"

receiving_bank_name

string | null

Bank name for receiving payments

Maximum string length: 255

receiving_bank_address

string | null

Bank address for receiving payments

Maximum string length: 255

is_primary

boolean | null

Whether this is the primary contact for the company

Example:

false

receive_quotation_pdf

boolean | null

Whether the contact should receive quotation PDFs

Example:

false

receive_purchase_order_pdf

boolean | null

Whether the contact should receive purchase order PDFs

Example:

false

receive_purchase_order_invoice_pdf

boolean | null

Whether the contact should receive purchase order invoice PDFs

Example:

false

Response

Contact successfully updated

data

object

Show child attributes

Single contact Set or rotate B2B portal password

Products & Catalog

Companies & Contacts

Inventory & Warehousing

Purchasing

Sales & Fulfillment

Manufacturing

Accounts Payable

Reports & Analytics

Configuration

Integrations

Update a contact

Update Behavior

B2B Portal Login

Examples

Authorizations

Path Parameters

Body

Response