changedInput schema / properties / certified / description
Previous value: -"USPS Certified Mail. \"certified\" ($14.99): tracking number and proof of mailing and delivery. \"certified_return_receipt\" ($19.99): adds the recipient's signature as proof of delivery, which landlords, courts and agencies often require. \"none\" ($4.99): regular First-Class."New value: +"USPS Certified Mail. \"certified\": tracking number and proof of mailing and delivery. \"certified_return_receipt\": adds the recipient's signature as proof of delivery, which landlords, courts and agencies often require. \"none\": regular First-Class. Prices: get_pricing."
changedInput schema / properties / content / description
Previous value: -"The letter text and font"New value: +"The letter: body text (optionally with a photo) or your own PDF"
changedInput schema / properties / content / properties / body / description
Previous value: -"Full letter text. Plain text; blank lines separate paragraphs."New value: +"Full letter text. Plain text; blank lines separate paragraphs. Use this OR pdf_url."
addedInput schema / properties / content / properties / color
Added value: +{
+ "description": "PDF letters only: print in color (costs a little more; see get_pricing). Text letters print in color automatically when they include image_url.",
+ "type": "boolean"
+}
changedInput schema / properties / content / properties / font / description
Previous value: -"Typeface for the letter body"New value: +"Typeface for the letter body (text letters)"
changedInput schema / properties / content / properties / image_url / description
Previous value: -"Optional photo printed at the top of the letter (https JPG or PNG). A letter with a photo prints in color, for a small surcharge (see get_pricing)."New value: +"Text letters only: optional photo printed at the top (https JPG or PNG). A letter with a photo prints in color, for a small surcharge (see get_pricing)."
addedInput schema / properties / content / properties / pdf_pages
Added value: +{
+ "description": "Set by Sendpaper: page count of the PDF",
+ "maximum": 9007199254740991,
+ "minimum": -9007199254740991,
+ "type": "integer"
+}
addedInput schema / properties / content / properties / pdf_url
Added value: +{
+ "description": "Mail your own document instead of body text: a public https link to a PDF (up to 6 pages). Pages are fitted to 8.5×11 and a blank address page is added in front.",
+ "maxLength": 2000,
+ "type": "string"
+}
removedInput schema / properties / content / required
Removed value: -[
- "body"
-]
addedInput schema / properties / express
Added value: +{
+ "default": false,
+ "description": "Send by express (USPS Priority Mail, usually 2–3 days, with tracking) for an extra charge; see get_pricing. Not available with certified.",
+ "type": "boolean"
+}
addedInput schema / properties / recipients
Added value: +{
+ "description": "Send the same piece to several people: 2-25 US addresses, used INSTEAD of to. Each gets their own order and tracking; one payment covers all.",
+ "items": {
+ "properties": {
+ "city": {
+ "description": "City",
+ "maxLength": 40,
+ "minLength": 2,
+ "type": "string"
+ },
+ "company": {
+ "description": "Company name, printed under the person's name",
+ "maxLength": 60,
+ "type": "string"
+ },
+ "line1": {
+ "description": "Street address",
+ "maxLength": 64,
+ "minLength": 3,
+ "type": "string"
+ },
+ "line2": {
+ "description": "Apartment, suite, unit",
+ "maxLength": 64,
+ "type": "string"
+ },
+ "name": {
+ "description": "Recipient or sender full name",
+ "maxLength": 60,
+ "minLength": 1,
+ "type": "string"
+ },
+ "state": {
+ "description": "Two-letter US state code, e.g. NY",
+ "type": "string"
+ },
+ "zip": {
+ "description": "5-digit US ZIP code, or ZIP+4",
+ "pattern": "^\\d{5}(-\\d{4})?$",
+ "type": "string"
+ }
+ },
+ "required": [
+ "name",
+ "line1",
+ "city",
+ "state",
+ "zip"
+ ],
+ "type": "object"
+ },
+ "maxItems": 25,
+ "minItems": 2,
+ "type": "array"
+}
changedInput schema / properties / to / description
Previous value: -"Recipient's US mailing address"New value: +"Recipient's US mailing address (or use recipients for several people)"
changedInput schema / required
Previous value: -[
- "to",
- "from",
- "content"
-]New value: +[
+ "from",
+ "content"
+]
addedOutput schema / properties / batch
Added value: +{
+ "additionalProperties": false,
+ "description": "Present when the order was created with recipients: the whole group. The top-level fields describe the first recipient's order; use batch.price and batch.checkout_url for the total and payment.",
+ "properties": {
+ "checkout_url": {
+ "description": "One payment link for every unpaid order in the group",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "count": {
+ "description": "How many recipients (one order each)",
+ "type": "number"
+ },
+ "discount": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "amount_cents": {
+ "type": "number"
+ },
+ "display": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount_cents",
+ "display",
+ "reason"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "id": {
+ "type": "string"
+ },
+ "price": {
+ "additionalProperties": false,
+ "description": "Total for the whole group",
+ "properties": {
+ "amount_cents": {
+ "type": "number"
+ },
+ "currency": {
+ "type": "string"
+ },
+ "display": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount_cents",
+ "currency",
+ "display"
+ ],
+ "type": "object"
+ },
+ "url": {
+ "description": "Group page listing every recipient",
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "count",
+ "url",
+ "checkout_url",
+ "price",
+ "discount"
+ ],
+ "type": "object"
+}
addedOutput schema / properties / orders
Added value: +{
+ "description": "Every order in the group, when created with recipients",
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "order_url": {
+ "type": "string"
+ },
+ "preview_url": {
+ "type": "string"
+ },
+ "to": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "to",
+ "order_url",
+ "preview_url"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+}