API Reference

Bulk Import Leads

Import many records in one request. Send a top-level JSON array of record objects.

POSThttps://secure-api.setshape.com/api/leads/bulk/import/{crmid}

Replace {crmid} with your Shape system ID — found on the API Integrations page. Every request also needs your auth header — see Using Shape APIs.

Body parameters

Field Requirement Description
Top-level JSON array Required An array of record objects.
At least one object with mapped Shape fields Required Each object maps to a record.
firstname, lastname, email Required Required on each record.
Account field mappings Optional Account-specific additional fields.
HTTP 200 means Shape accepted and processed the bulk instruction — it does not certify that every individual row imported successfully.

Example request

[
  {
    "firstname": "John",
    "lastname": "Doe",
    "email": "john@example.test",
    "phone": "5555555555",
    "leadsource": "Website"
  }
]

Example response

{
  "message": "Bulk import processed.",
  "lead_ids": [123, 124]
}