Create thread

Create a thread and upsert its contact by email. Requires the threads:write scope.

POST /threads

Create thread

cURL

curl --request POST \
  --url https://productlane.com/api/v2/threads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "external_ids": [
    "<string>"
  ],
  "title": "<string>",
  "custom_channel": "<string>",
  "contact_email": "[e-mail]",
  "contact_external_id": "<string>",
  "contact_name": "<string>",
  "assignee_id": "<string>",
  "company_id": "<string>",
  "project_id": "<string>",
  "issue_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "notify": {
    "slack": true,
    "email": true
  }
}
'

200

{
  "id": "<string>",
  "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": 123,
    "revenue": 123,
    "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": 123,
      "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": "<array>",
  "ai_draft_generated_at": "<string>",
  "ai_draft_started_at": "<string>",
  "ai_draft_error_at": "<string>"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

text · string · required

Thread body (HTML).

Minimum string length: 1

pain_level · enum<string> · required

Available options: UNKNOWN, LOW, MEDIUM, HIGH

external_ids · string[]

Caller-owned identifiers. Replaces the full set.

title · string

Maximum string length: 512

status · enum<string>

Initial status. Defaults to open.

Available options: 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.

Available options: 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:[phone]. The contact is upserted by it and never receives email. Send this or contact_email.

Required string length: 1 - 128

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).

Show child attributes

Response

200

application/json

Successful response

id · string · required

created_at · string · required

updated_at · string · required

title · string | null · required

text · string · required

pain_level · enum<string> · required

Available options: 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

Available options: open, snoozed, done

tab · enum<string> · required

Available options: 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

Show child attributes

company · object | null · required

Show child attributes

assignee · object | null · required

Show child attributes

reporter · object | null · required

Show child attributes

tags · object[] · required

Show child attributes

customer_needs · object[] · required

Show child attributes

external_ids · string[] · required

Caller-owned cross-system identifiers (CRM ids, etc.). Replaced wholesale on create/update.

integration_ids · object · required

Show child attributes

ai_draft_html · string | null · required

ai_draft_sources · array | null · required

ai_draft_generated_at · string | null · required

ai_draft_started_at · string | null · required

ai_draft_error_at · string | null · required