Skip to main content
POST
/
contacts
Create a contact
curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "John",
  "company_id": 123,
  "last_name": "Smith",
  "email": "john.smith@acmecorp.com",
  "phone_1": "555-987-6543",
  "phone_2": "555-555-5555",
  "receiving_bank_name": "<string>",
  "receiving_bank_address": "<string>",
  "is_primary": false,
  "receive_quotation_pdf": false,
  "receive_purchase_order_pdf": false,
  "receive_purchase_order_invoice_pdf": false,
  "tags": [
    "sales",
    "primary"
  ]
}
'
{
  "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
  }
}

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To obtain a token, contact developers@joinluminous.com

Body

application/json
first_name
string
required

Contact's first name

Maximum string length: 255
Example:

"John"

company_id
integer
required

ID of the company this contact belongs to

Example:

123

last_name
string | null

Contact's last name

Maximum string length: 255
Example:

"Smith"

email
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

tags
string[] | null

Tags to associate with the contact

Maximum string length: 255
Example:
["sales", "primary"]

Response

Contact successfully created

data
object