# 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.

- **Category:** documents
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 21
- **Triggers:** 0
- **Slug:** `INTELLIPRINT`
- **Version:** 20260307_00

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `print_id` | string | Yes | The unique ID of the print job to cancel or delete (e.g., 'print_abc123'). Note: Testmode print jobs cannot be cancelled. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | The background file to upload. Supported formats: PDF. |
| `name` | string | No | Optional display name for this Background. If not provided, the filename will be used. |
| `team` | string | No | Optional Team ID to assign this Background to. Get team IDs from listing teams. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | A user-friendly name for this mailing list. This name is displayed in the dashboard. |
| `recipients` | array | No | 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 | No | Address validation settings for the mailing list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `address` | object | Yes | The address information for the recipient. |
| `variables` | object | No | 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 | Yes | The ID of the mailing list the recipient belongs to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File to upload for the print job. Supported formats: PDF, Word (DOC/DOCX), RTF, JPG, PNG. |
| `metadata` | object | No | 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 | No | 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 | No | 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 | No | 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") | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `background_id` | string | Yes | The ID of the background to delete. Deletion fails if any print job has used this background in the last 90 days. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the recipient to delete from the mailing list (e.g., 'malrcp_xyz789'). |
| `mailing_list` | string | Yes | The ID of the mailing list that the recipient belongs to (e.g., 'mal_abc123'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the mailing list to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the recipient to retrieve. |
| `mailing_list` | string | Yes | The ID of the mailing list the recipient belongs to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of results to skip before returning (for pagination). |
| `team` | string | No | 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 | No | Number of backgrounds to return; must be between 1 and 1000. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | The number of objects to skip (for pagination). |
| `limit` | integer | No | The number of recipients to return in the response; must be between 1 and 1000. |
| `fields` | array | No | 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") | No | The field to sort the recipients by. |
| `sort_order` | string ("asc" | "desc") | No | The order to sort the recipients in. |
| `mailing_list` | string | Yes | The ID of the mailing list to retrieve recipients from. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of results to skip before returning (for pagination). |
| `limit` | integer | No | Number of mailing lists to return; must be between 1 and 1000. |
| `fields` | array | No | 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") | No | Valid fields to sort mailing lists by. |
| `sort_order` | string ("asc" | "desc") | No | Valid sort orders for mailing lists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Print Jobs

**Slug:** `INTELLIPRINT_LIST_PRINT_JOBS`

Tool to list print jobs with optional filters and pagination. Use after confirming API key.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of results to skip before returning (for pagination). |
| `limit` | integer | No | Number of print jobs to return; must be between 1 and 1000. |
| `testmode` | boolean | No | When true, returns only testmode print jobs; when omitted or false, returns live jobs. |
| `confirmed` | boolean | No | Filter by confirmation status: true for confirmed only; false for unconfirmed only. |
| `letters.status` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Templates

**Slug:** `INTELLIPRINT_LIST_TEMPLATES`

Tool to list all available templates. Use after authenticating API key to browse available templates.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `files` | array | Yes | List of files to merge into a single PDF. Minimum 2 files required. Each file must be a PDF, RTF, or Word document. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `background_id` | string | Yes | The ID of the Background to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Print Job

**Slug:** `INTELLIPRINT_RETRIEVE_PRINT_JOB`

Tool to retrieve details of a Print Job by its ID. Use when you have a valid print_id and need full job specifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `print_id` | string | Yes | The unique ID of the Print Job to retrieve (starts with 'print_') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New name for this Background |
| `team` | string | No | ID of the Team to assign this Background to |
| `background_id` | string | Yes | ID of the Background to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Mailing List

**Slug:** `INTELLIPRINT_UPDATE_MAILING_LIST`

Tool to update a mailing list. Use when you need to update the name, add or replace recipients in bulk, or configure address validation. Can add recipients to existing list or replace all recipients by setting delete_old_recipients to True.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the mailing list to update |
| `name` | string | No | A user-friendly name for this mailing list. This name is displayed in the dashboard. |
| `recipients` | array | No | An optional list of new recipients to add to the mailing list |
| `delete_old_recipients` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The ID of the recipient to update. |
| `address` | object | No | Address details for a mailing list recipient. |
| `variables` | object | No | An arbitrary object of the dynamic fields for this recipient. Dynamic fields are used to tailor templates uniquely for each recipient. |
| `mailing_list` | string | Yes | The ID of the mailing list the recipient belongs to. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |