Skip to main content
PATCH
Update a draft

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.

Path Parameters

id
string
required

The postcard ID.

Example:

"pc_MXP7a4Ni0c"

Body

application/json

Send only the fields you want to change. null clears a field.

address
object | null
recipient
object | null

Send first_name, company_name, or both.

content
string | null
Maximum string length: 300
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"

font_id
enum<string> | null

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

Available options:
font-1,
font-2
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

The updated draft.

data
object
required