Leads

Ingest a lead from an external system

Creates a lead in a Further community on behalf of an external system (Zapier, partner referral feeds, custom website forms, etc.) and dispatches it through the standard processing pipeline. Identify the target community with community_id, community_url, or community_crm_code (the first one provided wins). Optional flags can schedule a tour, enroll the lead in nurture campaigns, submit it to the configured CRM, and send the standard new-lead notification email to the community.

post/api/chat/leads/ingestion/zapier-webhook

Request

  • Base URL: https://api.talkfurther.com
  • URL: https://api.talkfurther.com/api/chat/leads/ingestion/zapier-webhook
  • Auth: one of:
    • API key in header Authorization
    • API key in header Authorization

Request body

community_idinteger

Identifier of the Further community the lead belongs to.

community_urlstring

URL of the community as configured in Further. Used as a fallback when community_id is omitted.

community_crm_codestring

CRM location code for the community, useful when the calling system only has the code from its own CRM setup (e.g. Yardi).

first_namestring

Lead first name (truncated to 30 characters).

last_namestring

Lead last name (truncated to 150 characters).

emailstring email

Lead email address.

phonestring

Lead phone number (free-form, up to 20 characters).

lead_sourcestring

Source label for the lead. Defaults to zapier. If provided, must match a registered source (e.g. apfm, caring).

traffic_sourcestring

Free-text traffic source label (e.g. Google Ads, Facebook Ad).

external_lead_idstring

Caller's identifier for the lead, recorded for cross-system correlation.

tour_bookedboolean

If true, Further schedules a tour for the lead after creation.

tour_datestring date-time

Scheduled start time for the tour. Parsed in the community's timezone if no offset is supplied. Only meaningful when tour_booked is true.

nurture_leadboolean

If true, the lead is enrolled in nurture campaigns after creation.

submit_crmboolean

If true, Further submits the lead to the community's configured CRM after creation.

send_via_emailboolean

If true, Further sends the standard new-lead notification email to the community.

Response

further_lead_idinteger required

Identifier of the newly created lead in Further.

external_lead_idstring required

Echoes the external_lead_id from the request, if one was provided.

community_codestring required

CRM location code of the community the lead was created in.

Changes

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