Leads

Create a lead

Create a lead via the API — the server-to-server intake used by a website-form relay (e.g. a WordPress/Gravity Forms feed). Unlike the public browser form endpoint, this is authenticated by your API key, so submissions are trusted (not bot-checked). Fires the lead.created webhook so a Slack alert and any lead-qualification tool can pick it up. Lands on the workspace's first board unless boardId is given. Scope: leads:write.

post/v1/leads

Request

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

Request body

boardIdstring uuid

Destination board. Defaults to the workspace's first board.

firstNamestring
lastNamestring
workEmailstring email
phonestring
companyNamestring
companyWebsitestring
messagestring
howHeardstring
consentboolean

Accepts a real boolean or a string ("true"/"1"/"yes") — a server-to-server form relay sends strings.

consentTextstring
source'form' | 'email' | 'import'
sourceUrlstring

Page the form was submitted from (website-form relay).

pageTitlestring

Title of the page the form was on.

referrerstring

document.referrer at submission, if known.

utmSourcestring
utmMediumstring
utmCampaignstring
utmTermstring
utmContentstring
gclidstring
fbclidstring
msclkidstring

Response

Created

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.