PUT
/
api
/
v2
/
leads
/
{leadId}
curl --request PUT \
  --url https://api.buena.ai/api/v2/leads/{leadId} \
  --header 'Content-Type: <content-type>' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "company": "<string>",
  "title": "<string>",
  "status": "<string>",
  "tags": [
    {}
  ],
  "customFields": {}
}'
{
  "success": true,
  "data": {
    "id": "lead_123abc",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@techcorp.com",
    "company": "Tech Corp",
    "title": "Software Engineer",
    "status": "contacted",
    "tags": ["linkedin-outreach", "responded"],
    "customFields": {
      "lastContactDate": "2024-01-20",
      "responseTime": "2 hours",
      "interest": "high"
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-20T15:30:00Z"
  }
}

Update Lead

Modify an existing lead’s contact information, status, tags, or custom fields. Useful for keeping lead data current and tracking engagement progress.

Requires the leads:write permission.

Request

leadId
string
required

The unique identifier of the lead to update

x-api-key
string
required

Your API key with leads:write permission

Content-Type
string
required

Must be application/json

Body Parameters

firstName
string

Lead’s first name

lastName
string

Lead’s last name

email
string

Primary email address

company
string

Company name

title
string

Job title

status
string

Lead status (e.g., “new”, “contacted”, “qualified”, “converted”, “unqualified”)

tags
array

Array of tag strings for categorization

customFields
object

Object containing custom field key-value pairs

Examples

Update Lead Status

curl -X PUT "https://api.buena.ai/api/v2/leads/lead_123abc" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "contacted",
    "tags": ["linkedin-outreach", "responded"],
    "customFields": {
      "lastContactDate": "2024-01-20",
      "responseTime": "2 hours",
      "interest": "high"
    }
  }'

Response

success
boolean

Always true for successful requests

data
object

The updated lead object

{
  "success": true,
  "data": {
    "id": "lead_123abc",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@techcorp.com",
    "company": "Tech Corp",
    "title": "Software Engineer",
    "status": "contacted",
    "tags": ["linkedin-outreach", "responded"],
    "customFields": {
      "lastContactDate": "2024-01-20",
      "responseTime": "2 hours",
      "interest": "high"
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-20T15:30:00Z"
  }
}

Next Steps