Convert a Lead

POST/Leads/{leadId}/actions/convert

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Convert a Lead action (under Leads).
Fill in the fields below, then reference the result from later steps as {{convertALead.response.data}}.

Request

Path parameters

leadIdstring (int64)required

Unique identifier of the Lead record to convert. Must be a valid Lead ID that exists in the CRM and has not been previously converted. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the lead ID.

Request body

Enter the body as JSON in the step's Body field.

dataarray<object>required

Array of lead conversion configurations

overwriteboolean

Determines whether to overwrite the Account Name in a Contact when converting a Lead. For example, If a Contact is already linked to an Account but the Lead’s Company name is different, enabling this option will update the Contact’s Account to match the Lead’s Company. **Possible values:** false (default) : Keeps the existing Account Name in the Contact unchanged. true : Updates the Contact’s associated Account Name if it differs from the Company name in the Lead.

defaultany

notify_lead_ownerboolean

If true, sends email notification to the Lead owner about the conversion. Default is false.

Default false

notify_new_entity_ownerboolean

If true, notifies the owner(s) of newly created Contact, Account, or Deal records. Default is false.

Default false

add_to_existing_recordboolean

When true, associates the Lead with an existing Account or Contact instead of creating duplicates.

assign_toobject1 fields

Assigns a record owner for the new Contact and Account after lead conversion. It ensures that the converted lead is assigned to a specific user in Zoho CRM. Use the [Users API](users.yaml#$.paths./users/bulk.get) to retrieve valid User IDs.

Dealsobject13 fields

Deal record configuration for lead conversion

carry_over_tagsobject3 fields

Configuration for carrying over tags from the Lead to converted records

json

{
  "data": [
    {
      "overwrite": false,
      "default": null,
      "notify_lead_owner": false,
      "notify_new_entity_owner": false,
      "add_to_existing_record": false,
      "assign_to": {
        "id": "string"
      },
      "Deals": {
        "Deal_Name": "string",
        "Pipeline": "string",
        "Stage": "string",
        "Closing_Date": "2025-01-01",
        "Campaign_Source": "string",
        "Amount": 0,
        "Contact_Role": "string",
        "$move_attachments": false,
        "Type": "string",
        "Probability": 0,
        "Lead_Source": "string",
        "Next_Step": "string"
      },
      "carry_over_tags": {
        "Contacts": {},
        "Accounts": {},
        "Deals": {}
      }
    }
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{convertALead.response.data.<field>}}.

dataarray<object>

Array of conversion results

codestringrequired

Status code indicating successful conversion

One ofSUCCESS

messagestringrequired

Message that summarizes the outcome of the lead conversion request.

statusstringrequired

Overall status of the conversion operation

One ofsuccess

detailsobjectrequired3 fields

Details of created records including their IDs and names.

json

{
  "data": [
    {
      "code": "SUCCESS",
      "message": "string",
      "status": "success",
      "details": {
        "Contacts": {
          "name": "string",
          "id": "string"
        },
        "Deals": null,
        "Accounts": null
      }
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?