Delete a letter
Permanently delete a draft letter.
Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Path Parameters
The id identifier.
Response
Returns the deleted letter object.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
letter Which side of page 1 the recipient address window is printed on.
left, right Content blocks that will be printed. Snapshotted from the template when one is used.
- Option 1
- Option 2
- Option 3
The customer this letter is addressed to, when recipient_type is customer.
Why sending failed, if status is failed.
Postage product used when the letter is sent.
standard, premium A name for this letter. Defaults to the template name.
The owner this letter is addressed to, when recipient_type is owner.
Number of PDF pages in the letter, set when it is sent. Extra pages beyond the first are billed separately.
Who the letter is addressed to.
customer, owner Time at which the letter was submitted to for printing. Measured in seconds since the Unix epoch.
The current status of the letter.
draft, sending, sent, canceled, failed The letter template this letter was created from, if any.
Postal tracking number, when one is available.
Values for the template custom variables, keyed by variable key.
The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.