addedInput schema / properties / insert_stock
Added value: +{
+ "description": "The insert's stock: paper (+30¢), weatherproof (+95¢) or label_sheet, one full 8.5 × 11 in weatherproof sticker printed on one side (+$1.45). Per piece; letters, flyers and pamphlets only.",
+ "enum": [
+ "paper",
+ "weatherproof",
+ "label_sheet"
+ ],
+ "type": "string"
+}
addedInput schema / properties / insert_url
Added value: +{
+ "description": "Optional public https:// link to one insert sheet (PDF, PNG or JPG, US Letter, 1 or 2 pages) packed with every letter, flyer or pamphlet. Its PDF form fields named like your keys are filled per recipient.",
+ "format": "uri",
+ "type": "string"
+}
addedInput schema / properties / mail_on
Added value: +{
+ "description": "Optional date to mail on, YYYY-MM-DD (Pacific time), today to 60 days ahead. The facility mails on or after it.",
+ "type": "string"
+}
addedInput schema / properties / message
Added value: +{
+ "description": "Optional text with {{tags}}. On a letter it is the letter itself (Times 12 pt, 1 in margins; send no template_url). On a postcard it prints on the address side mailbox.bot adds, so the template must be the front only; it must fit once each recipient's fields are filled in.",
+ "maxLength": 15000,
+ "type": "string"
+}
addedInput schema / properties / qr
Added value: +{
+ "additionalProperties": false,
+ "description": "Optional: a QR code unique to each piece, https://mailbox.bot/q/<code>. Postcards: on the address side, bottom left. Letters and inserts: bottom right of page 1 (keep about 3 × 1 in clear). Scans store counts and times only.",
+ "properties": {
+ "expires_days": {
+ "description": "confirm and verify: days the code works, from the mail date. Default 30.",
+ "maximum": 90,
+ "minimum": 1,
+ "type": "integer"
+ },
+ "label": {
+ "description": "Printed beside the code and used as the confirm button, e.g. \"Sign posted\". Up to 40 characters.",
+ "maxLength": 40,
+ "type": "string"
+ },
+ "mode": {
+ "description": "link: the code opens url. confirm: it opens a mailbox.bot page with one button (label), records the confirmation, then opens url when given. verify: address verification; the piece also prints a short code the person enters in your app, signed in (POST /v1/batch-mail/verify with their ref), and a scan opens url (your page) with the code after #; nothing on mailbox.bot verifies; the code expires.",
+ "enum": [
+ "link",
+ "confirm",
+ "verify"
+ ],
+ "type": "string"
+ },
+ "on": {
+ "description": "piece (default) or insert.",
+ "enum": [
+ "piece",
+ "insert"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "https:// link, may hold {{tags}} (values are URL-encoded). Required for link.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "mode"
+ ],
+ "type": "object"
+}
addedInput schema / properties / stock
Added value: +{
+ "description": "standard (default) or weatherproof: tear- and water-resistant synthetic sheets for notices and small signs posted outdoors, letters and flyers only, +85¢ per sheet.",
+ "enum": [
+ "standard",
+ "weatherproof"
+ ],
+ "type": "string"
+}
changedInput schema / properties / template_url / description
Previous value: -"Public https:// link to the template (PDF, PNG or JPG, ≤10 MB). Signed cloud-storage links, CDN and GitHub raw URLs work; links that need a login, private hosts and IP addresses are refused."New value: +"Public https:// link to the template (PDF, PNG or JPG, ≤10 MB). Signed cloud-storage links, CDN and GitHub raw URLs work; links that need a login, private hosts and IP addresses are refused. Required, except for a letter sent as message."
changedInput schema / required
Previous value: -[
- "job_name",
- "mail_type",
- "template_url",
- "mailbox_md_version"
-]New value: +[
+ "job_name",
+ "mail_type",
+ "mailbox_md_version"
+]
