Leadify V3Install

Summary

Add new leads to a specified Leadify group using provided lead data and optional request settings.

Inputs

• leadGroupId (required) — The ID of the lead group to add leads to; must be a valid Leadify group identifier.
• leadData (required) — JSON object defining the leads to add; must include an isSelectFields array to mark dropdown fields and a leads array containing lead objects.
• additionalFields — Optional collection of extra request parameters (e.g., timeout) that can be attached to the API call.
• requestOptions — Optional collection of global request settings such as batching, SSL verification, proxy, and timeout that affect the HTTP request.

Output shape

A single response object containing the created lead data and status information

The response includes the created lead IDs and any server‑side validation messages; errors are returned as an error envelope rather than a successful payload.

Examples

Example 1: Add a single lead using the default payload

leadGroupId = cl1234567890; leadData = {"isSelectFields":["status","source"],"leads":[{"email":"john.doe@example.com","firstName":"John","lastName":"Doe","company":"Acme Inc","status":"new","source":"linkedin"}]}

Example 2: Add multiple leads with batching enabled

leadGroupId = cl9876543210; leadData = {"isSelectFields":["status","source"],"leads":[{"email":"a@example.com","firstName":"A","status":"new"},{"email":"b@example.com","firstName":"B","status":"new"}]}; requestOptions.batch.batchSize = 50; requestOptions.batch.batchInterval = 1000

Example 3: Add leads then hide columns in the Leadify UI

After Add Leads, configure Update Hidden Columns with addHiddenColumns = ["email","phone"] to hide those fields.