Skip to main content
POST
Preview a postcard

Authorizations

Authorization
string
header
required

A Paperjoy API key. Keys starting with pj_test_ use test mode; keys starting with pj_live_ use live mode.

Body

application/json
content
string
required

The handwritten message. Line breaks (\n) and blank lines are kept. The text must fit on the card; see the card_fit validation error.

Maximum string length: 300
font_id
enum<string>
required

font-1 is clear, rounded handwriting. font-2 is a faster, joined-up cursive.

Available options:
font-1,
font-2
signature
string | null

A sign-off written on one line at the bottom of the card. Do not send together with signature_id.

Maximum string length: 50
signature_id
string | null

An active custom signature ID from GET /api/signatures. Requires a plan with custom signatures. Do not send together with signature.

Example:

"sig_ZeXOkSQjTp"

mistake
boolean
default:false

Cross out one word and write it again, like a real person would. The same message always gets the same correction.

Response

A PNG image of the card.

The response is of type string.