addedInput schema / properties / content / properties / caption
Added value: +{
+ "description": "photo_caption: short text over a band at the bottom of the photo",
+ "maxLength": 80,
+ "minLength": 1,
+ "type": "string"
+}
changedInput schema / properties / content / properties / front_headline / description
Previous value: -"Big text for the front if there is no image, e.g. 'Happy birthday, Sam!'"New value: +"headline layout: big text for the front, e.g. 'Happy birthday, Sam!'"
changedInput schema / properties / content / properties / front_image_url / description
Previous value: -"https URL of a photo or design for the front (JPG or PNG)"New value: +"https URL of a photo or design for the front (JPG or PNG); for photo and photo_caption"
addedInput schema / properties / content / properties / front_images
Added value: +{
+ "description": "Collage: 2 to 4 https photo URLs, laid out in a grid",
+ "items": {
+ "maxLength": 2000,
+ "type": "string"
+ },
+ "maxItems": 4,
+ "minItems": 2,
+ "type": "array"
+}
changedInput schema / properties / content / properties / front_theme / description
Previous value: -"Color theme for a text-only front"New value: +"headline layout: color theme (ink, sky, sunset, forest, rose, sand, night, mint)"
changedInput schema / properties / content / properties / front_theme / enum
Previous value: -[
- "ink",
- "sky",
- "sunset",
- "forest"
-]New value: +[
+ "ink",
+ "sky",
+ "sunset",
+ "forest",
+ "rose",
+ "sand",
+ "night",
+ "mint"
+]
addedInput schema / properties / content / properties / headline_font
Added value: +{
+ "default": "serif",
+ "description": "Font for the headline or caption: serif, sans or script (handwritten)",
+ "enum": [
+ "serif",
+ "sans",
+ "script"
+ ],
+ "type": "string"
+}
addedInput schema / properties / content / properties / layout
Added value: +{
+ "description": "Front layout: headline (big text on a color), photo (one full-bleed photo), photo_caption (photo with a caption band), collage (2-4 photos). Inferred from the fields when omitted.",
+ "enum": [
+ "headline",
+ "photo",
+ "photo_caption",
+ "collage"
+ ],
+ "type": "string"
+}
changedInput schema / properties / content / properties / message / description
Previous value: -"Handwritten-style message on the back"New value: +"The message on the back"
addedInput schema / properties / content / properties / message_font
Added value: +{
+ "default": "handwriting",
+ "description": "Font for the message on the back",
+ "enum": [
+ "handwriting",
+ "serif",
+ "sans"
+ ],
+ "type": "string"
+}
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"
+}