Aura Logo
AuraAPI Docs
OpenapiV1LeadsId

Update lead

Update fields on an existing lead.

Only provided fields will be updated; all others remain unchanged.

Updatable fields:

  • full_name, email, phone, company, status, timezone, notes
PATCH
/v1/leads/{id}

Path Parameters

idstring

Lead ID (UUID)

Formatuuid
full_name?string

Full name of the lead

email?string

Email address

Formatemail
phone?string

Phone number in E.164 format

company?string

Company name

status?string

Lead status

timezone?string

Lead's timezone (IANA format)

notes?unknown

Notes about the lead (JSONB)

Response Body

application/json

application/json

application/json

curl -X PATCH "https://api.aura-app.ai/v1/leads/550e8400-e29b-41d4-a716-446655440000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "full_name": "John Doe",
    "email": "john@example.com",
    "phone": "+14155552671",
    "company": "Acme Corp",
    "status": "new",
    "notes": null,
    "metadata": null,
    "source": {
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "summer_promo",
      "utm_term": "string",
      "utm_content": "string",
      "referrer": "https://acme.com/book-a-call"
    },
    "timezone": "America/New_York",
    "disqualification_data": null,
    "payment_status": "string",
    "payment_count": 0,
    "total_paid_cents": 0,
    "last_payment_at": "string",
    "created_at": "2026-01-17T08:00:00Z",
    "updated_at": "2026-01-17T09:30:00Z"
  }
}
{
  "success": false,
  "error": "Lead not found",
  "code": "NOT_FOUND",
  "requestId": "req_abc123"
}
{
  "success": false,
  "error": "Lead not found",
  "code": "NOT_FOUND",
  "requestId": "req_abc123"
}