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

# Stannp

> Stannp provides a direct mail API enabling users to send postcards and letters programmatically.

![Stannp logo](https://mintcdn.com/composio-preview/B09iGux45A5cYDuO/images/toolkits/stannp.svg?fit=max\&auto=format\&n=B09iGux45A5cYDuO\&q=85\&s=22d9436df26a6f822825926e27d2d8b1)

* **Category:** marketing automation
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 32
* **Triggers:** 0
* **Slug:** `STANNP`
* **Version:** 20261101\_00

## Tools

> [accordion] Add recipients to group
>
> **Slug:** `STANNP_ADD_RECIPIENTS_TO_GROUP`
>
> Tool to add existing recipients to a mailing list group. Use when you need to add recipients from your account to an existing group for campaign management.
>
> #### Input Parameters
>
> **group\_id** `integer` *required*
>
> ID of the group to add recipients to.
>
> **recipients** `string` *required*
>
> Comma-separated list of recipient IDs to add to the group (e.g., '1,2' or '45112,45113').
>
> #### 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] Add Recipient to Group
>
> **Slug:** `STANNP_ADD_RECIPIENT_TO_GROUP`
>
> Tool to add a recipient to a recipient group. Use when you need to add new mailing list subscribers.
>
> #### Input Parameters
>
> **city** `string` *required*
>
> Recipient city.
>
> **email** `string`
>
> Recipient email address.
>
> **company** `string`
>
> Recipient company name.
>
> **country** `string`
>
> Recipient country code; defaults to 'GB'.
>
> **custom1** `string`
>
> Custom field 1.
>
> **custom2** `string`
>
> Custom field 2.
>
> **custom3** `string`
>
> Custom field 3.
>
> **address1** `string` *required*
>
> First line of recipient address.
>
> **address2** `string`
>
> Second line of recipient address.
>
> **address3** `string`
>
> Third line of recipient address.
>
> **group\_id** `string` *required*
>
> The ID of the recipient group to add the recipient to.
>
> **postcode** `string` *required*
>
> Recipient postcode.
>
> **last\_name** `string` *required*
>
> Recipient last name.
>
> **first\_name** `string` *required*
>
> Recipient first name.
>
> #### 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] Cancel Postcard
>
> **Slug:** `STANNP_CANCEL_POSTCARD`
>
> Tool to cancel a postcard if processing has not started yet. Use when you need to cancel a scheduled postcard before it enters production.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The ID of the postcard to cancel.
>
> #### 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 Campaign
>
> **Slug:** `STANNP_CREATE_CAMPAIGN`
>
> Tool to create a new direct mail campaign on the platform. Use when you need to set up a campaign with recipients and design templates. Requires a valid group\_id with recipients.
>
> #### Input Parameters
>
> **back** `string`
>
> A PDF or JPG file for the back image.
>
> **file** `string`
>
> A PDF file URL or binary for the design artwork.
>
> **name** `string` *required*
>
> Name your campaign for reference.
>
> **save** `boolean`
>
> Save the uploaded file as a new design template.
>
> **size** `string`
>
> Required when using file or front/back. Example: A4, A5, A6.
>
> **type** `string ("a6-postcard" | "a5-postcard" | "letter")` *required*
>
> The type of campaign: a6-postcard, a5-postcard, or letter.
>
> **front** `string`
>
> A PDF or JPG file for the front image.
>
> **addons** `string`
>
> Addon code if available.
>
> **group\_id** `integer` *required*
>
> A group ID for the recipients.
>
> **template\_id** `integer`
>
> A template ID to copy. If left out, a blank template will be used.
>
> **what\_recipients** `string ("all" | "valid" | "not_valid" | "int")`
>
> Filter for what recipients to include in the campaign.
>
> #### 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 campaign sample
>
> **Slug:** `STANNP_CREATE_CAMPAIGN_SAMPLE`
>
> Tool to produce a PDF sample of your campaign. The generated link will be valid for 30 minutes. Use when you need to preview a campaign before sending it to recipients.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of the campaign to produce a sample for.
>
> #### 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 folder
>
> **Slug:** `STANNP_CREATE_FOLDER`
>
> Tool to create a folder in your secure file transfer area. Use when you need to organize files or prepare a storage location before uploading documents.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the folder you wish to create.
>
> #### 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 recipient group
>
> **Slug:** `STANNP_CREATE_GROUP`
>
> Tool to create a new recipient group in Stannp. Use when you need to organize contacts into a distinct group before sending campaigns.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the group (must be unique within your account).
>
> **description** `string`
>
> Optional description for the group.
>
> #### 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 Letter
>
> **Slug:** `STANNP_CREATE_LETTER`
>
> Tool to create a letter with mail merge to insert address and variable data. Use when you need to send physical mail via Stannp API.
>
> #### Input Parameters
>
> **file** `string`
>
> URL to a PDF/DOC file or base64-encoded file content. Maximum of 10 pages. Use this as alternative to template parameter.
>
> **tags** `string`
>
> Comma-separated tags for reference, searchable in reporting
>
> **test** `boolean`
>
> If true, produces a sample PDF without dispatching or charging. Defaults to false.
>
> **addons** `string`
>
> Addon codes to upgrade your letter (e.g., FIRST\_CLASS for first-class postage)
>
> **duplex** `boolean`
>
> Set to false to print only on the front of each page. Defaults to true.
>
> **template** `integer`
>
> ID of a template already set up on the platform
>
> **clearzone** `boolean`
>
> If true, overlay clear zones with white background. Defaults to true.
>
> **recipient\_id** `string`
>
> ID of an existing recipient in your account. Use this OR recipient\_details, not both.
>
> **post\_unverified** `boolean`
>
> If false, the item will not be posted if the recipient address cannot be verified. Defaults to true.
>
> **recipient\_details** `object`
>
> Detailed recipient information for creating a new recipient.
>
> #### 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 Postcard
>
> **Slug:** `STANNP_CREATE_POSTCARD`
>
> Create a postcard for direct mail. The tool defaults to test mode, which generates a PDF without dispatching; disable test mode to request sending.
>
> #### Input Parameters
>
> **back** `string`
>
> URL or path to back image (JPG or PDF)
>
> **size** `string` *required*
>
> Postcard size: "4x6", "6x9", or "6x11"
>
> **tags** `string`
>
> Tags for tracking and reporting
>
> **test** `boolean`
>
> Test mode - generates PDF but doesn't dispatch
>
> **front** `string`
>
> URL or path to front image (JPG or PDF)
>
> **message** `string`
>
> Message text to include on the postcard
>
> **recipient** `object` *required*
>
> Recipient information including firstname, lastname, address1, city, zipcode, country
>
> #### 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 recipient selection
>
> **Slug:** `STANNP_CREATE_SELECTION`
>
> Tool to create a new recipient selection for targeting in Stannp. Use when you need to create an auto filter selection to target specific recipients within a group based on criteria.
>
> #### Input Parameters
>
> **name** `string`
>
> Optional name for the filter selection to help identify it.
>
> **filters** `string` *required*
>
> Specially formatted filter string: \[column\_name]:::\[operator]:::\[value]. Valid operators: matches, contains, begins, ends, before, after, less\_than, more\_than, is\_not. Chain multiple filters with :::AND:::. Example: 'firstname:::contains:::test' or 'firstname:::contains:::john:::AND:::age:::more\_than:::25'.
>
> **group\_id** `integer` *required*
>
> The ID of the group to associate this selection with.
>
> #### 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 recipient group
>
> **Slug:** `STANNP_DELETE_GROUP`
>
> Tool to delete a recipient group in Stannp. Recipients remain on your account unless delete\_recipients is true. Use when you need to remove a mailing list group.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of the group to delete.
>
> **delete\_recipients** `boolean`
>
> If true, completely delete all recipients in the group. Defaults to false (recipients remain on your account).
>
> #### 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 Recipient
>
> **Slug:** `STANNP_DELETE_RECIPIENT`
>
> Tool to permanently delete a recipient from your account. Use when you need to remove a recipient from your mailing list.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of the recipient to delete.
>
> #### 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 Account Balance
>
> **Slug:** `STANNP_GET_ACCOUNT_BALANCE`
>
> Tool to retrieve the current account balance. Use when you need to check available account funds.
>
> #### 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 Campaign
>
> **Slug:** `STANNP_GET_CAMPAIGN`
>
> Tool to retrieve details of a specific campaign. Use when you need to get information about a campaign by its ID.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of the campaign 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 Campaign Available Dates
>
> **Slug:** `STANNP_GET_CAMPAIGN_AVAILABLE_DATES`
>
> Tool to get available dates for scheduling a campaign (up to 30 days). Use when you need to check which dates are available for campaign dispatch.
>
> #### Input Parameters
>
> **end** `string` *required*
>
> End date in YYYY-MM-DD format for the date range query.
>
> **start** `string` *required*
>
> Start date in YYYY-MM-DD format for the date range query.
>
> #### 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 Campaign Cost
>
> **Slug:** `STANNP_GET_CAMPAIGN_COST`
>
> Tool to get the estimated cost of booking a campaign. Use when you need to calculate the total cost before booking a direct mail campaign.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of the campaign to get the cost of booking.
>
> #### 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 Contact
>
> **Slug:** `STANNP_GET_CONTACT`
>
> Retrieve details of a specific contact by ID, returning the contact fields supported by the response model.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> The ID of the contact 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 Current User
>
> **Slug:** `STANNP_GET_CURRENT_USER`
>
> Retrieve account details for the currently authenticated user.
>
> #### 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 Reporting Summary
>
> **Slug:** `STANNP_GET_REPORTING_SUMMARY`
>
> Tool to get a status summary on individual items within a date range. Use when you need reporting metrics for mailpieces including delivery status, printing status, and counts.
>
> #### Input Parameters
>
> **end\_date** `string` *required*
>
> End date in YYYY-MM-DD format for the reporting period
>
> **start\_date** `string` *required*
>
> Start date in YYYY-MM-DD format for the reporting period
>
> #### 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] Import Recipients
>
> **Slug:** `STANNP_IMPORT_RECIPIENTS`
>
> Tool to import recipients from a CSV or XLS file into a Stannp recipient group. Use when you have a mailing list file ready to upload.
>
> #### Input Parameters
>
> **file** `string` *required*
>
> Base64-encoded CSV or XLS file content to upload
>
> **group\_id** `string` *required*
>
> ID of the recipient group to import into
>
> **update\_existing** `boolean`
>
> Whether to update existing recipients if duplicates are found
>
> #### 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 Campaigns
>
> **Slug:** `STANNP_LIST_CAMPAIGNS`
>
> Tool to get a list of all campaigns. Use when you need to retrieve campaigns after authentication.
>
> #### 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 Contacts
>
> **Slug:** `STANNP_LIST_CONTACTS`
>
> Tool to list all contacts. Use when you need to retrieve contacts with optional pagination filters.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results
>
> **limit** `integer`
>
> Number of results per page
>
> #### 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 Folders
>
> **Slug:** `STANNP_LIST_FOLDERS`
>
> Tool to get a list of folders in your secure file transfer area. Use when you need to retrieve available folders for file organization.
>
> #### 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 Groups
>
> **Slug:** `STANNP_LIST_GROUPS`
>
> Tool to get a list of mailing groups on your account. Use when you need to retrieve all groups with optional pagination.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Limit for pagination. Specifies the maximum number of groups to return.
>
> **offset** `integer`
>
> Offset for pagination. Specifies the starting point for the result set.
>
> #### 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 Mailpieces
>
> **Slug:** `STANNP_LIST_MAILPIECES`
>
> Retrieve mailpiece objects sent within a date range to review mailing history. Optionally filter the results by delivery status or custom tag.
>
> #### Input Parameters
>
> **tag** `string`
>
> Filter by custom tag associated with mailpieces
>
> **status** `string`
>
> Filter by delivery status (e.g., delivered, returned, printing, local\_delivery)
>
> **enddate** `string` *required*
>
> End date of the reporting period in YYYY-MM-DD format
>
> **startdate** `string` *required*
>
> Start date of the reporting period in YYYY-MM-DD format
>
> #### 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:** `STANNP_LIST_TEMPLATES`
>
> Tool to list all templates associated with the account. Use when you need to retrieve available templates after authentication.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for paginated results
>
> **size** `integer`
>
> Number of records per page
>
> #### 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 PDF files
>
> **Slug:** `STANNP_MERGE_PDFS`
>
> Merge two or more PDF files accessible by URL into a single file, returning the merged file URL.
>
> #### Input Parameters
>
> **files** `array` *required*
>
> An array of URLs for the PDF files to merge. Provide at least 2 URLs to merge.
>
> #### 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] Purge Group
>
> **Slug:** `STANNP_PURGE_GROUP`
>
> Tool to remove all recipients from a mailing list. Recipients remain on your account if delete\_recipients is false.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of the group to purge.
>
> **delete\_recipients** `boolean`
>
> If true, completely delete all recipients. Defaults to false.
>
> #### 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] Recalculate group
>
> **Slug:** `STANNP_RECALCULATE_GROUP`
>
> Tool to recalculate a group to ensure stats are up to date. Use when you need to refresh group statistics after adding or removing recipients.
>
> #### Input Parameters
>
> **group\_id** `integer` *required*
>
> The ID of the group to recalculate.
>
> #### 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] Remove Recipients from Group
>
> **Slug:** `STANNP_REMOVE_RECIPIENTS_FROM_GROUP`
>
> Tool to remove recipients from a group without deleting them. Use when you need to remove contacts from a mailing group while keeping them in your account.
>
> #### Input Parameters
>
> **group\_id** `integer` *required*
>
> ID of the group to remove recipients from.
>
> **recipients** `string` *required*
>
> Comma-separated recipient IDs to remove from the group.
>
> #### 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] Upload File
>
> **Slug:** `STANNP_UPLOAD_FILE`
>
> Tool to upload a file to your secure file transfer area. Use when you need to upload files for direct mail campaigns. Supports both URL-based imports and binary file uploads.
>
> #### Input Parameters
>
> **file** `string` *required*
>
> File to upload. Can be either a file or a URL string pointing to a remote file to be imported (e.g., '[https://example.com/file.pdf](https://example.com/file.pdf)').
>
> **folder** `integer`
>
> A folder ID for placing the file in a specific folder
>
> #### 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] Validate Address
>
> **Slug:** `STANNP_VALIDATE_ADDRESS`
>
> Tool to validate a postal address. Currently supports UK and US addresses only. Use when you need to verify if a given address is valid before sending mail.
>
> #### Input Parameters
>
> **city** `string`
>
> Address city.
>
> **state** `string`
>
> Two-letter state abbreviation if possible.
>
> **company** `string`
>
> Company name.
>
> **country** `string`
>
> ISO 3166-1 Alpha 2 Country Code (US, GB, CA, FR...).
>
> **zipcode** `string`
>
> Address zipcode.
>
> **address1** `string`
>
> Address line 1.
>
> **address2** `string`
>
> Address line 2.
>
> #### 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
