## Create Snap Pack `print_mail.snap_packs.create(SnapPackCreateParams**kwargs) -> SnapPackCreateResponse` **post** `/print-mail/v1/snap_packs` Create a snap pack. You can supply one of the following: - HTML content for the inside and outside of the snap pack - Template IDs for the inside and outside of the snap pack - A URL or file upload for a two-page PDF that matches the snap pack layout ### Parameters - `from_: SnapPackCreateWithHTMLFrom` The contact information of the sender. You can pass contact information inline here just like you can for the `to` contact. - `class ContactCreateWithFirstName: …` - `address_line1: str` The first line of the contact's address. - `country_code: str` The ISO 3611-1 country code of the contact's address. - `first_name: str` - `address_line2: Optional[str]` Second line of the contact's address, if applicable. - `city: Optional[str]` The city of the contact's address. - `company_name: Optional[str]` Company name of the contact. - `description: Optional[str]` An optional string describing this resource. Will be visible in the API and the dashboard. - `email: Optional[str]` Email of the contact. - `force_verified_status: Optional[bool]` If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise. - `job_title: Optional[str]` Job title of the contact. - `last_name: Optional[str]` Last name of the contact. - `metadata: Optional[Dict[str, object]]` See the section on Metadata. - `phone_number: Optional[str]` Phone number of the contact. - `postal_or_zip: Optional[str]` The postal or ZIP code of the contact's address. - `province_or_state: Optional[str]` Province or state of the contact's address. - `skip_verification: Optional[bool]` If `true`, PostGrid will skip running this contact's address through our address verification system. - `class ContactCreateWithCompanyName: …` - `address_line1: str` The first line of the contact's address. - `company_name: str` - `country_code: str` The ISO 3611-1 country code of the contact's address. - `address_line2: Optional[str]` Second line of the contact's address, if applicable. - `city: Optional[str]` The city of the contact's address. - `description: Optional[str]` An optional string describing this resource. Will be visible in the API and the dashboard. - `email: Optional[str]` Email of the contact. - `first_name: Optional[str]` First name of the contact. - `force_verified_status: Optional[bool]` If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise. - `job_title: Optional[str]` Job title of the contact. - `last_name: Optional[str]` Last name of the contact. - `metadata: Optional[Dict[str, object]]` See the section on Metadata. - `phone_number: Optional[str]` Phone number of the contact. - `postal_or_zip: Optional[str]` The postal or ZIP code of the contact's address. - `province_or_state: Optional[str]` Province or state of the contact's address. - `skip_verification: Optional[bool]` If `true`, PostGrid will skip running this contact's address through our address verification system. - `str` - `inside_html: str` The HTML content for the inside of the snap pack. You can supply _either_ this or `insideTemplate` but not both. - `outside_html: str` The HTML content for the outside of the snap pack. You can supply _either_ this or `outsideTemplate` but not both. - `size: Literal["8.5x11_bifold_v"]` Enum representing the supported snap pack sizes. - `"8.5x11_bifold_v"` - `to: SnapPackCreateWithHTMLTo` The recipient of this order. You can either supply the contact information inline here or provide a contact ID. PostGrid will automatically deduplicate contacts regardless of whether you provide the information inline here or call the contact creation endpoint. - `class ContactCreateWithFirstName: …` - `class ContactCreateWithCompanyName: …` - `str` - `description: Optional[str]` An optional string describing this resource. Will be visible in the API and the dashboard. - `mailing_class: Optional[Literal["first_class", "standard_class", "express", 23 more]]` The mailing class of this order. If not provided, automatically set to `first_class`. - `"first_class"` - `"standard_class"` - `"express"` - `"certified"` - `"certified_return_receipt"` - `"registered"` - `"usps_first_class"` - `"usps_standard_class"` - `"usps_eddm"` - `"usps_express_2_day"` - `"usps_express_3_day"` - `"usps_first_class_certified"` - `"usps_first_class_certified_return_receipt"` - `"usps_first_class_registered"` - `"usps_express_3_day_signature_confirmation"` - `"usps_express_3_day_certified"` - `"usps_express_3_day_certified_return_receipt"` - `"ca_post_lettermail"` - `"ca_post_personalized"` - `"ca_post_neighbourhood_mail"` - `"ups_express_overnight"` - `"ups_express_2_day"` - `"ups_express_3_day"` - `"royal_mail_first_class"` - `"royal_mail_second_class"` - `"au_post_second_class"` - `merge_variables: Optional[Dict[str, object]]` These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template _exactly_ as they are case-sensitive. Note that these _do not_ apply to PDFs uploaded with the order. - `metadata: Optional[Dict[str, object]]` See the section on Metadata. - `send_date: Optional[Union[str, datetime]]` This order will transition from `ready` to `printing` on the day after this date. You can use this parameter to schedule orders for a future date. ### Returns - `class SnapPackCreateResponse: …` - `id: str` A unique ID prefixed with snap_pack_ - `created_at: datetime` The UTC time at which this resource was created. - `from_: Contact` The contact information of the sender. - `id: str` A unique ID prefixed with contact_ - `address_line1: str` The first line of the contact's address. - `address_status: Literal["verified", "corrected", "failed"]` One of `verified`, `corrected`, or `failed`. - `"verified"` - `"corrected"` - `"failed"` - `country_code: str` The ISO 3611-1 country code of the contact's address. - `created_at: datetime` The UTC time at which this resource was created. - `live: bool` `true` if this is a live mode resource else `false`. - `object: Literal["contact"]` Always `contact`. - `"contact"` - `updated_at: datetime` The UTC time at which this resource was last updated. - `address_errors: Optional[str]` A series of human-readable errors/warnings that were raised when running the provided address through our address verification. - `address_line2: Optional[str]` Second line of the contact's address, if applicable. - `city: Optional[str]` The city of the contact's address. - `company_name: Optional[str]` Company name of the contact. - `description: Optional[str]` An optional string describing this resource. Will be visible in the API and the dashboard. - `email: Optional[str]` Email of the contact. - `first_name: Optional[str]` First name of the contact. - `force_verified_status: Optional[bool]` If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise. - `job_title: Optional[str]` Job title of the contact. - `last_name: Optional[str]` Last name of the contact. - `metadata: Optional[Dict[str, object]]` See the section on Metadata. - `phone_number: Optional[str]` Phone number of the contact. - `postal_or_zip: Optional[str]` The postal or ZIP code of the contact's address. - `province_or_state: Optional[str]` Province or state of the contact's address. - `skip_verification: Optional[bool]` If `true`, PostGrid will skip running this contact's address through our address verification system. - `live: bool` `true` if this is a live mode resource else `false`. - `mailing_class: Literal["first_class", "standard_class", "express", 23 more]` The mailing class of this order. This determines the speed and cost of delivery. See `OrderMailingClass` for more details. - `"first_class"` - `"standard_class"` - `"express"` - `"certified"` - `"certified_return_receipt"` - `"registered"` - `"usps_first_class"` - `"usps_standard_class"` - `"usps_eddm"` - `"usps_express_2_day"` - `"usps_express_3_day"` - `"usps_first_class_certified"` - `"usps_first_class_certified_return_receipt"` - `"usps_first_class_registered"` - `"usps_express_3_day_signature_confirmation"` - `"usps_express_3_day_certified"` - `"usps_express_3_day_certified_return_receipt"` - `"ca_post_lettermail"` - `"ca_post_personalized"` - `"ca_post_neighbourhood_mail"` - `"ups_express_overnight"` - `"ups_express_2_day"` - `"ups_express_3_day"` - `"royal_mail_first_class"` - `"royal_mail_second_class"` - `"au_post_second_class"` - `object: Literal["snap_pack"]` Always `snap_pack`. - `"snap_pack"` - `send_date: datetime` This order will transition from `ready` to `printing` on the day after this date. For example, if this is a date on Tuesday, the order will transition to `printing` on Wednesday at midnight eastern time. - `size: Literal["8.5x11_bifold_v"]` Enum representing the supported snap pack sizes. - `"8.5x11_bifold_v"` - `status: Literal["ready", "printing", "processed_for_delivery", 2 more]` See `OrderStatus` for more details on the status of this order. - `"ready"` - `"printing"` - `"processed_for_delivery"` - `"completed"` - `"cancelled"` - `to: Contact` The recipient of this order. This will be provided even if you delete the underlying contact. - `updated_at: datetime` The UTC time at which this resource was last updated. - `cancellation: Optional[Cancellation]` The cancellation details of this order. Populated if the order has been cancelled. - `reason: Literal["user_initiated", "invalid_content", "invalid_order_mailing_class"]` The reason for the cancellation. - `"user_initiated"` - `"invalid_content"` - `"invalid_order_mailing_class"` - `cancelled_by_user: Optional[str]` The user ID who cancelled the order. - `note: Optional[str]` An optional note provided by the user who cancelled the order. - `description: Optional[str]` An optional string describing this resource. Will be visible in the API and the dashboard. - `imb_date: Optional[datetime]` The last date that the IMB status was updated. See `imbStatus` for more details. - `imb_status: Optional[Literal["entered_mail_stream", "out_for_delivery", "returned_to_sender"]]` The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders. - `"entered_mail_stream"` - `"out_for_delivery"` - `"returned_to_sender"` - `imb_zip_code: Optional[str]` The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an `imbStatus` is present. - `inside_html: Optional[str]` The HTML content for the inside of the snap pack, when provided instead of a template or PDF. - `inside_template: Optional[str]` The template ID for the inside of the snap pack, when provided instead of HTML or PDF. - `merge_variables: Optional[Dict[str, object]]` These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template _exactly_ as they are case-sensitive. Note that these _do not_ apply to PDFs uploaded with the order. - `metadata: Optional[Dict[str, object]]` See the section on Metadata. - `outside_html: Optional[str]` The HTML content for the outside of the snap pack, when provided instead of a template or PDF. - `outside_template: Optional[str]` The template ID for the outside of the snap pack, when provided instead of HTML or PDF. - `tracking_number: Optional[str]` The tracking number of this order. Populated after an express/certified order has been processed for delivery. - `uploaded_pdf: Optional[str]` A signed URL to the uploaded PDF provided at creation time, if a PDF was supplied. - `url: Optional[str]` PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all `GET` endpoints which produce this order. This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the `GET` endpoint again. ### Example ```python import os from postgrid import PostGrid client = PostGrid( print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"), # This is the default and can be omitted ) snap_pack = client.print_mail.snap_packs.create( from_="contact_123", inside_html="Inside", outside_html="Outside", size="8.5x11_bifold_v", to="contact_456", ) print(snap_pack.id) ``` #### Response ```json { "id": "snap_pack_123456", "object": "snap_pack", "status": "ready", "live": false, "to": { "id": "contact_pxd7wnnD1xY6H6etKNvjb4", "object": "contact", "live": false, "companyName": "PostGrid", "addressLine1": "90 CANAL ST STE 600", "city": "BOSTON", "provinceOrState": "MA", "postalOrZip": "90210-1234", "countryCode": "US", "skipVerification": false, "forceVerifiedStatus": false, "addressStatus": "verified", "createdAt": "2022-02-16T15:08:41.052Z", "updatedAt": "2022-02-16T15:08:41.052Z" }, "from": { "id": "contact_pxd7wnnD1xY6H6etKNvjb4", "object": "contact", "live": false, "companyName": "PostGrid", "addressLine1": "90 CANAL ST STE 600", "city": "BOSTON", "provinceOrState": "MA", "postalOrZip": "90210-1234", "countryCode": "US", "skipVerification": false, "forceVerifiedStatus": false, "addressStatus": "verified", "createdAt": "2022-02-16T15:08:41.052Z", "updatedAt": "2022-02-16T15:08:41.052Z" }, "size": "8.5x11_bifold_v", "insideHTML": "Inside", "outsideHTML": "Outside", "sendDate": "2020-11-12T23:23:47.974Z", "createdAt": "2020-11-12T23:23:47.974Z", "updatedAt": "2020-11-12T23:23:47.974Z", "mailingClass": "usps_first_class" } ```