Create thread

Create a thread and upsert its contact by email, or import a full conversation with messages. Requires the threads:write scope.

POST

/api/v2/threads

POST

/threads

curl -X POST "https://productlane.com/api/v2/threads" \
  -H "Authorization: Bearer $PRODUCTLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "pain_level": "UNKNOWN"
}'

Authorization

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

Body

application/json

external_ids
string[]
Caller-owned identifiers. Replaces the full set.
title
string
text
string
Thread body (HTML). Required unless messages is sent.
messages
object[]
Imports an existing conversation instead of text, stored as the channel's own messages. Nothing is sent, and no auto-reply, notification or Linear update runs.
pain_level
enum<string>
required
One of:
UNKNOWN
LOW
MEDIUM
HIGH
status
enum<string>
Initial status. Defaults to open.
One of:
open
snoozed
done
origin
enum<string>
Defaults to api. Use custom with custom_channel for a channel you connect yourself, such as WhatsApp or SMS.
One of:
in_app
portal
support_portal
email
slack
slack_connect
intercom
intercom_attachment
zendesk
zendesk_attachment
front_attachment
zapier
hubspot
plain
api
live_chat
ai_chat
calendar
widget
teams
linear
upvote
custom
custom_channel
string
Required when origin is custom: a lowercase name such as whatsapp or sms (1 to 32 characters, a-z, 0-9, _, -). The inbox shows it as the thread source.
contact_email
string<email>
Email of the contact. The contact is upserted by email within the workspace. Send this or contact_external_id.
contact_external_id
string
Your id for a contact without an email, such as whatsapp:+61400111222. The contact is upserted by it and never receives email. Send this or contact_email.
contact_name
string
Applied only when the contact is newly created.
assignee_id
string
Workspace user id (not a Linear user id).
company_id
string
project_id
string
issue_id
string
created_at
string<date-time>
updated_at
string<date-time>
notify
object
Side-channel notifications to fire alongside the write (Slack and/or email).

Response

application/json

Successful response

id
string
required
number
integer | null
required
Ticket number shown to customers as #123. Unique per workspace.
created_at
string
required
updated_at
string
required
title
string | null
required
text
string
required
pain_level
enum<string>
required
One of:
UNKNOWN
LOW
MEDIUM
HIGH
origin
string
required
custom_channel
string | null
required
Channel name when origin is custom, such as whatsapp.
status
enum<string>
required
One of:
open
snoozed
done
tab
enum<string>
required
One of:
open
new
needs-response
my
snoozed
done
snoozed_until
string | null
required
last_inbound_message_at
string | null
required
last_outbound_message_at
string | null
required
last_state_change_at
string | null
required
is_read
boolean
required
contact
object | null
required
company
object | null
required
assignee
object | null
required
reporter
object | null
required
tags
object[]
required
customer_needs
object[]
required
external_ids
string[]
required
Caller-owned cross-system identifiers (CRM ids, etc.). Replaced wholesale on create/update.
integration_ids
object
required
ai_draft_html
string | null
required
ai_draft_sources
any[] | null
required
ai_draft_generated_at
string | null
required
ai_draft_started_at
string | null
required
ai_draft_error_at
string | null
required

{
  "id": "string",
  "number": 0,
  "created_at": "string",
  "updated_at": "string",
  "title": "string",
  "text": "string",
  "pain_level": "UNKNOWN",
  "origin": "string",
  "custom_channel": "string",
  "status": "open",
  "tab": "open",
  "snoozed_until": "string",
  "last_inbound_message_at": "string",
  "last_outbound_message_at": "string",
  "last_state_change_at": "string",
  "is_read": true,
  "contact": {
    "id": "string",
    "email": "string",
    "name": "string",
    "image_url": "string",
    "company_id": "string",
    "is_subscribed": true,
    "external_ids": [
      "string"
    ],
    "integration_ids": {
      "intercom": "string",
      "front": "string",
      "zendesk": "string",
      "hubspot": "string",
      "plain": "string",
      "productboard": "string",
      "slack_channel": "string"
    },
    "created_at": "string",
    "updated_at": "string"
  },
  "company": {
    "id": "string",
    "name": "string",
    "logo_url": "string",
    "domains": [
      "string"
    ],
    "size": 0,
    "revenue": 0,
    "status_id": "string",
    "status_name": "string",
    "tier_id": "string",
    "tier_name": "string",
    "owner": {
      "id": "string",
      "name": "string",
      "avatar_url": "string"
    },
    "external_ids": [
      "string"
    ],
    "integration_ids": {
      "intercom": "string",
      "front": "string",
      "zendesk": "string",
      "hubspot": "string",
      "plain": "string",
      "productboard": "string",
      "slack_channel": "string"
    },
    "created_at": "string",
    "updated_at": "string"
  },
  "assignee": {
    "id": "string",
    "name": "string",
    "email": "string",
    "image_url": "string"
  },
  "reporter": {
    "id": "string",
    "name": "string",
    "email": "string",
    "image_url": "string"
  },
  "tags": [
    {
      "id": "string",
      "name": "string",
      "color": "string",
      "icon": "string",
      "tag_group_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "customer_needs": [
    {
      "id": "string",
      "thread_id": "string",
      "project_id": "string",
      "issue_id": "string",
      "priority": 0,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "external_ids": [
    "string"
  ],
  "integration_ids": {
    "intercom": "string",
    "front": "string",
    "zendesk": "string",
    "hubspot": "string",
    "plain": "string",
    "productboard": "string",
    "slack_channel": "string"
  },
  "ai_draft_html": "string",
  "ai_draft_sources": [
    null
  ],
  "ai_draft_generated_at": "string",
  "ai_draft_started_at": "string",
  "ai_draft_error_at": "string"
}

POST

/threads

curl -X POST "https://productlane.com/api/v2/threads" \
  -H "Authorization: Bearer $PRODUCTLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "pain_level": "UNKNOWN"
}'

{
  "id": "string",
  "number": 0,
  "created_at": "string",
  "updated_at": "string",
  "title": "string",
  "text": "string",
  "pain_level": "UNKNOWN",
  "origin": "string",
  "custom_channel": "string",
  "status": "open",
  "tab": "open",
  "snoozed_until": "string",
  "last_inbound_message_at": "string",
  "last_outbound_message_at": "string",
  "last_state_change_at": "string",
  "is_read": true,
  "contact": {
    "id": "string",
    "email": "string",
    "name": "string",
    "image_url": "string",
    "company_id": "string",
    "is_subscribed": true,
    "external_ids": [
      "string"
    ],
    "integration_ids": {
      "intercom": "string",
      "front": "string",
      "zendesk": "string",
      "hubspot": "string",
      "plain": "string",
      "productboard": "string",
      "slack_channel": "string"
    },
    "created_at": "string",
    "updated_at": "string"
  },
  "company": {
    "id": "string",
    "name": "string",
    "logo_url": "string",
    "domains": [
      "string"
    ],
    "size": 0,
    "revenue": 0,
    "status_id": "string",
    "status_name": "string",
    "tier_id": "string",
    "tier_name": "string",
    "owner": {
      "id": "string",
      "name": "string",
      "avatar_url": "string"
    },
    "external_ids": [
      "string"
    ],
    "integration_ids": {
      "intercom": "string",
      "front": "string",
      "zendesk": "string",
      "hubspot": "string",
      "plain": "string",
      "productboard": "string",
      "slack_channel": "string"
    },
    "created_at": "string",
    "updated_at": "string"
  },
  "assignee": {
    "id": "string",
    "name": "string",
    "email": "string",
    "image_url": "string"
  },
  "reporter": {
    "id": "string",
    "name": "string",
    "email": "string",
    "image_url": "string"
  },
  "tags": [
    {
      "id": "string",
      "name": "string",
      "color": "string",
      "icon": "string",
      "tag_group_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "customer_needs": [
    {
      "id": "string",
      "thread_id": "string",
      "project_id": "string",
      "issue_id": "string",
      "priority": 0,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "external_ids": [
    "string"
  ],
  "integration_ids": {
    "intercom": "string",
    "front": "string",
    "zendesk": "string",
    "hubspot": "string",
    "plain": "string",
    "productboard": "string",
    "slack_channel": "string"
  },
  "ai_draft_html": "string",
  "ai_draft_sources": [
    null
  ],
  "ai_draft_generated_at": "string",
  "ai_draft_started_at": "string",
  "ai_draft_error_at": "string"
}

APIThreads

Create thread

Create a thread and upsert its contact by email, or import a full conversation with messages. Requires the threads:write scope.

POST

/api/v2/threads

POST

/threads

curl -X POST "https://productlane.com/api/v2/threads" \
  -H "Authorization: Bearer $PRODUCTLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "pain_level": "UNKNOWN"
}'

Authorization

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

Body

application/json

external_ids
string[]
Caller-owned identifiers. Replaces the full set.
title
string
text
string
Thread body (HTML). Required unless messages is sent.
messages
object[]
Imports an existing conversation instead of text, stored as the channel's own messages. Nothing is sent, and no auto-reply, notification or Linear update runs.
pain_level
enum<string>
required
One of:
UNKNOWN
LOW
MEDIUM
HIGH
status
enum<string>
Initial status. Defaults to open.
One of:
open
snoozed
done
origin
enum<string>
Defaults to api. Use custom with custom_channel for a channel you connect yourself, such as WhatsApp or SMS.
One of:
in_app
portal
support_portal
email
slack
slack_connect
intercom
intercom_attachment
zendesk
zendesk_attachment
front_attachment
zapier
hubspot
plain
api
live_chat
ai_chat
calendar
widget
teams
linear
upvote
custom
custom_channel
string
Required when origin is custom: a lowercase name such as whatsapp or sms (1 to 32 characters, a-z, 0-9, _, -). The inbox shows it as the thread source.
contact_email
string<email>
Email of the contact. The contact is upserted by email within the workspace. Send this or contact_external_id.
contact_external_id
string
Your id for a contact without an email, such as whatsapp:+61400111222. The contact is upserted by it and never receives email. Send this or contact_email.
contact_name
string
Applied only when the contact is newly created.
assignee_id
string
Workspace user id (not a Linear user id).
company_id
string
project_id
string
issue_id
string
created_at
string<date-time>
updated_at
string<date-time>
notify
object
Side-channel notifications to fire alongside the write (Slack and/or email).

Response

application/json

Successful response

id
string
required
number
integer | null
required
Ticket number shown to customers as #123. Unique per workspace.
created_at
string
required
updated_at
string
required
title
string | null
required
text
string
required
pain_level
enum<string>
required
One of:
UNKNOWN
LOW
MEDIUM
HIGH
origin
string
required
custom_channel
string | null
required
Channel name when origin is custom, such as whatsapp.
status
enum<string>
required
One of:
open
snoozed
done
tab
enum<string>
required
One of:
open
new
needs-response
my
snoozed
done
snoozed_until
string | null
required
last_inbound_message_at
string | null
required
last_outbound_message_at
string | null
required
last_state_change_at
string | null
required
is_read
boolean
required
contact
object | null
required
company
object | null
required
assignee
object | null
required
reporter
object | null
required
tags
object[]
required
customer_needs
object[]
required
external_ids
string[]
required
Caller-owned cross-system identifiers (CRM ids, etc.). Replaced wholesale on create/update.
integration_ids
object
required
ai_draft_html
string | null
required
ai_draft_sources
any[] | null
required
ai_draft_generated_at
string | null
required
ai_draft_started_at
string | null
required
ai_draft_error_at
string | null
required

{
  "id": "string",
  "number": 0,
  "created_at": "string",
  "updated_at": "string",
  "title": "string",
  "text": "string",
  "pain_level": "UNKNOWN",
  "origin": "string",
  "custom_channel": "string",
  "status": "open",
  "tab": "open",
  "snoozed_until": "string",
  "last_inbound_message_at": "string",
  "last_outbound_message_at": "string",
  "last_state_change_at": "string",
  "is_read": true,
  "contact": {
    "id": "string",
    "email": "string",
    "name": "string",
    "image_url": "string",
    "company_id": "string",
    "is_subscribed": true,
    "external_ids": [
      "string"
    ],
    "integration_ids": {
      "intercom": "string",
      "front": "string",
      "zendesk": "string",
      "hubspot": "string",
      "plain": "string",
      "productboard": "string",
      "slack_channel": "string"
    },
    "created_at": "string",
    "updated_at": "string"
  },
  "company": {
    "id": "string",
    "name": "string",
    "logo_url": "string",
    "domains": [
      "string"
    ],
    "size": 0,
    "revenue": 0,
    "status_id": "string",
    "status_name": "string",
    "tier_id": "string",
    "tier_name": "string",
    "owner": {
      "id": "string",
      "name": "string",
      "avatar_url": "string"
    },
    "external_ids": [
      "string"
    ],
    "integration_ids": {
      "intercom": "string",
      "front": "string",
      "zendesk": "string",
      "hubspot": "string",
      "plain": "string",
      "productboard": "string",
      "slack_channel": "string"
    },
    "created_at": "string",
    "updated_at": "string"
  },
  "assignee": {
    "id": "string",
    "name": "string",
    "email": "string",
    "image_url": "string"
  },
  "reporter": {
    "id": "string",
    "name": "string",
    "email": "string",
    "image_url": "string"
  },
  "tags": [
    {
      "id": "string",
      "name": "string",
      "color": "string",
      "icon": "string",
      "tag_group_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "customer_needs": [
    {
      "id": "string",
      "thread_id": "string",
      "project_id": "string",
      "issue_id": "string",
      "priority": 0,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "external_ids": [
    "string"
  ],
  "integration_ids": {
    "intercom": "string",
    "front": "string",
    "zendesk": "string",
    "hubspot": "string",
    "plain": "string",
    "productboard": "string",
    "slack_channel": "string"
  },
  "ai_draft_html": "string",
  "ai_draft_sources": [
    null
  ],
  "ai_draft_generated_at": "string",
  "ai_draft_started_at": "string",
  "ai_draft_error_at": "string"
}

POST

/threads

curl -X POST "https://productlane.com/api/v2/threads" \
  -H "Authorization: Bearer $PRODUCTLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "pain_level": "UNKNOWN"
}'

{
  "id": "string",
  "number": 0,
  "created_at": "string",
  "updated_at": "string",
  "title": "string",
  "text": "string",
  "pain_level": "UNKNOWN",
  "origin": "string",
  "custom_channel": "string",
  "status": "open",
  "tab": "open",
  "snoozed_until": "string",
  "last_inbound_message_at": "string",
  "last_outbound_message_at": "string",
  "last_state_change_at": "string",
  "is_read": true,
  "contact": {
    "id": "string",
    "email": "string",
    "name": "string",
    "image_url": "string",
    "company_id": "string",
    "is_subscribed": true,
    "external_ids": [
      "string"
    ],
    "integration_ids": {
      "intercom": "string",
      "front": "string",
      "zendesk": "string",
      "hubspot": "string",
      "plain": "string",
      "productboard": "string",
      "slack_channel": "string"
    },
    "created_at": "string",
    "updated_at": "string"
  },
  "company": {
    "id": "string",
    "name": "string",
    "logo_url": "string",
    "domains": [
      "string"
    ],
    "size": 0,
    "revenue": 0,
    "status_id": "string",
    "status_name": "string",
    "tier_id": "string",
    "tier_name": "string",
    "owner": {
      "id": "string",
      "name": "string",
      "avatar_url": "string"
    },
    "external_ids": [
      "string"
    ],
    "integration_ids": {
      "intercom": "string",
      "front": "string",
      "zendesk": "string",
      "hubspot": "string",
      "plain": "string",
      "productboard": "string",
      "slack_channel": "string"
    },
    "created_at": "string",
    "updated_at": "string"
  },
  "assignee": {
    "id": "string",
    "name": "string",
    "email": "string",
    "image_url": "string"
  },
  "reporter": {
    "id": "string",
    "name": "string",
    "email": "string",
    "image_url": "string"
  },
  "tags": [
    {
      "id": "string",
      "name": "string",
      "color": "string",
      "icon": "string",
      "tag_group_id": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "customer_needs": [
    {
      "id": "string",
      "thread_id": "string",
      "project_id": "string",
      "issue_id": "string",
      "priority": 0,
      "created_at": "string",
      "updated_at": "string"
    }
  ],
  "external_ids": [
    "string"
  ],
  "integration_ids": {
    "intercom": "string",
    "front": "string",
    "zendesk": "string",
    "hubspot": "string",
    "plain": "string",
    "productboard": "string",
    "slack_channel": "string"
  },
  "ai_draft_html": "string",
  "ai_draft_sources": [
    null
  ],
  "ai_draft_generated_at": "string",
  "ai_draft_started_at": "string",
  "ai_draft_error_at": "string"
}