Leads

Create a lead

Creates a new lead from a partner integration and enrolls it into the standard Further processing pipeline (CRM sync, qualification, etc.). The provider_profile field must identify a Further community owned by the caller's organization.

post/api/v1/leads/

Request

  • Base URL: https://api.talkfurther.com
  • URL: https://api.talkfurther.com/api/v1/leads/
  • Auth: one of:
    • API key in header Authorization
    • API key in header Authorization

Request body

provider_profileinteger required

Identifier of the Further community the lead is interested in.

first_namestring
last_namestring nullable
emailstring email

Lead email address. Either email or phone is required (community-dependent).

phonestring

Lead phone number in E.164 format. Either email or phone is required (community-dependent).

timingstring

Free-text move-in timing as captured from the source form (e.g. 3-6 months).

care_typestring

Care level requested by the lead (e.g. Independent Living, Assisted Living).

utm_sourcestring

Marketing attribution: source (utm_source query parameter).

utm_mediumstring

Marketing attribution: medium (utm_medium query parameter).

utm_campaignstring

Marketing attribution: campaign name (utm_campaign query parameter).

Response

provider_profileinteger required

Identifier of the Further community the lead is interested in.

first_namestring
last_namestring nullable
emailstring email

Lead email address. Either email or phone is required (community-dependent).

phonestring

Lead phone number in E.164 format. Either email or phone is required (community-dependent).

timingstring

Free-text move-in timing as captured from the source form (e.g. 3-6 months).

care_typestring

Care level requested by the lead (e.g. Independent Living, Assisted Living).

utm_sourcestring

Marketing attribution: source (utm_source query parameter).

utm_mediumstring

Marketing attribution: medium (utm_medium query parameter).

utm_campaignstring

Marketing attribution: campaign name (utm_campaign query parameter).

Changes

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