Update Lead

Update an existing lead

PATCH https://api.orwel.io/api/v1/leads/{id}

View as Markdown Open in Claude Open in ChatGPT

Path Parameters

idstringpathrequired

The unique identifier (UUID) of the lead to update

Request Body

propertiesobjectbody

Custom properties to update

locationobjectbody

Location data to update

summaryobjectbody

Summary data to update

company_idstringbody

Associated company ID (UUID)

Request

curl -X PATCH "https://api.orwel.io/api/v1/leads/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer orwel_sk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "properties": {
      "status": "qualified",
      "score": 90
    },
    "summary": {
      "notes": "High priority lead"
    },
    "company_id": "aa0e8400-e29b-41d4-a716-446655440005"
  }'

const leadId = '550e8400-e29b-41d4-a716-446655440000';

const response = await fetch(
  `https://api.orwel.io/api/v1/leads/${leadId}`,
  {
    method: 'PATCH',
    headers: {
      'Authorization': 'Bearer orwel_sk_YOUR_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      properties: {
        status: 'qualified',
        score: 90
      },
      summary: {
        notes: 'High priority lead'
      },
      company_id: 'aa0e8400-e29b-41d4-a716-446655440005'
    })
  }
);

const data = await response.json();

import requests
import json

lead_id = '550e8400-e29b-41d4-a716-446655440000'

headers = {
    'Authorization': 'Bearer orwel_sk_YOUR_KEY',
    'Content-Type': 'application/json'
}

payload = {
    'properties': {
        'status': 'qualified',
        'score': 90
    },
    'summary': {
        'notes': 'High priority lead'
    },
    'company_id': 'aa0e8400-e29b-41d4-a716-446655440005'
}

response = requests.patch(
    f'https://api.orwel.io/api/v1/leads/{lead_id}',
    headers=headers,
    data=json.dumps(payload)
)

data = response.json()

Response

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "visitor_id": "660e8400-e29b-41d4-a716-446655440001",
    "workspace_id": "770e8400-e29b-41d4-a716-446655440002",
    "code": "lead_001",
    "source": "website",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T15:45:00Z",
    "properties": {
      "status": "qualified",
      "score": 90
    },
    "location": {
      "city": "San Francisco",
      "country": "USA"
    },
    "identity_id": "880e8400-e29b-41d4-a716-446655440003",
    "session_id": "990e8400-e29b-41d4-a716-446655440004",
    "summary": {
      "notes": "High priority lead"
    },
    "company_id": "aa0e8400-e29b-41d4-a716-446655440005"
  }
}