Fan out a reusable draft envelope
POST
/bulk-sends
const url = 'https://app.qsig.in/backend/api/v1/bulk-sends';const options = { method: 'POST', headers: { 'Idempotency-Key': 'example', 'X-Api-Key': '<X-Api-Key>', 'Content-Type': 'application/json' }, body: '{"source_envelope_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","rows":[{"external_id":"example","title":"example","message":"example","redirect_url":"https://example.com","metadata":{},"recipients":[{"name":"example","email":"hello@example.com","role":"signer","signature_method":"electronic","sequence":1}]}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://app.qsig.in/backend/api/v1/bulk-sends \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: example' \ --header 'X-Api-Key: <X-Api-Key>' \ --data '{ "source_envelope_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rows": [ { "external_id": "example", "title": "example", "message": "example", "redirect_url": "https://example.com", "metadata": {}, "recipients": [ { "name": "example", "email": "hello@example.com", "role": "signer", "signature_method": "electronic", "sequence": 1 } ] } ] }'Queues one independent envelope per row. The source remains unchanged.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ” Idempotency-Key
required
string
Request Body required
Section titled “Request Body required ” Media type application/json
object
source_envelope_id
required
string format: uuid
rows
required
Array<object>
object
external_id
string
title
string
message
string
redirect_url
string format: uri
metadata
object
recipients
required
Array<object>
object
name
required
string
email
required
string format: email
role
string
signature_method
string
sequence
integer
Responses
Section titled “ Responses ”Bulk send queued
Invalid rows
Idempotency or source-state conflict