Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your thanks.io API key

Path Parameters

​
orderId
integer
required

ID of the order to replay.

Body

application/json
​
recipients
object[]

Optional override. When supplied, the replay mails the original's creative to these recipients instead of the ones the original reached. Each recipient requires an address; unlike the send endpoints, an address-less recipient is not accepted.

Minimum array length: 1
​
schedule_for
string<date>

Optional send date for the replay. Any format Carbon can parse is accepted; the date-only portion is stored.

Example:

"2025-09-15"

​
metadata
object | null

Optional metadata for the replay. Same shape and limits as the send endpoints — returned unchanged by the order endpoints and included in every webhook event for the order as order.metadata. When omitted, the original order's metadata is carried over.

Example:

Response

Replay submitted. The response body mirrors the send endpoints' order-submitted shape, with an added replayed_from_order_id pointing back to the source order.

Response when an Order is successfully submitted to Send Mailer

​
id
integer

Unique identifier for the order

Example:

42664

​
user_id
integer

User ID for the order

Example:

2

​
sub_account
object | null

Sub-account Info For Order. Can be null

​
sub_account_id
integer | null

Sub account ID for the order

Example:

12345

​
total_estimated_recipients
integer

Total estimated recipients for the order

Example:

1

​
authorization_total
integer

Total authorization amount for the order in cents

Example:

58

​
leads_fee
integer

Total leads fee for the order in cents

Example:

99

​
mailing_list_ids_used
string

Mailing lists used for the order. Can be null if recipients or radius search is used.

Example:

"3046,3020"

​
recipients
object[]

List of recipients for the order

​
front_image
string

Front image URL for the order

Example:

"https://s3.amazonaws.com/cdn.thanks.io/user_image_library/1533645532.png"

​
image_template_id
integer | null

Image template ID for the order

Example:

6

​
custom_background_url
string | null

Custom background URL for the order. Only valid for postcard backs and the interior background of notecards and giftcards.

Example:

"https://s3.amazonaws.com/content.thanks.io/templates/branding-builder-images/c09d39aadfc-3701d4467b8/4524cce0-78cb-11f0-b937-17570cbedaf4.png"

​
message
string

Message content for the order

Example:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

​
message_template_id
integer | null

Message template ID for the order

Example:

12345

​
handwriting_color
string

Handwriting color to use

Example:

"rgba(31,0,113,0.80)"

​
font_size
enum<string>

Font size for the order

Available options:
auto,
small,
medium,
large
Example:

"auto"

​
style
integer

Handwriting style ID for the order

Example:

4

​
append_or_current_resident
boolean

Appended "Or Current Resident" for the order. This is helpful if you want to ensure delivery.

Example:

false

​
return_name
string | null

Return name for the order

Example:

"John Doe"

​
return_address
string | null

Return address line 1 for the order

Example:

"123 Main Street"

​
return_address2
string | null

Return address line 2 for the order

Example:

null

​
return_city
string | null

Return city for the order

Example:

"Anytown"

​
return_province
string | null

Return state/province for the order

Example:

"NY"

​
return_postal_code
string | null

Return postal code for the order

Example:

"12345"

​
type
enum<string>

Type of the order

Available options:
postcard,
postcard6x11,
letter,
notecard,
giftcard,
windowlessletter
Example:

"postcard"

​
size
enum<string>

Size of the order (valid for postcards only)

Available options:
4x6,
6x9,
6x11
Example:

"4x6"

​
method
enum<string>

Method for the order

Available options:
api,
cardbuilder,
drip,
email,
zapier
​
status
enum<string>

Status of the order

Available options:
reviewing,
processing,
fulfilled,
cancelled,
printed,
shipped,
paused,
delivered
​
display_status
string

Display status for the order

Example:

"Reviewing"

​
display_trigger
string

Display trigger for the order

Example:

"API"

​
display_type
string

Display type for the order

Example:

"Postcard-4x6"

​
addons
object | null

Add-ons for the order

​
qrcode_url
string | null

QR code URL for the order

Example:

"https://www.google.com?name=~FULL_NAME~&custom_field_1=~CUSTOM1~&custom_field2=~CUSTOM2~"

​
giftcard_brand
string | null

Gift card brand for the order (valid for Giftcard orders only)

Example:

null

​
giftcard_image
string | null

Gift card image URL for the order (valid for Giftcard orders only)

Example:

null

​
giftcard_amount
integer | null

Gift card amount for the order in cents (valid for Giftcard orders only)

Example:

null

​
giftcard_brand_longname
string

Gift card brand long name for the order (valid for Giftcard orders only)

Example:

"Amazon.com"

​
metadata
object | null

The metadata object submitted with the order, returned exactly as it was sent. Null when the order was created without metadata.

Example:
​
updated_at
string<date-time>

Last updated timestamp for the order

Example:

"2025-08-14 16:42:44"

​
created_at
string<date-time>

Creation timestamp for the order

Example:

"2025-08-14 16:42:44"

​
replayed_from_order_id
integer

ID of the source order this replay was copied from.

Example:

42708