Skip to main content
POST
Send one template to many recipients

Authorizations

Authorization
string
header
required

Dairo API key, e.g. dairo_test_... or dairo_live_...

Body

application/json
templateId
string
required

The stored letter template rendered once per recipient.

recipients
object[]
required
Required array length: 1 - 1000 elements
from
object | null
print
object
delivery
enum<string>
Available options:
economy,
priority,
registered,
bulk,
premium
paymentSlip
enum<string> | null

Optional payment-slip overlay applied to every letter.

Available options:
qr,
sepaDe,
sepaAt
autoSend
boolean
default:true
notifications
boolean
default:true
metadata
object

Response

Success

object
enum<string>
required
Available options:
letter_batch
id
string
required
total
integer
required

Number of letters created (one per recipient).

status
string
required

The batch status; queued on create.