Skip to main content
POST
Create a handwritten-card draft and quote

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

generated_mailing_id
integer | null

Generated mailing id. Validation: nullable, integer.

Example:

1

donor_id
integer | null

Donor id. Validation: nullable, integer.

Example:

1

fundraising_work_item_id
integer | null

Fundraising work item id. Validation: nullable, integer.

Example:

1

rule_id
integer | null

Rule id. Validation: nullable, integer.

Example:

1

program_id
integer | null

Program id. Validation: nullable, integer.

Example:

1

campaign_key
string | null

Campaign key. Validation: nullable, string, max:128.

Maximum string length: 128
Example:

"Campaign Key"

account_mode
enum<string> | null

Account mode. Validation: nullable, string; allowed values: hys_managed, partner_owned.

Available options:
hys_managed,
partner_owned,
null
Example:

"hys_managed"

card_vendor_id
string | null

Card vendor id. Validation: nullable, string, max:64.

Maximum string length: 64
Example:

"Card Vendor Id"

card_name
string | null

Card name. Validation: nullable, string, max:191.

Maximum string length: 191
Example:

"Card Name"

font_label
string | null

Font label. Validation: nullable, string, max:191.

Maximum string length: 191
Example:

"Font Label"

insert_vendor_id
string | null

Insert vendor id. Validation: nullable, string, max:128.

Maximum string length: 128
Example:

"Insert Vendor Id"

message_template
string

Message template. Validation: required_without:message, string.

Example:

"Message Template"

message
string

Message. Validation: required_without:message_template, string.

Example:

"Message"

merge_data

Merge data. Validation: nullable, array.

recipient_address

Postal address snapshot. Country representations must agree with the active catalog; state/province is required for supported countries that require it.

sender_address

Postal address snapshot. Country representations must agree with the active catalog; state/province is required for supported countries that require it.

requested_send_date
string<date-time> | null

Requested send date. Validation: nullable, date.

Example:

"2026-10-20T12:00:00Z"

Response

Operation result.

data
object

Customer order projection. Practice test_submitted status is presented as verification_complete; provider state, request payloads, credentials and margin are omitted.