Update Lead

Update an existing lead

PATCH /api/v1/leads/{id}

cURL

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

200 OK

{
  "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"
  }
}

Path Parameters

id · string · required

The unique identifier (UUID) of the lead to update

Request Body

properties · object

Custom properties to update

location · object

Location data to update

summary · object

Summary data to update

company_id · string

Associated company ID (UUID)

cURL

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

200 OK

{
  "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"
  }
}