Skip to main content
POST
Cancel a letter that has not yet been dispatched

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Response

Success

object
enum<string>
required
Available options:
letter
id
string
required
status
enum<string>
required
Available options:
draft,
queued,
processing,
printable,
submitted,
in_transit,
delivered,
undeliverable,
canceled,
failed
fileName
string | null
pageCount
integer | null
to
object
from
object | null
print
object
delivery
enum<string>
Available options:
economy,
priority,
registered,
bulk,
premium
paperTypes
enum<string>[]
Available options:
standard,
qr,
sepa_at,
sepa_de
autoSend
boolean
price
object | null
trackingNumber
string | null
metadata
object
lastEventType
string | null
lastEventAt
string<date-time> | null
submittedAt
string<date-time> | null
canceledAt
string<date-time> | null
error
string | null
createdAt
string<date-time> | null
updatedAt
string<date-time> | null
events
object[]
paymentSlip
enum<string> | null

The chosen payment-slip overlay, or null for a normal letter.

Available options:
qr,
sepaDe,
sepaAt,
null
dryRun
boolean

True for a validate/price-only letter that is never mailed or charged.

notifications
boolean

Owner milestone-email preference for this letter.

payment
object | null

The structured payment object the slip was generated from (owner records), or null.

undeliverableReason
string | null

Human-readable reason when the letter reached undeliverable; null otherwise.

batchId
string | null

The owning batch id for a batch-member letter; null for a single send. Pairs with the ?batchId= list filter.