Sign in

v1

latestOpenAPI 3.1.02026-08-04253331435.1 KB
CRM Leads

Convert Lead

Convert a lead to an Account, Contact, and optionally an Opportunity.

This is a Salesforce-specific operation that qualifies a lead and creates:

  • Account (company)
  • Contact (person)
  • Opportunity (deal) - optional

Request body options:

  • accountId: Associate with existing Account instead of creating new one
  • contactId: Associate with existing Contact instead of creating new one
  • createOpportunity: Whether to create an Opportunity (default: false)
  • opportunityName: Name for the Opportunity (if creating one)
  • ownerId: Assign to specific owner
  • sendNotificationEmail: Send email notification (default: false)

Note: This endpoint is only supported for Salesforce integrations.

post/api/v3/crm/{integration_id}/leads/{lead_id}/convert

Path parameters

integration_idstring uuid required

The CRM integration ID

The CRM integration ID

lead_idstring required

The lead ID to convert

The lead ID to convert

Request body

accountIdstring nullable

Existing Account ID to associate with. If not provided, creates new Account.

contactIdstring nullable

Existing Contact ID to associate with. If not provided, creates new Contact.

createOpportunityboolean

Whether to create an Opportunity during conversion.

opportunityNamestring nullable

Name for the new Opportunity (if createOpportunity is True).

ownerIdstring nullable

Owner for the created Account, Contact, and Opportunity.

sendNotificationEmailboolean

Whether to send notification email to the owner.

Response

Successful Response

successboolean required
leadIdstring required

The converted Lead ID

accountIdstring required

The created or associated Account ID

contactIdstring required

The created or associated Contact ID

opportunityIdstring nullable

The created Opportunity ID (if requested)