fastify-xwhatconverts

leads.update

Update an existing WhatConverts lead's quotable status, values, URL, or custom fields.

leads.update

Update an existing lead. Only the fields provided are changed; unspecified fields are left intact.

Signature

fastify.xwhatconverts.leads.update(
  leadId: string,
  params: {
    quotable?: boolean;
    quoteValue?: number;
    salesValue?: number;
    leadUrl?: string;
    additionalFields?: Record<string, unknown>;
  }
): Promise<object>

Params

Name	Type	Required	Description
`leadId`	`string`	Yes	ID of the lead to update.
`params.quotable`	`boolean`	No	Set whether the lead is quotable.
`params.quoteValue`	`number`	No	Update the quote value.
`params.salesValue`	`number`	No	Update the sales value.
`params.leadUrl`	`string`	No	Update the originating page URL.
`params.additionalFields`	`object`	No	Update custom key-value fields.

Returns

The updated WhatConverts lead object.

Throws

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

Examples

Basic — mark a lead as quotable with a value

const updated = await fastify.xwhatconverts.leads.update("123456", {
  quotable: true,
  quoteValue: 500,
});

Realistic — update lead value after a sale closes

fastify.post("/sales/:leadId/close", async (request, reply) => {
  const { saleAmount } = request.body;

  const lead = await fastify.xwhatconverts.leads.update(request.params.leadId, {
    quotable: true,
    quoteValue: saleAmount,
    salesValue: saleAmount,
    additionalFields: {
      closed_at: new Date().toISOString(),
      sales_rep: request.user.name,
    },
  });

  return { leadId: lead.lead_id, salesValue: lead.sales_value };
});

AI Context

package: "@xenterprises/fastify-xwhatconverts"
method: fastify.xwhatconverts.leads.update(leadId, params)
use-when: Update a WhatConverts lead — mark as spam/not-spam, set value, update contact details or custom fields
params: leadId (string, required), plus optional fields to update (value, spam, contactName, etc.)
returns: updated WhatConverts lead object

Edit this pageorReport an issue

leads.list

List WhatConverts leads with optional filtering by type, status, date range, and account.

profiles.create

Create a new WhatConverts profile under an account.