Bulk Parameter Overview

Bulk endpoints queue changes for existing leads and return 202 Accepted when work is queued.

Supported identifiers

Bulk endpoints accept one identifier type per request:

You can submit a single identifier or an array of identifiers. Do not mix multiple identifier types in the same request.

Maximum items per bulk request: 250.
Requests with more than 250 submitted emails, phone numbers, or social ids return 413 with Too many items to update or delete.
If no matching leads are found, bulk update endpoints return 400 with No leads to update.

When matching leads are found, KickoffLabs queues the requested update asynchronously and responds with:

{
  "message": "Your leads have been equeued for changes",
  "updated": 3
}

For delete requests, the response is:

{
  "message": "Your leads have been equeued for deletion",
  "deleted": 3
}

The bulk action engine supports these actions:

Invalid actions return 409.