fastify-xwhatconverts

leads.delete

Delete a WhatConverts lead by ID.

leads.delete

Delete a lead by its WhatConverts ID. Also accessible as leads.remove.

Signature

fastify.xwhatconverts.leads.delete(leadId: string): Promise<object>

// alias
fastify.xwhatconverts.leads.remove(leadId: string): Promise<object>

Params

Name	Type	Required	Description
`leadId`	`string`	Yes	ID of the lead to delete.

Returns

A WhatConverts deletion result object.

Throws

[xWhatConverts] leads.delete: leadId is required — called without leadId.
[xWhatConverts] Network error: <message> — network-level failure.
[xWhatConverts] API error: <status> — non-2xx response from WhatConverts.

Examples

Basic — delete a lead

await fastify.xwhatconverts.leads.delete("123456");

fastify.delete("/leads/:id", async (request, reply) => {
  const { id } = request.params;

  try {
    await fastify.xwhatconverts.leads.delete(id);
    return reply.status(204).send();
  } catch (err) {
    if (err.statusCode === 404) {
      return reply.status(404).send({ error: "Lead not found" });
    }
    throw err;
  }
});

AI Context

package: "@xenterprises/fastify-xwhatconverts"
method: fastify.xwhatconverts.leads.delete(leadId)
use-when: Permanently delete a WhatConverts lead by ID
params: leadId (string, required)
returns: deletion confirmation object

Edit this pageorReport an issue

leads.create

Create a new WhatConverts lead under a profile with type, contact info, and attribution data.

leads.get

Fetch a single WhatConverts lead by ID, with optional customer journey data.