Skip to main content
PATCH
/
campaigns
/
v2
/
{campaignId}
/
leads
/
{identifier}
Update lead
curl --request PATCH \
  --url https://inboxapp.com/api/v1/campaigns/v2/{campaignId}/leads/{identifier} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {},
  "by": "platformId",
  "platform": "twitter"
}
'
{
  "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",
    "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",
    "isFresh": true,
    "isStale": true,
    "confidence": 0.5,
    "platformData": {
      "isVerifiedBlue": true,
      "isVerifiedGold": true,
      "isVerifiedGray": true,
      "professionalCategory": "986",
      "urlEntities": [
        {
          "url": "<string>",
          "expandedUrl": "<string>",
          "displayUrl": "<string>",
          "indices": [
            123,
            123
          ]
        }
      ],
      "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.",
    "threads": [
      {
        "id": "<string>",
        "accountLinkId": "<string>",
        "lastMessageTimestamp": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ]
  },
  "data": {
    "custom_q5cktl47a6pqa74eu06fz89v": "Acme Corp",
    "custom_m8r2xj93hd5bk0atcw7oe4fp": "CEO"
  },
  "accountLinkId": "<string>",
  "threadId": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
campaignId
string
required

The ID of the campaign.

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

The identifier of the lead. Interpreted based on the by parameter.

Minimum string length: 1
Example:

"44196397"

Body

application/json
​
data
object
required

Custom column values to update, keyed by column ID. Set a value to null to clear it.

Example:
{
  "custom_q5cktl47a6pqa74eu06fz89v": "Acme Corp",
  "custom_m8r2xj93hd5bk0atcw7oe4fp": null
}
​
by
enum<string>
default:platformId

How to interpret the identifier in the URL path. Defaults to 'platformId'.

Available options:
platformId,
username,
externalId
Example:

"platformId"

​
platform
enum<string>

The platform for the identifier. Required when by is 'platformId' or 'username'. Defaults to 'twitter'. Ignored when by is 'externalId'.

Available options:
twitter

Response

200 - application/json

OK

A lead with full prospect profile, CRM context, and custom column data.

​
prospect
object
required

Full prospect profile data.

​
context
object
required

CRM context for this prospect (tags, status, valuation, notes).

​
data
object
required

Custom column values for this lead. Keys are column IDs (not column names). Use the columns API to look up column IDs.

Example:
{
  "custom_q5cktl47a6pqa74eu06fz89v": "Acme Corp",
  "custom_m8r2xj93hd5bk0atcw7oe4fp": "CEO"
}
​
stage
enum<string> | null
required

Campaign stage for this lead. Only present when querying leads on a campaign list. Null for regular lists.

Available options:
pending,
ready,
ongoing,
replied,
unresponsive,
failed,
canceled
​
accountLinkId
string | null
required

The account link ID assigned to contact this lead. Only present for campaign lists. Null for regular lists or if not yet assigned.

​
threadId
string | null
required

The thread ID of the conversation with this lead. Only present for campaign lists. Null for regular lists or if no conversation exists yet.