Create contact

Create a contact. Requires the contacts:write scope.

POST /contacts

Create contact

cURL

curl --request POST \
  --url https://productlane.com/api/v2/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[e-mail]",
  "name": "<string>",
  "is_subscribed": true,
  "company_id": "<string>",
  "company_name": "<string>",
  "company_external_id": "<string>"
}
'

200

{
  "id": "<string>",
  "email": "<string>",
  "name": "<string>",
  "image_url": "<string>",
  "company_id": "<string>",
  "is_subscribed": true,
  "external_ids": {
    "intercom": "<string>",
    "front": "<string>",
    "zendesk": "<string>",
    "hubspot": "<string>",
    "plain": "<string>",
    "productboard": "<string>",
    "slack_channel": "<string>"
  },
  "created_at": "<string>",
  "updated_at": "<string>"
}

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

is_subscribed · boolean

Receives changelog and per-project/issue update emails. Defaults to true.

company_id · string

Productlane company id. Mutually exclusive with company_name and company_external_id.

Required string length: 1 - 255

company_name · string

Resolves a company by exact name. Errors if multiple companies share the name.

Required string length: 1 - 255

company_external_id · string

Resolves a company by an entry in its external_ids array.

Required string length: 1 - 255

Response

200

application/json

Successful response

id · string · required

email · string · required

name · string | null · required

image_url · string | null · required

company_id · string | null · required

is_subscribed · boolean · required

external_ids · object · required

Show child attributes

created_at · string · required

updated_at · string · required