Paper Letters

Create a paper letter delivery

Charge BuddyPoints and enqueue an idempotent Pingen delivery

post/v1/paper-letters/deliveries

Request

  • Base URL: https://dev.api.bb.tricirc.de (the document declares no server; this is the origin it was published from)
  • URL: https://dev.api.bb.tricirc.de/v1/paper-letters/deliveries
  • Auth: session-cookie (a scheme the document does not define)

Request body

$schemastring uri

A URL to the JSON Schema for this object.

caseIdstring
clientRequestIdstring required
recipientstring required
topicstring required
uploadIdstring required

Example request

{
  "$schema": "https://example.com/schemas/CreatePaperLetterDeliveryInputBody.json"
}

Response

Accepted

$schemastring uri

A URL to the JSON Schema for this object.

addressPositionstring required
buddyPointsCostinteger required
caseIdstring nullable required
clientRequestIdstring required
createdAtstring date-time required
deliveryIdstring required
deliveryProductstring required
pageCountinteger required
pingenIdstring
printModestring required
printSpectrumstring required
recipientstring nullable required
sentAtstring date-time
statusstring required
submissionStartedAtstring date-time
topicstring nullable required
updatedAtstring date-time required
uploadIdstring required

Example response

{
  "$schema": "https://example.com/schemas/DeliveryBody.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.