Capture people in bulk
Submit between 1 and 100 supported person captures in one request.
- For
- Integration developers
- Owner
- Integration engineering
- Outcome
- Submit a bounded batch and account for every accepted or rejected person.
- Last verified
- 2026-08-30
- Next review
- 2026-11-28
- Status
- supported
Use the bulk operation when the source can group bounded work. Each person can include its own idempotency key so partial retries remain safe.
Build the request
- The request must contain at least one and no more than 100 people.
- Validate every object against the published schema before submission.
curl -X POST 'https://crm.sakhaa.ai/api/v1/capture/persons/bulk' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_API_KEY' \
-H 'X-API-Secret: YOUR_API_SECRET' \
-H 'Idempotency-Key: example-batch-001' \
-d '{"persons":[{"name":"API Batch Test","email":"api-batch-test@example.invalid","idempotency_key":"example-person-101"}]}'Handle the result
- Record the batch idempotency key and each person idempotency key.
- Account for every person by accepted, rejected, duplicate, or unresolved outcome.
- Correct rejected person data without repeating accepted work.
- Move unresolved people to a visible failure queue after the retry limit.
Control load
- Keep batches bounded even when the source has more than 100 people.
- Respect the client rate limit returned by the API information and response headers.
- Do not use parallel retries that can amplify an outage or create duplicate pressure.