Leads

Update triage status and/or enrichment

Two independent updates can ride in the same call:

  • triageStatus — flip lifecycle state (new → contacted, junk, bad_fit, or stale). Setting contacted stamps contactedAt; setting junk stamps junkedAt + the calling user. promoted is NOT settable here — call POST /v1/leads/{id}/promote instead, which creates the Deal and links it.

  • enrichment — merge a free-form enrichment payload from your qualifier. Top-level keys you send overwrite existing keys; keys you omit are preserved. Each PATCH appends a snapshot to enrichment.history (which you cannot overwrite — it's server-managed audit). Use this to push AI scoring, summaries, or attachment URLs onto a Lead.

Empty body is allowed — returns the Lead unchanged.

patch/v1/leads/{id}

Request

  • Base URL: https://app.getdealboard.com
  • URL: https://app.getdealboard.com/v1/leads/{id}
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional client-chosen string. If the same key is sent twice within 24h with the same body, the original response is replayed.

Request body

triageStatus'new' | 'contacted' | 'junk' | 'bad_fit' | 'stale'

promoted is intentionally excluded — promoting a Lead requires creating a Deal, which is the dedicated POST /v1/leads/{id}/promote endpoint.

Response

OK

idstring uuid required
boardIdstring uuid required
triageStatus'new' | 'contacted' | 'promoted' | 'junk' | 'bad_fit' | 'stale' required

Lifecycle marker for the Lead inbox. new → contacted is recorded when a reply goes out; promoted/junk/bad_fit are terminal triage outcomes; stale is set by a daily cron if a Lead sits in new too long.

source'form' | 'email' required

How the Lead arrived: form (website/hosted form) or email (inbound email).

dealIdstring uuid nullable required

Set once the Lead has been promoted to a Deal via POST /v1/leads/{id}/promote. Null otherwise.

createdAtstring date-time required
contactedAtstring date-time nullable required
promotedAtstring date-time nullable required
junkedAtstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.