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 CRM ID, the Shape system ID that belongs to your API key. Send the standard headers on every request: Authorization: YOUR_API_AUTHORIZATION_KEY and Content-Type: application/json. See Authentication.Body parameters
| Field | Requirement | Description |
|---|---|---|
| Top-level JSON array | Required | An array of record objects. |
firstname, lastname, email |
Required | Required on each record. |
| Your system’s fields | Optional | Any other field, by its exact field name. See Finding field names. |
HTTP
200 means Shape accepted and processed the bulk request. It doesn’t confirm that every individual row imported.Example request
[
{
"firstname": "Jordan",
"lastname": "Sample",
"email": "jordan.sample@example.com",
"phone": "5550100123",
"leadsource": "Website"
},
{
"firstname": "Alex",
"lastname": "Example",
"email": "alex.example@example.com",
"phone": "5550100124",
"leadsource": "Website"
}
]
Example response
{
"message": "Bulk import processed.",
"lead_ids": [281944, 281945]
}
Linking partners and agents
To link a referral partner, buying agent or selling agent, see Link Referral Partners and Agents.