Skip to main content
PATCH
/
contacts
/
{id}
Update contact
curl --request PATCH \
  --url https://productlane.com/api/v1/contacts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "email": "jsmith@example.com",
  "companyId": "<string>",
  "companyName": "<string>",
  "companyExternalId": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "companyId": "<string>",
  "company": {
    "id": "<string>",
    "name": "<string>",
    "domains": [
      "<string>"
    ]
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "workspaceId": "<string>"
}

Update Contact

Update an existing contact by ID. You can optionally update the contact’s company link using one of: companyId, companyName, or companyExternalId (only one can be provided).

Path Parameters

id
string
required
Contact ID (1-255 characters)

Request Body

name
string
Contact name (1-255 characters)
email
string
Contact email address
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 updated 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 Smith",
  "email": "john.smith@acme.com",
  "companyName": "Acme Corporation"
}

Example Response

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

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required
Required string length: 1 - 255

Body

application/json
name
string
Required string length: 1 - 255
email
string<email>
companyId
string

Link contact to company by Productlane company ID

Required string length: 1 - 255
companyName
string

Link contact to company by company name

Required string length: 1 - 255
companyExternalId
string

Link contact to company by your organization's external ID

Required string length: 1 - 255

Response

Successful response

id
string
required
name
string
required
email
string
required
companyId
string
required
company
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
workspaceId
string
required