UpdateLead(UpdateLeadSetup) Method

Setup object for API invocation.

Used to update a Lead. This overload takes a setup object.

Syntax

'Declaration

Public Overloads Function UpdateLead( _
   ByVal _setupParam_ UpdateLeadSetup _
) As ToolkitResult

public ToolkitResult UpdateLead( 
   UpdateLeadSetup _setupParam_
)

Parameters

setupParam

Setup object for API invocation.

Return Value

The following values are populated in the ToolkitResult object returned by the API method:

• Objid - The Objid of the Lead.

Remarks

The objid of the Lead is required.

For updates, if data is specified it it will be set. If left blank (“”), the current value is retained. If the string “CLEAR” is used for a value, the value is cleared.  A few items (such as lead source and contact role) cannot be cleared.

The user who updated the lead, and the date/time of the update can be specified. The API can also generate a time bomb (for business rules).

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server family

Reference

SalesToolkit Class
SalesToolkit Members
Overload List
UpdateLeadSetup Class