Skip to main content
Intelliprint logo
  • Category: documents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 21
  • Triggers: 0
  • Slug: INTELLIPRINT
  • Version: 20261101_00

Tools

Slug: INTELLIPRINT_CANCEL_DELETE_PRINT_JOBCancel 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_CREATE_BACKGROUNDCreate 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

object
required
The background file to upload. Supported formats: PDF.
string
Optional display name for this Background. If not provided, the filename will be used.
string
Optional Team ID to assign this Background to. Get team IDs from listing teams.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_CREATE_MAILING_LISTCreate 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

string
required
A user-friendly name for this mailing list. This name is displayed in the dashboard.
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.
object
Address validation settings for the mailing list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_CREATE_MAILING_LIST_RECIPIENTTool 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

object
required
The address information for the recipient.
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.
string
required
The ID of the mailing list the recipient belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_CREATE_PRINT_JOBCreate 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

object
required
File to upload for the print job. Supported formats: PDF, Word (DOC/DOCX), RTF, JPG, PNG.
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.
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.
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.
string
User-provided reference string to identify this print job in the dashboard and API responses. Useful for tracking/matching jobs.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_DELETE_BACKGROUNDTool 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_DELETE_MAILING_LISTTool 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_DELETE_MAILING_LIST_RECIPIENTDelete a recipient by ID from a specified mailing list. Use when you need to remove a recipient from a mailing list.

Input Parameters

string
required
The ID of the recipient to delete from the mailing list (e.g., ‘malrcp_xyz789’).
string
required
The ID of the mailing list that the recipient belongs to (e.g., ‘mal_abc123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_GET_MAILING_LISTTool 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

string
required
The ID of the mailing list to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_GET_MAILING_LIST_RECIPIENTTool 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

string
required
The ID of the recipient to retrieve.
string
required
The ID of the mailing list the recipient belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_LIST_BACKGROUNDSTool 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

integer
Number of results to skip before returning (for pagination).
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.
integer
Number of backgrounds to return; must be between 1 and 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_LIST_MAILING_LIST_RECIPIENTSTool 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

integer
The number of objects to skip (for pagination).
integer
The number of recipients to return in the response; must be between 1 and 1000.
array
A filtered down list of fields to return in the response. Example: [“id”, “name”, “address.line”]. By default, all fields are returned.
string ("created" | "name")
The field to sort the recipients by.
string ("asc" | "desc")
The order to sort the recipients in.
string
required
The ID of the mailing list to retrieve recipients from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_LIST_MAILING_LISTSTool 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

integer
Number of results to skip before returning (for pagination).
integer
Number of mailing lists to return; must be between 1 and 1000.
array
Optional list of specific fields to return in the response (e.g., [“id”, “name”, “recipients”]). By default, all fields are returned.
string ("created" | "name" | "recipients")
Valid fields to sort mailing lists by.
string ("asc" | "desc")
Valid sort orders for mailing lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_LIST_PRINT_JOBSList print jobs with optional filters and pagination. By default, results include only live-mode jobs; set test mode to retrieve test jobs.

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_LIST_TEMPLATESList available templates with pagination.

Input Parameters

integer
Number of results to skip before returning (for pagination).
integer
Number of templates to return; must be between 1 and 1000.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_MERGE_FILESMerges 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_RETRIEVE_BACKGROUNDTool to retrieve a specific Background by ID. Use when you need background details before further processing.

Input Parameters

string
required
The ID of the Background to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_RETRIEVE_PRINT_JOBRetrieve an Intelliprint print job by its ID to inspect its details, including its printing and postage settings, associated mail items, and costs.

Input Parameters

string
required
The unique ID of the Print Job to retrieve (starts with ‘print_‘)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_UPDATE_BACKGROUNDTool 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

string
New name for this Background
string
ID of the Team to assign this Background to
string
required
ID of the Background to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_UPDATE_MAILING_LISTUpdate a mailing list’s name or add recipients in bulk. Existing recipients can be replaced using the delete-old-recipients option.

Input Parameters

string
required
The ID of the mailing list to update
string
A user-friendly name for this mailing list. This name is displayed in the dashboard.
array
An optional list of new recipients to add to the mailing list
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: INTELLIPRINT_UPDATE_MAILING_LIST_RECIPIENTTool 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

string
required
The ID of the recipient to update.
object
Address details for a mailing list recipient.
object
An arbitrary object of the dynamic fields for this recipient. Dynamic fields are used to tailor templates uniquely for each recipient.
string
required
The ID of the mailing list the recipient belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not