Sign in

v1

latestOpenAPI 3.1.12026-07-14355311.4 MB
Lead

Update Lead

Update an existing 'Lead' record.

patch/Lead/{id}

Request body

idstring

An ID.

salutationName'Mr.' | 'Ms.' | 'Mrs.' | 'Dr.' nullable
firstNamestring nullable

A one-line string.

lastNamestring nullable

A one-line string.

titlestring nullable

A one-line string.

status'New' | 'Assigned' | 'In Process' | 'Converted' | 'Recycled' | 'Dead'
source'Call' | 'Email' | 'Existing Customer' | 'Partner' | 'Public Relations' | 'Web Site' | 'Campaign' | 'Other' nullable
industry'Advertising' | 'Aerospace' | 'Agriculture' | 'Apparel & Accessories' | 'Architecture' | 'Automotive' | 'Banking' | 'Biotechnology' | 'Building Materials & Equipment' | 'Chemical' | 'Construction' | 'Consulting' | 'Computer' | 'Culture' | 'Creative' | 'Defense' | 'Education' | 'Electronics' | 'Electric Power' | 'Energy' | 'Entertainment & Leisure' | 'Finance' | 'Food & Beverage' | 'Grocery' | 'Healthcare' | 'Hospitality' | 'Insurance' | 'Legal' | 'Manufacturing' | 'Mass Media' | 'Marketing' | 'Mining' | 'Music' | 'Publishing' | 'Petroleum' | 'Real Estate' | 'Retail' | 'Service' | 'Sports' | 'Software' | 'Support' | 'Shipping' | 'Travel' | 'Technology' | 'Telecommunications' | 'Television' | 'Transportation' | 'Testing, Inspection & Certification' | 'Venture Capital' | 'Wholesale' | 'Water' nullable
opportunityAmountnumber nullable

A currency amount.

opportunityAmountCurrency'USD' | 'EUR' nullable

A code.

opportunityAmountConvertednumber nullable

A currency amount converted to the default currency.

websitestring nullable

A one-line string.

addressStreetstring nullable

A multi-line text.

addressCitystring nullable

A one-line string.

addressStatestring nullable

A one-line string.

addressCountrystring nullable

A one-line string.

addressPostalCodestring nullable

A one-line string.

emailAddressstring nullable

A primary email address.

phoneNumberstring nullable

A primary phone number.

doNotCallboolean
descriptionstring nullable

A multi-line text.

convertedAtstring nullable

A timestamp in UTC.

createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

accountNamestring nullable

A one-line string.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

acceptanceStatusMeetingsstring
acceptanceStatusCallsstring
teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

campaignIdstring nullable

An ID of the record of the Campaign type.

campaignNamestring nullable

A foreign record name.

createdAccountIdstring nullable

An ID of the record of the Account type.

createdAccountNamestring nullable

A foreign record name.

createdContactIdstring nullable

An ID of the record of the Contact type.

createdContactNamestring nullable

A foreign record name.

createdOpportunityIdstring nullable

An ID of the record of the Opportunity type.

createdOpportunityNamestring nullable

A foreign record name.

targetListsIdsstring[] nullable

IDs of records of the TargetList type.

targetListsNamesobject nullable

An {ID => record name} map.

targetListIdstring nullable
targetListNamestring nullable

A foreign record name.

originalEmailIdstring nullable
originalEmailNamestring nullable

A foreign record name.

middleNamestring nullable

A one-line string.

emailAddressIsOptedOutboolean
emailAddressIsInvalidboolean
phoneNumberIsOptedOutboolean
phoneNumberIsInvalidboolean
streamUpdatedAtstring nullable

A timestamp in UTC.

Example request

{
  "convertedAt": "2026-11-29 12:34:56",
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "streamUpdatedAt": "2026-11-29 12:34:56"
}

Response

Success.

idstring

An ID.

salutationName'Mr.' | 'Ms.' | 'Mrs.' | 'Dr.' nullable
firstNamestring nullable

A one-line string.

lastNamestring nullable

A one-line string.

titlestring nullable

A one-line string.

status'New' | 'Assigned' | 'In Process' | 'Converted' | 'Recycled' | 'Dead'
source'Call' | 'Email' | 'Existing Customer' | 'Partner' | 'Public Relations' | 'Web Site' | 'Campaign' | 'Other' nullable
industry'Advertising' | 'Aerospace' | 'Agriculture' | 'Apparel & Accessories' | 'Architecture' | 'Automotive' | 'Banking' | 'Biotechnology' | 'Building Materials & Equipment' | 'Chemical' | 'Construction' | 'Consulting' | 'Computer' | 'Culture' | 'Creative' | 'Defense' | 'Education' | 'Electronics' | 'Electric Power' | 'Energy' | 'Entertainment & Leisure' | 'Finance' | 'Food & Beverage' | 'Grocery' | 'Healthcare' | 'Hospitality' | 'Insurance' | 'Legal' | 'Manufacturing' | 'Mass Media' | 'Marketing' | 'Mining' | 'Music' | 'Publishing' | 'Petroleum' | 'Real Estate' | 'Retail' | 'Service' | 'Sports' | 'Software' | 'Support' | 'Shipping' | 'Travel' | 'Technology' | 'Telecommunications' | 'Television' | 'Transportation' | 'Testing, Inspection & Certification' | 'Venture Capital' | 'Wholesale' | 'Water' nullable
opportunityAmountnumber nullable

A currency amount.

opportunityAmountCurrency'USD' | 'EUR' nullable

A code.

opportunityAmountConvertednumber nullable

A currency amount converted to the default currency.

websitestring nullable

A one-line string.

addressStreetstring nullable

A multi-line text.

addressCitystring nullable

A one-line string.

addressStatestring nullable

A one-line string.

addressCountrystring nullable

A one-line string.

addressPostalCodestring nullable

A one-line string.

emailAddressstring nullable

A primary email address.

phoneNumberstring nullable

A primary phone number.

doNotCallboolean
descriptionstring nullable

A multi-line text.

convertedAtstring nullable

A timestamp in UTC.

createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

accountNamestring nullable

A one-line string.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

acceptanceStatusMeetingsstring
acceptanceStatusCallsstring
teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

campaignIdstring nullable

An ID of the record of the Campaign type.

campaignNamestring nullable

A foreign record name.

createdAccountIdstring nullable

An ID of the record of the Account type.

createdAccountNamestring nullable

A foreign record name.

createdContactIdstring nullable

An ID of the record of the Contact type.

createdContactNamestring nullable

A foreign record name.

createdOpportunityIdstring nullable

An ID of the record of the Opportunity type.

createdOpportunityNamestring nullable

A foreign record name.

targetListsIdsstring[] nullable

IDs of records of the TargetList type.

targetListsNamesobject nullable

An {ID => record name} map.

targetListIdstring nullable
targetListNamestring nullable

A foreign record name.

originalEmailIdstring nullable
originalEmailNamestring nullable

A foreign record name.

middleNamestring nullable

A one-line string.

emailAddressIsOptedOutboolean
emailAddressIsInvalidboolean
phoneNumberIsOptedOutboolean
phoneNumberIsInvalidboolean
streamUpdatedAtstring nullable

A timestamp in UTC.

Example response

{
  "convertedAt": "2026-11-29 12:34:56",
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "streamUpdatedAt": "2026-11-29 12:34:56"
}