API referenceBulk send
Send one draft to many recipients
Scope envelopes:send. Clones the draft (one file, fields assigned to a
single signer) once per recipient and sends each copy in the background.
Plan-gated by BULK_SEND and BULK_SEND_MAX_RECIPIENTS
(feature_not_available / plan_limit_exceeded); a second bulk send
for the same draft while one is running is a state_conflict
(details.job_id). Duplicate emails are dropped. Poll
GET /bulk-send-jobs/{id}; bulk_send.completed fires when done.
apiKeyheader
AuthorizationBearer <fv_live_… or fv_test_…>id*stringFormat
uuidIdempotency-Key?string8–128 chars of letters, digits, _, -, : or .; scoped to your organization, key and path for 24 hours
Length
8 <= length <= 128application/json- body
recipients*array<>Items
1 <= items <= 5000subject?stringLength
length <= 500message?stringLength
length <= 5000The queued job
application/json- response
success*booleanrequest_id*stringFormat
uuiddata?curl -X POST 'https://api.flowverify.co/v1/envelopes/497f6eca-6276-4993-bfeb-53cbbbba6f08/bulk-send' \ -H 'Content-Type: application/json' \ -d '{ "recipients": [ { "name": "string", "email": "[email protected]" } ]}'Example Response
{ "success": true, "request_id": "266ea41d-adf5-480b-af50-15b940c2b846", "data": { "object": "bulk_send_job", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "bulk_group_id": "d79d1808-cde8-4e17-88af-e68d9273ee36", "source_envelope_id": "5c7517ec-0325-43be-8ac9-0bc200f1fb63", "status": "queued", "kind": "initial", "total_recipients": 0, "succeeded": 0, "failed": 0, "progress_pct": 0, "cancel_requested": true, "started_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z" }}