Create Thread

Create thread

curl --request POST \
  --url https://inboxapp.com/api/v1/threads \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountLinkId": "<string>",
  "externalPlatformId": "<string>",
  "externalId": "<string>"
}
'

{
  "id": "<string>",
  "done": true,
  "assigneeId": "df6jbw4h36...",
  "lastMessageTimestamp": "2025-08-22T12:00:00.000Z",
  "computedSortTimestamp": "2025-08-22T12:00:00.000Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "status": "active",
  "accountLinkId": "<string>",
  "isSyncing": true,
  "isRequest": true,
  "lastMessage": {
    "id": "<string>",
    "content": "<string>",
    "authorId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "userId": "df6jbw4h36...",
    "campaignId": "df6jbw4h36..."
  },
  "prospect": {
    "platform": "twitter",
    "platformId": "<string>",
    "externalId": "l44e15irdq4db30i77cgphhx",
    "documentId": 858224163,
    "displayName": "<string>",
    "username": "<string>",
    "handle": "<string>",
    "image": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg",
    "imageNormalized": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg",
    "bio": "Social Selling CRM Close deals faster, stay organized, and never miss an opportunity. Starting with X",
    "location": "San Francisco, CA",
    "profileUrl": "<string>",
    "websiteUrl": "https://inboxapp.com",
    "websiteDomain": "inboxapp.com",
    "verified": "none",
    "profileType": "personal",
    "isProtected": true,
    "followerCount": 123,
    "followingCount": 123,
    "postCount": 123,
    "engagementCount": 2613,
    "listedCount": 18,
    "platformCreatedAt": "2022-09-03T17:58:06.000Z",
    "firstSeenAt": "2024-07-09T14:08:49.000Z",
    "lastUpdatedAt": "2023-11-07T05:31:56Z",
    "lastEnrichedAt": "2025-11-10T18:03:16.000Z",
    "lastActiveAt": "2025-11-10T12:00:00.000Z",
    "source": "cached",
    "isFresh": true,
    "isStale": true,
    "confidence": 0.5,
    "platformData": {
      "isVerifiedBlue": true,
      "isVerifiedGold": true,
      "isVerifiedGray": true,
      "professionalCategory": "986",
      "urlEntities": [
        {
          "url": "<string>",
          "expandedUrl": "<string>",
          "displayUrl": "<string>",
          "indices": "<array>"
        }
      ],
      "bannerUrl": "https://pbs.twimg.com/profile_banners/1566123362161725440/1753273968",
      "tweetsCount": 123,
      "favoritesCount": 123,
      "rawData": {}
    },
    "context": {
      "tags": [
        "<string>"
      ],
      "statusId": "df6jbw4h36...",
      "valuation": 599,
      "notes": "This prospect is a potential customer."
    }
  }
}

POST

threads

Create thread

curl --request POST \
  --url https://inboxapp.com/api/v1/threads \
  --header 'Content-Type: application/json' \
  --data '
{
  "accountLinkId": "<string>",
  "externalPlatformId": "<string>",
  "externalId": "<string>"
}
'

{
  "id": "<string>",
  "done": true,
  "assigneeId": "df6jbw4h36...",
  "lastMessageTimestamp": "2025-08-22T12:00:00.000Z",
  "computedSortTimestamp": "2025-08-22T12:00:00.000Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "status": "active",
  "accountLinkId": "<string>",
  "isSyncing": true,
  "isRequest": true,
  "lastMessage": {
    "id": "<string>",
    "content": "<string>",
    "authorId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "userId": "df6jbw4h36...",
    "campaignId": "df6jbw4h36..."
  },
  "prospect": {
    "platform": "twitter",
    "platformId": "<string>",
    "externalId": "l44e15irdq4db30i77cgphhx",
    "documentId": 858224163,
    "displayName": "<string>",
    "username": "<string>",
    "handle": "<string>",
    "image": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg",
    "imageNormalized": "https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg",
    "bio": "Social Selling CRM Close deals faster, stay organized, and never miss an opportunity. Starting with X",
    "location": "San Francisco, CA",
    "profileUrl": "<string>",
    "websiteUrl": "https://inboxapp.com",
    "websiteDomain": "inboxapp.com",
    "verified": "none",
    "profileType": "personal",
    "isProtected": true,
    "followerCount": 123,
    "followingCount": 123,
    "postCount": 123,
    "engagementCount": 2613,
    "listedCount": 18,
    "platformCreatedAt": "2022-09-03T17:58:06.000Z",
    "firstSeenAt": "2024-07-09T14:08:49.000Z",
    "lastUpdatedAt": "2023-11-07T05:31:56Z",
    "lastEnrichedAt": "2025-11-10T18:03:16.000Z",
    "lastActiveAt": "2025-11-10T12:00:00.000Z",
    "source": "cached",
    "isFresh": true,
    "isStale": true,
    "confidence": 0.5,
    "platformData": {
      "isVerifiedBlue": true,
      "isVerifiedGold": true,
      "isVerifiedGray": true,
      "professionalCategory": "986",
      "urlEntities": [
        {
          "url": "<string>",
          "expandedUrl": "<string>",
          "displayUrl": "<string>",
          "indices": "<array>"
        }
      ],
      "bannerUrl": "https://pbs.twimg.com/profile_banners/1566123362161725440/1753273968",
      "tweetsCount": 123,
      "favoritesCount": 123,
      "rawData": {}
    },
    "context": {
      "tags": [
        "<string>"
      ],
      "statusId": "df6jbw4h36...",
      "valuation": 599,
      "notes": "This prospect is a potential customer."
    }
  }
}

Body

application/json

accountLinkId

string

required

The account link ID to associate with this thread. This determines which connected account the thread belongs to.

externalPlatformId

string

The platform ID of the prospect. Must be provided if externalId is not provided.

externalId

string

The Inbox external ID of the prospect. Must be provided if externalPlatformId is not provided.

Response

200 - application/json

string

required

The ID of the thread.

done

boolean

required

Whether the thread has been archived or not.

assigneeId

string | null

required

The ID of the member assigned to the thread.

Example:

"df6jbw4h36..."

lastMessageTimestamp

string<date-time> | null

required

The timestamp of the last message in the thread.

Example:

"2025-08-22T12:00:00.000Z"

computedSortTimestamp

string<date-time> | null

required

The timestamp of the last message in the thread or the creation date if no messages have been sent.

Example:

"2025-08-22T12:00:00.000Z"

createdAt

string<date-time>

required

The timestamp of when the thread was created in Inbox.

status

enum<string>

required

Idle threads are hidden from the main inbox, i.e. when previewing a profile using 'Quick peek'

Available options:

active,

idle

accountLinkId

string

required

The ID of the account link associated with this thread.

isSyncing

boolean

required

Whether the thread is currently syncing data from Twitter to load all messages.

isRequest

boolean

required

Whether this conversation is a message request.

lastMessage

object

required

Show child attributes

lastMessage.id

string

required

The ID of the last message in the thread. This is the message that will be displayed in the thread preview.

lastMessage.content

string

required

The content of the last message in the thread.

lastMessage.authorId

string

required

Points to either the accountLinkId or the externalId of the thread

lastMessage.createdAt

string<date-time>

required

The timestamp of when the last message was created in Inbox.

lastMessage.userId

string | null

required

The ID of the Inbox user who sent the last message in the thread. Note that this is not a member ID.

Example:

"df6jbw4h36..."

lastMessage.campaignId

string | null

required

The ID of the campaign that sent the last message in the thread. This is only set if the last message was sent by a campaign.

Example:

"df6jbw4h36..."

prospect

object

required

Show child attributes

prospect.platform

enum<string>

required

The social platform where this prospect's profile exists.

Available options:

twitter,

sandbox

prospect.platformId

string

required

The platform's native user ID. For Twitter, this is the numeric user ID. This is the primary identifier for cross-platform operations.

prospect.externalId

string | null

required

Unique identifier for this prospect in the Inbox system. Null if the prospect hasn't been imported yet.

Example:

"l44e15irdq4db30i77cgphhx"

prospect.documentId

number | null

required

Search index identifier for fast lookups. Null if the prospect isn't indexed yet.

Example:

858224163

prospect.displayName

string

required

The user's display name as shown on their profile. For businesses, typically the company name.

prospect.username

string

required

The unique handle/username on the platform, without the @ symbol. Always lowercase for Twitter.

prospect.handle

string

required

The username with @ symbol prefix, ready for display in UI. Computed from username.

prospect.image

string | null

required

Profile picture URL as provided by platform. May contain size suffixes or be lower quality. Prefer imageNormalized for display.

Example:

"https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg"

prospect.imageNormalized

string | null

required

Profile picture URL normalized to highest quality available. Size suffixes removed. Prefer this over image for display.

Example:

"https://pbs.twimg.com/profile_images/1954360649393295360/rwp-vVt6.jpg"

prospect.bio

string | null

required

The user's profile bio/description text.

Example:

"Social Selling CRM Close deals faster, stay organized, and never miss an opportunity. Starting with X"

prospect.location

string | null

required

Freeform location string as entered by user. Not normalized or geocoded.

Example:

"San Francisco, CA"

prospect.profileUrl

string

required

Direct link to view this profile on the platform.

prospect.websiteUrl

string | null

required

External website URL the user provided in their profile, if any.

Example:

"https://inboxapp.com"

prospect.websiteDomain

string | null

required

Domain extracted from websiteUrl for quick filtering and grouping.

Example:

"inboxapp.com"

prospect.verified

enum<string>

required

Verification badge status: none (no badge), verified (blue checkmark), business (gold badge), or government (gray badge).

Available options:

none,

verified,

business,

government

prospect.profileType

enum<string>

required

Account type classification: personal (individual), business (organization), or government (official agency).

Available options:

personal,

business,

government

prospect.isProtected

boolean

required

Whether the account is private/protected. For Twitter: protected tweets enabled. Private accounts require approval to follow.

prospect.followerCount

number

required

Number of users following this account.

prospect.followingCount

number

required

Number of users this account follows.

prospect.postCount

number

required

Total content posted by this account. For Twitter: tweet count. For Instagram: post count.

prospect.engagementCount

number | null

required

Platform-specific engagement metric. For Twitter: likes/favorites given by user. May be null if platform doesn't provide this.

Example:

2613

prospect.listedCount

number | null

required

How many Twitter lists this profile appears on. Useful metric for influence. Null for non-Twitter platforms.

Example:

18

prospect.platformCreatedAt

string<date-time> | null

required

When the account was created on the platform. Null if platform doesn't provide this data.

Example:

"2022-09-03T17:58:06.000Z"

prospect.firstSeenAt

string<date-time> | null

required

When this prospect was first added to Inbox. Useful for tracking relationship timeline.

Example:

"2024-07-09T14:08:49.000Z"

prospect.lastUpdatedAt

string<date-time>

required

Most recent update timestamp for any data about this prospect.

prospect.lastEnrichedAt

string<date-time> | null

required

When fresh data was last fetched from the platform API. Use this to determine if data needs refresh.

Example:

"2025-11-10T18:03:16.000Z"

prospect.lastActiveAt

string<date-time> | null

required

Last time the profile was active on the platform (posted, liked, or engaged). Platform-dependent availability.

Example:

"2025-11-10T12:00:00.000Z"

prospect.source

enum<string>

required

Data source: cached (stored), indexed (searchable), live (real-time from platform), or merged (combined sources).

Available options:

cached,

indexed,

live,

merged

prospect.isFresh

boolean

required

Indicates if data was updated within the last 7 days. Fresh data is current and reliable.

prospect.isStale

boolean

required

Indicates if data hasn't been updated in over 30 days. Stale data may need refreshing for accuracy.

prospect.confidence

number

required

Confidence score for data accuracy (0-1). Higher values indicate more recent and reliable data. 1.0 = real-time, 0.8+ = recent, below 0.5 = potentially outdated.

Required range: 0 <= x <= 1

prospect.platformData

object

required

Show child attributes

prospect.platformData.isVerifiedBlue

boolean

required

Standard Twitter blue checkmark verification badge.

prospect.platformData.isVerifiedGold

boolean

required

Gold verification badge indicating a business/brand account on Twitter.

prospect.platformData.isVerifiedGray

boolean

required

Gray verification badge indicating a government/official account on Twitter.

prospect.platformData.professionalCategory

string | null

required

Professional category ID if the account has set one. Maps to categories like Technology, Media, Education, etc.

Example:

"986"

prospect.platformData.urlEntities

object[]

required

Parsed URL entities from the bio text with expanded and display URLs.

Show child attributes

prospect.platformData.urlEntities.url

string

required

Shortened t.co URL as it appears in the tweet text.

prospect.platformData.urlEntities.expandedUrl

string

required

Full expanded URL that the t.co link redirects to.

prospect.platformData.urlEntities.displayUrl

string

required

Human-readable display text for the URL (typically domain + path).

prospect.platformData.urlEntities.indices

array

required

Start and end character indices where this URL appears in the bio text.

prospect.platformData.bannerUrl

string | null

required

Profile banner/header image URL (typically 1500x500px). Null if no banner is set.

Example:

"https://pbs.twimg.com/profile_banners/1566123362161725440/1753273968"

prospect.platformData.tweetsCount

number

required

Total number of tweets posted by this account (all-time count).

prospect.platformData.favoritesCount

number

required

Total number of likes/favorites this user has given to other tweets.

prospect.platformData.rawData

object

required

Full Twitter API user object for backward compatibility and advanced use cases. Null if not available from the data source.

Show child attributes

prospect.platformData.rawData.{key}

any

prospect.context

object

required

Show child attributes

prospect.context.tags

string[]

required

The tag IDs attached to this prospect.

prospect.context.statusId

string | null

required

The status ID of the prospect.

Example:

"df6jbw4h36..."

prospect.context.valuation

number | null

required

The valuation of the prospect.

Example:

599

prospect.context.notes

string | null

required

Notes attached to the prospect.

Example:

"This prospect is a potential customer."

List Threads Lookup Thread

⌘I

Getting Started

Teams

Threads

Messages

Account Links

Members

Prospects

Tags

Statuses

Colors

Body

Response