Skip to main content
PATCH
Update prospect context

Authorizations

Authorization
string
header
required

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

Path Parameters

prospectId
string
required
Pattern: ^[0-9a-z]+$

Body

application/json
notes
string | null
valuation
number | null
statusId
string | null
Pattern: ^[0-9a-z]+$
addTags
string[]
Pattern: ^[0-9a-z]+$
removeTags
string[]
Pattern: ^[0-9a-z]+$
assigneeId
string | null
Pattern: ^[0-9a-z]+$
done
boolean

Response

200 - application/json

OK

platform
enum<string>
required

The social platform where this prospect's profile exists.

Available options:
twitter
Example:

"twitter"

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.

Example:

"1566123362161725440"

externalId
string | null
required

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

Example:

"l44e15irdq4db30i77cgphhx"

documentId
number | null
required

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

Example:

858224163

displayName
string
required

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

Example:

"Inbox"

username
string
required

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

Example:

"InboxApp_"

handle
string
required

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

Example:

"@InboxApp_"

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"

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"

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"

location
string | null
required

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

Example:

"San Francisco, CA"

profileUrl
string
required

Direct link to view this profile on the platform.

Example:

"https://x.com/InboxApp_"

websiteUrl
string | null
required

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

Example:

"https://inboxapp.com"

websiteDomain
string | null
required

Domain extracted from websiteUrl for quick filtering and grouping.

Example:

"inboxapp.com"

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
Example:

"business"

profileType
enum<string>
required

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

Available options:
personal,
business,
government
Example:

"business"

isProtected
boolean
required

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

Example:

false

followerCount
number
required

Number of users following this account.

Example:

3068

followingCount
number
required

Number of users this account follows.

Example:

288

postCount
number
required

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

Example:

836

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

listedCount
number | null
required

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

Example:

18

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"

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"

lastUpdatedAt
string<date-time>
required

Most recent update timestamp for any data about this prospect.

Example:

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

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"

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"

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
Example:

"cached"

isFresh
boolean
required

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

Example:

true

isStale
boolean
required

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

Example:

false

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
Example:

0.85

accountStatus
enum<string>
required

Account status on the platform. 'active' = accessible, 'suspended' = platform confirmed suspension, 'notFound' = deleted or deactivated.

Available options:
active,
suspended,
notFound
Example:

"active"

platformData
object
required
context
object
required