Lead

Lead

A lead is a prospective customer captured in Whop — a contact tracked through the sales/marketing funnel before they convert into a paying member. The SDK supports creating, listing, reading, and updating leads.

SDK access

$client->leads // Matchable\Whop\Resource\LeadResource

Endpoints

create(array $data): array

HTTP	POST leads
Does	Creates a new lead.
Parameters	$data — lead attributes (e.g. email, name, source).
Returns	array

list(array $query = []): array

HTTP	GET leads
Does	Lists leads.
Parameters	$query — optional filters / pagination.
Returns	array

get(string $id): array

HTTP	GET leads/{id}
Does	Retrieves a single lead by ID.
Parameters	$id — the lead ID.
Returns	array

update(string $id, array $data): array

HTTP	PATCH leads/{id}
Does	Updates a lead's attributes.
Parameters	$id — the lead ID; $data — fields to change.
Returns	array

Example

$lead = $client->leads->create([
    'email' => 'prospect@example.com',
    'name' => 'Jane Prospect',
]);

$client->leads->update($lead['id'], ['status' => 'contacted']);

Reference

Official Whop documentation: https://docs.whop.com