Create Lead
Capture an inbound lead into your org’s CRM (e.g. a website quote funnel). The
free-form details (name/phone/subject) are stored in the lead’s payload; email,
source_url, notes and a source_form_name snapshot are columns; status starts
at ‘new’. audience (‘student’/‘tutor’/‘parent’) defaults to ‘student’ when omitted.
Honours Idempotency-Key. Requires leads:write (the coarse write umbrella grants
it).
Authorizations
Org API key as Token token=ei_live_...
Headers
Body
POST /v1/leads — capture an inbound lead into the key's org (e.g. a website quote
funnel). name/phone/subject are stored in the lead's free-form payload; email,
source_url, notes and a source_form_name snapshot are columns. organization_id,
form_id, status and timestamps are server-set, never accepted; status starts 'new'.
Lead's full name.
1Lead's email address (required).
Subject of interest, e.g. 'Methods'.
Who this lead is: 'student' (enrolment, the default), 'tutor' (recruitment), or 'parent' (enrolment, on behalf of a student). Omit to use the org_leads column default ('student').
student, tutor, parent Where the lead came from, e.g. 'website quote funnel'.
Response
Successful Response
An inbound lead captured by an org lead form. The free-form payload is
NOT exposed; only a safe subset (name/email/phone/subject) is flattened.
student, tutor, parent