Lifecycle API

Preview or send a courtesy copy

Preview the exact PDF, recipients, and message before sending.

POSThttps://app.mindbill.org/partner/v2/bills/{billId}/courtesy-forward

Preview the exact PDF, recipients, and message before sending. mode=send requires Idempotency-Key and the preview packetHash. A changed packet returns 409. Sandbox sends are simulated. This is not a payer submission.

AuthenticationServer API key or browser session + Origin

Permissions by credentialServer: bills:write · Browser: bills:act

IdempotencyNot required

Use this URL with a server API key or a browser session and its exact allowed Origin. Both credentials use the same request and response contract. See the component API inventory for exact paths and SDK methods.

Path parameters

FieldTypeDescription

billIdRequired

string

Resource identifier.

Request body

FieldTypeDescription

modeRequired

string

mode

toRequired

string[]

cc

string[]

subjectRequired

string

subject

bodyTextRequired

string

bodyText

includeCms1500

boolean

includeCms1500

documentIds

string[]

documentIds

packetHash

string

Required for send. Hash from the reviewed preview for this exact packet, recipients, and message.

Examples

curl 'https://app.mindbill.org/partner/v2/bills/{billId}/courtesy-forward' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_API_KEY" \
  --header 'Content-Type: application/json' \
  --data @request.json

curl 'https://app.mindbill.org/partner/v2/bills/{billId}/courtesy-forward' \
  --request POST \
  --header "Authorization: Bearer $MINDBILL_BROWSER_TOKEN" \
  --header 'Origin: https://your-app.example' \
  --header 'Content-Type: application/json' \
  --data @request.json

Response

200

Response fields are documented below.

FieldTypeDescription

filenameRequired

string

filename

documentCountRequired

integer

documentCount

packetHashRequired

string

packetHash

pdfBase64Required

string

pdfBase64

environmentRequired

string

environment

okRequired

boolean

sentRequired

boolean

sent

messageId

string

messageId

simulated

boolean

simulated

dryRun

boolean

dryRun