Skip to main content
POST
Create or update leads in bulk

Authorizations

X-Api-Key
string
header
required

Your secret ReachBoost API key.

Path Parameters

workspace_uuid
string<uuid>
required

Your unique workspace identifier.

Example:

"YOUR_WORKSPACE_UUID"

Body

application/json
leads
object[]
required

The leads to add. Each item has the same shape and rules as CreateLeadRequest.

Required array length: 1 - 100 elements

Response

Batch accepted and queued. The leads are created or updated shortly after.

accepted
integer
required

Number of leads that passed the request checks and were queued. Leads the workspace cannot store are skipped later and are still counted here.

Required range: 1 <= x <= 100
Example:

2