> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Intelliprint

> Intelliprint offers a Hybrid Mail API that enables businesses to automate their letter printing and mailing processes, providing features like same-day printing, secure authentication, and real-time tracking.

![Intelliprint logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/intelliprint.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=c3fade89cf88d81bcb293d51ee7d144a)

* **Category:** documents
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 21
* **Triggers:** 0
* **Slug:** `INTELLIPRINT`
* **Version:** 20261101\_00

## Tools

> [accordion] Cancel or Delete Print Job
>
> **Slug:** `INTELLIPRINT_CANCEL_DELETE_PRINT_JOB`
>
> Cancel or delete an existing print job by its ID. Unconfirmed jobs are deleted immediately; confirmed jobs (not yet shipped) are cancelled with a refund. Important: Testmode print jobs cannot be cancelled - only live print jobs support cancellation.
>
> #### Input Parameters
>
> **print\_id** `string` *required*
>
> The unique ID of the print job to cancel or delete (e.g., 'print\_abc123'). Note: Testmode print jobs cannot be cancelled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create background
>
> **Slug:** `INTELLIPRINT_CREATE_BACKGROUND`
>
> Create a new Background by uploading a PDF file. Backgrounds are used as base layers for print jobs (e.g., letterheads, invoice templates). Use this tool when you need to upload a new background PDF that can be applied to print jobs.
>
> #### Input Parameters
>
> **file** `object` *required*
>
> The background file to upload. Supported formats: PDF.
>
> **name** `string`
>
> Optional display name for this Background. If not provided, the filename will be used.
>
> **team** `string`
>
> Optional Team ID to assign this Background to. Get team IDs from listing teams.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Mailing List
>
> **Slug:** `INTELLIPRINT_CREATE_MAILING_LIST`
>
> Create a mailing list to store thousands of recipients and send mail items to all of them at once. Use this tool when you need to create a new mailing list for bulk mailings. Recipients can be added in bulk during creation or added later. Mailing lists support dynamic fields (variables) for personalizing templates per recipient.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> A user-friendly name for this mailing list. This name is displayed in the dashboard.
>
> **recipients** `array`
>
> An optional list of recipients to add to the mailing list during creation. Recipients can also be added later using the add recipients endpoint.
>
> **address\_validation** `object`
>
> Address validation settings for the mailing list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Mailing List Recipient
>
> **Slug:** `INTELLIPRINT_CREATE_MAILING_LIST_RECIPIENT`
>
> Tool to create a new recipient within a mailing list. Use when you need to add an individual contact who will receive mail campaigns. Recipients must have at minimum an address line; name, postcode, and country are optional.
>
> #### Input Parameters
>
> **address** `object` *required*
>
> The address information for the recipient.
>
> **variables** `object`
>
> An arbitrary object of the dynamic fields for this recipient. Dynamic fields are used to tailor templates uniquely for each recipient. Keys and values must be strings.
>
> **mailing\_list** `string` *required*
>
> The ID of the mailing list the recipient belongs to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Print Job
>
> **Slug:** `INTELLIPRINT_CREATE_PRINT_JOB`
>
> Create a new print job in Intelliprint by uploading a document. Use this tool to submit documents for postal mailing. Jobs can be created as drafts (confirmed=False) for review/editing, or confirmed immediately (confirmed=True) for printing and dispatch. Test mode (testmode=True) allows testing without charges or actual mailing.
>
> #### Input Parameters
>
> **file** `object` *required*
>
> File to upload for the print job. Supported formats: PDF, Word (DOC/DOCX), RTF, JPG, PNG.
>
> **metadata** `object`
>
> Key-value object for storing custom data with this print job. Keys and values must be strings. Use for order IDs, customer info, etc.
>
> **testmode** `boolean`
>
> Whether to mark this print job as a test. Test jobs are not charged and are never physically printed or sent. They are automatically deleted one week after confirmation. Useful for integration testing.
>
> **confirmed** `boolean`
>
> Whether to confirm the print job immediately for sending. If True, the job is submitted for printing and cannot be modified. If False (default), the job is created as a draft that can be edited or deleted before confirmation.
>
> **reference** `string`
>
> User-provided reference string to identify this print job in the dashboard and API responses. Useful for tracking/matching jobs.
>
> **splitting\_method** `string ("none" | "split_on_phrase" | "split_on_pages")`
>
> Splitting method for the uploaded file. 'none': treat as single letter (default). 'split\_on\_phrase': split into multiple letters based on a phrase marker. 'split\_on\_pages': split into multiple letters based on page count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Background
>
> **Slug:** `INTELLIPRINT_DELETE_BACKGROUND`
>
> Tool to delete a background by ID. Use when you need to remove a background that is no longer needed. Fails if any print job has used this background in the last 90 days.
>
> #### Input Parameters
>
> **background\_id** `string` *required*
>
> The ID of the background to delete. Deletion fails if any print job has used this background in the last 90 days.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Mailing List
>
> **Slug:** `INTELLIPRINT_DELETE_MAILING_LIST`
>
> Tool to delete a mailing list along with all the recipients in the mailing list. Use when you need to remove a mailing list permanently.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique ID of the mailing list to delete (starts with 'mal\_'). This will delete the mailing list along with all the recipients in the mailing list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Mailing List Recipient
>
> **Slug:** `INTELLIPRINT_DELETE_MAILING_LIST_RECIPIENT`
>
> Delete a recipient by ID from a specified mailing list. Use when you need to remove a recipient from a mailing list.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the recipient to delete from the mailing list (e.g., 'malrcp\_xyz789').
>
> **mailing\_list** `string` *required*
>
> The ID of the mailing list that the recipient belongs to (e.g., 'mal\_abc123').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Mailing List
>
> **Slug:** `INTELLIPRINT_GET_MAILING_LIST`
>
> Tool to retrieve a single mailing list by its ID. Use when you need details about a specific mailing list including recipients count, address validation status, and dynamic variables.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the mailing list to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Mailing List Recipient
>
> **Slug:** `INTELLIPRINT_GET_MAILING_LIST_RECIPIENT`
>
> Tool to retrieve a single recipient by ID within a specified mailing list. Use when you need details about a specific mailing list recipient.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the recipient to retrieve.
>
> **mailing\_list** `string` *required*
>
> The ID of the mailing list the recipient belongs to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Backgrounds
>
> **Slug:** `INTELLIPRINT_LIST_BACKGROUNDS`
>
> Tool to list backgrounds with optional filtering and pagination. Use after uploading or managing backgrounds to retrieve current entries. Example: 'List backgrounds for team=team\_1234 with limit=50 and skip=10'.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of results to skip before returning (for pagination).
>
> **team** `string`
>
> Optional Team ID to filter backgrounds. When provided, only returns backgrounds belonging to this team. Omit to retrieve all backgrounds accessible to the account.
>
> **limit** `integer`
>
> Number of backgrounds to return; must be between 1 and 1000.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Mailing List Recipients
>
> **Slug:** `INTELLIPRINT_LIST_MAILING_LIST_RECIPIENTS`
>
> Tool to list all recipients in a mailing list with pagination and sorting options. Use when you need to retrieve recipients from a specific mailing list.
>
> #### Input Parameters
>
> **skip** `integer`
>
> The number of objects to skip (for pagination).
>
> **limit** `integer`
>
> The number of recipients to return in the response; must be between 1 and 1000.
>
> **fields** `array`
>
> A filtered down list of fields to return in the response. Example: \["id", "name", "address.line"]. By default, all fields are returned.
>
> **sort\_field** `string ("created" | "name")`
>
> The field to sort the recipients by.
>
> **sort\_order** `string ("asc" | "desc")`
>
> The order to sort the recipients in.
>
> **mailing\_list** `string` *required*
>
> The ID of the mailing list to retrieve recipients from.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Mailing Lists
>
> **Slug:** `INTELLIPRINT_LIST_MAILING_LISTS`
>
> Tool to list all available mailing lists with pagination and sorting options. Use when you need to retrieve mailing lists for print jobs or to view existing lists.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of results to skip before returning (for pagination).
>
> **limit** `integer`
>
> Number of mailing lists to return; must be between 1 and 1000.
>
> **fields** `array`
>
> Optional list of specific fields to return in the response (e.g., \["id", "name", "recipients"]). By default, all fields are returned.
>
> **sort\_field** `string ("created" | "name" | "recipients")`
>
> Valid fields to sort mailing lists by.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Valid sort orders for mailing lists.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Print Jobs
>
> **Slug:** `INTELLIPRINT_LIST_PRINT_JOBS`
>
> List print jobs with optional filters and pagination. By default, results include only live-mode jobs; set test mode to retrieve test jobs.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of results to skip before returning (for pagination).
>
> **limit** `integer`
>
> Number of print jobs to return; must be between 1 and 1000.
>
> **testmode** `boolean`
>
> When true, returns only testmode print jobs; when omitted or false, returns live jobs.
>
> **confirmed** `boolean`
>
> Filter by confirmation status: true for confirmed only; false for unconfirmed only.
>
> **letters.status** `string`
>
> Comma-separated list of letter statuses to filter by (use key 'letters.status'). A job is returned if any letter matches one of these statuses. Valid statuses: draft, waiting\_to\_print, printing, enclosing, shipping, sent, cancelled, returned, failed\_wrong\_address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Templates
>
> **Slug:** `INTELLIPRINT_LIST_TEMPLATES`
>
> List available templates with pagination.
>
> #### Input Parameters
>
> **skip** `integer`
>
> Number of results to skip before returning (for pagination).
>
> **limit** `integer`
>
> Number of templates to return; must be between 1 and 1000.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Merge Files
>
> **Slug:** `INTELLIPRINT_MERGE_FILES`
>
> Merges multiple PDF, RTF, or Word documents into a single PDF file. Use this tool when you need to: - Combine multiple PDF files into one - Merge Word documents (.doc, .docx) into a single PDF - Combine RTF files with PDFs or Word documents - Create a unified document from separate files The merged output is always a PDF file, regardless of input file types. Files are merged in the order they are provided in the request. A download link is returned that is valid for approximately 1 hour.
>
> #### Input Parameters
>
> **files** `array` *required*
>
> List of files to merge into a single PDF. Minimum 2 files required. Each file must be a PDF, RTF, or Word document.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Background
>
> **Slug:** `INTELLIPRINT_RETRIEVE_BACKGROUND`
>
> Tool to retrieve a specific Background by ID. Use when you need background details before further processing.
>
> #### Input Parameters
>
> **background\_id** `string` *required*
>
> The ID of the Background to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Print Job
>
> **Slug:** `INTELLIPRINT_RETRIEVE_PRINT_JOB`
>
> Retrieve an Intelliprint print job by its ID to inspect its details, including its printing and postage settings, associated mail items, and costs.
>
> #### Input Parameters
>
> **print\_id** `string` *required*
>
> The unique ID of the Print Job to retrieve (starts with 'print\_')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Background
>
> **Slug:** `INTELLIPRINT_UPDATE_BACKGROUND`
>
> Tool to update an existing Background's name or team. Use when you need to change a background after creation. Example: 'Update background bg\_123abc to new name'.
>
> #### Input Parameters
>
> **name** `string`
>
> New name for this Background
>
> **team** `string`
>
> ID of the Team to assign this Background to
>
> **background\_id** `string` *required*
>
> ID of the Background to update
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Mailing List
>
> **Slug:** `INTELLIPRINT_UPDATE_MAILING_LIST`
>
> Update a mailing list's name or add recipients in bulk. Existing recipients can be replaced using the delete-old-recipients option.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the mailing list to update
>
> **name** `string`
>
> A user-friendly name for this mailing list. This name is displayed in the dashboard.
>
> **recipients** `array`
>
> An optional list of new recipients to add to the mailing list
>
> **delete\_old\_recipients** `boolean`
>
> Whether to delete all currently stored recipients from the mailing list before adding new ones. Set to True to replace all recipients, False to add to existing recipients.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Mailing List Recipient
>
> **Slug:** `INTELLIPRINT_UPDATE_MAILING_LIST_RECIPIENT`
>
> Tool to update an existing recipient in a mailing list by ID. Use when you need to modify recipient address details or custom variables for personalized mailings.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The ID of the recipient to update.
>
> **address** `object`
>
> Address details for a mailing list recipient.
>
> **variables** `object`
>
> An arbitrary object of the dynamic fields for this recipient. Dynamic fields are used to tailor templates uniquely for each recipient.
>
> **mailing\_list** `string` *required*
>
> The ID of the mailing list the recipient belongs to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
