Skip to main content
POST
/
contacts
Create contact
curl --request POST \
  --url https://productlane.com/api/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "name": "<string>",
  "companyId": "<string>",
  "companyName": "<string>",
  "companyExternalId": "<string>"
}
'
{
  "id": "<string>",
  "email": "<string>",
  "name": "<string>",
  "imageUrl": "<string>",
  "companyId": "<string>",
  "workspaceId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "isDeleted": true,
  "version": 123,
  "intercomId": "<string>",
  "hubspotId": "<string>",
  "productboardId": "<string>",
  "zendeskId": "<string>"
}

​
Create Contact

Create a new contact for your workspace. You can optionally link the contact to a company using one of: companyId, companyName, or companyExternalId (only one can be provided).

​
Request Body

​
email
string
required
Contact email address
​
name
string
Contact name (1-255 characters)
​
companyId
string
Link contact to company by Productlane company ID. Provide only one of: companyId, companyName, or companyExternalId.
​
companyName
string
Link contact to company by company name. If company doesn’t exist, it will be created. Provide only one of: companyId, companyName, or companyExternalId.
​
companyExternalId
string
Link contact to company by your organization’s external ID. Useful for linking contacts without using Productlane IDs. Provide only one of: companyId, companyName, or companyExternalId.

​
Response

​
id
string
Unique identifier for the created contact
​
name
string
Contact name
​
email
string
Contact email address
​
companyId
string
ID of the associated company
​
company
object
Associated company information
​
company.id
string
Company ID
​
company.name
string
Company name
​
company.domains
string[]
Company domains
​
createdAt
string
Timestamp when the contact was created
​
updatedAt
string
Timestamp when the contact was last updated
​
workspaceId
string
ID of the workspace this contact belongs to

​
Example Request

{
  "name": "John Doe",
  "email": "john@acme.com",
  "companyName": "Acme Corp"
}

​
Example Response

{
  "id": "contact_123456789",
  "name": "John Doe",
  "email": "john@acme.com",
  "companyId": "comp_123456789",
  "company": {
    "id": "comp_123456789",
    "name": "Acme Corp",
    "domains": ["acme.com"]
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "workspaceId": "ws_123456789"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
email
string<email>
required
Maximum string length: 254
​
name
string
Required string length: 1 - 255
​
companyId
string
Required string length: 1 - 255
​
companyName
string
Required string length: 1 - 255
​
companyExternalId
string
Required string length: 1 - 255

Response

Successful response

​
id
string
required
​
email
string
required
​
name
string | null
required
​
imageUrl
string | null
required
​
companyId
string | null
required
​
workspaceId
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
isDeleted
boolean
required
​
version
number
required
​
intercomId
string | null
​
hubspotId
string | null
​
productboardId
string | null
​
zendeskId
string | null