Skip to main content
Stannp logo
  • Category: marketing automation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 32
  • Triggers: 0
  • Slug: STANNP
  • Version: 20261101_00

Tools

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

integer
required
ID of the group to add recipients to.
string
required
Comma-separated list of recipient IDs to add to the group (e.g., ‘1,2’ or ‘45112,45113’).

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: STANNP_ADD_RECIPIENT_TO_GROUPTool to add a recipient to a recipient group. Use when you need to add new mailing list subscribers.

Input Parameters

string
required
Recipient city.
string
Recipient email address.
string
Recipient company name.
string
Recipient country code; defaults to ‘GB’.
string
Custom field 1.
string
Custom field 2.
string
Custom field 3.
string
required
First line of recipient address.
string
Second line of recipient address.
string
Third line of recipient address.
string
required
The ID of the recipient group to add the recipient to.
string
required
Recipient postcode.
string
required
Recipient last name.
string
required
Recipient first name.

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: STANNP_CANCEL_POSTCARDTool 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

integer
required
The ID of the postcard to cancel.

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: STANNP_CREATE_CAMPAIGNTool 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

string
A PDF or JPG file for the back image.
string
A PDF file URL or binary for the design artwork.
string
required
Name your campaign for reference.
boolean
Save the uploaded file as a new design template.
string
Required when using file or front/back. Example: A4, A5, A6.
string ("a6-postcard" | "a5-postcard" | "letter")
required
The type of campaign: a6-postcard, a5-postcard, or letter.
string
A PDF or JPG file for the front image.
string
Addon code if available.
integer
required
A group ID for the recipients.
integer
A template ID to copy. If left out, a blank template will be used.
string ("all" | "valid" | "not_valid" | "int")
Filter for what recipients to include in the campaign.

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: STANNP_CREATE_CAMPAIGN_SAMPLETool 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

integer
required
ID of the campaign to produce a sample for.

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: STANNP_CREATE_FOLDERTool 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

string
required
The name of the folder you wish to create.

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: STANNP_CREATE_GROUPTool to create a new recipient group in Stannp. Use when you need to organize contacts into a distinct group before sending campaigns.

Input Parameters

string
required
Name of the group (must be unique within your account).
string
Optional description for the group.

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: STANNP_CREATE_LETTERTool 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

string
URL to a PDF/DOC file or base64-encoded file content. Maximum of 10 pages. Use this as alternative to template parameter.
string
Comma-separated tags for reference, searchable in reporting
boolean
If true, produces a sample PDF without dispatching or charging. Defaults to false.
string
Addon codes to upgrade your letter (e.g., FIRST_CLASS for first-class postage)
boolean
Set to false to print only on the front of each page. Defaults to true.
integer
ID of a template already set up on the platform
boolean
If true, overlay clear zones with white background. Defaults to true.
string
ID of an existing recipient in your account. Use this OR recipient_details, not both.
boolean
If false, the item will not be posted if the recipient address cannot be verified. Defaults to true.
object
Detailed recipient information for creating a new recipient.

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: STANNP_CREATE_POSTCARDCreate 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

string
URL or path to back image (JPG or PDF)
string
required
Postcard size: “4x6”, “6x9”, or “6x11”
string
Tags for tracking and reporting
boolean
Test mode - generates PDF but doesn’t dispatch
string
URL or path to front image (JPG or PDF)
string
Message text to include on the postcard
object
required
Recipient information including firstname, lastname, address1, city, zipcode, country

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: STANNP_CREATE_SELECTIONTool 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

string
Optional name for the filter selection to help identify it.
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’.
integer
required
The ID of the group to associate this selection with.

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: STANNP_DELETE_GROUPTool 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

integer
required
ID of the group to delete.
boolean
If true, completely delete all recipients in the group. Defaults to false (recipients remain on your account).

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: STANNP_DELETE_RECIPIENTTool to permanently delete a recipient from your account. Use when you need to remove a recipient from your mailing list.

Input Parameters

integer
required
ID of the recipient to delete.

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: STANNP_GET_ACCOUNT_BALANCETool to retrieve the current account balance. Use when you need to check available account funds.

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: STANNP_GET_CAMPAIGNTool to retrieve details of a specific campaign. Use when you need to get information about a campaign by its ID.

Input Parameters

integer
required
ID of the campaign 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: STANNP_GET_CAMPAIGN_AVAILABLE_DATESTool 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

string
required
End date in YYYY-MM-DD format for the date range query.
string
required
Start date in YYYY-MM-DD format for the date range query.

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: STANNP_GET_CAMPAIGN_COSTTool 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

integer
required
ID of the campaign to get the cost of booking.

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: STANNP_GET_CONTACTRetrieve details of a specific contact by ID, returning the contact fields supported by the response model.

Input Parameters

string
required
The ID of the contact 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: STANNP_GET_CURRENT_USERRetrieve account details for the currently authenticated user.

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: STANNP_GET_REPORTING_SUMMARYTool 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

string
required
End date in YYYY-MM-DD format for the reporting period
string
required
Start date in YYYY-MM-DD format for the reporting period

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: STANNP_IMPORT_RECIPIENTSTool 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

string
required
Base64-encoded CSV or XLS file content to upload
string
required
ID of the recipient group to import into
boolean
Whether to update existing recipients if duplicates are found

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: STANNP_LIST_CAMPAIGNSTool to get a list of all campaigns. Use when you need to retrieve campaigns after authentication.

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: STANNP_LIST_CONTACTSTool to list all contacts. Use when you need to retrieve contacts with optional pagination filters.

Input Parameters

integer
Page number for paginated results
integer
Number of results per page

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: STANNP_LIST_FOLDERSTool to get a list of folders in your secure file transfer area. Use when you need to retrieve available folders for file organization.

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: STANNP_LIST_GROUPSTool to get a list of mailing groups on your account. Use when you need to retrieve all groups with optional pagination.

Input Parameters

integer
Limit for pagination. Specifies the maximum number of groups to return.
integer
Offset for pagination. Specifies the starting point for the result set.

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: STANNP_LIST_MAILPIECESRetrieve mailpiece objects sent within a date range to review mailing history. Optionally filter the results by delivery status or custom tag.

Input Parameters

string
Filter by custom tag associated with mailpieces
string
Filter by delivery status (e.g., delivered, returned, printing, local_delivery)
string
required
End date of the reporting period in YYYY-MM-DD format
string
required
Start date of the reporting period in YYYY-MM-DD format

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: STANNP_LIST_TEMPLATESTool to list all templates associated with the account. Use when you need to retrieve available templates after authentication.

Input Parameters

integer
Page number for paginated results
integer
Number of records per page

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: STANNP_MERGE_PDFSMerge two or more PDF files accessible by URL into a single file, returning the merged file URL.

Input Parameters

array
required
An array of URLs for the PDF files to merge. Provide at least 2 URLs to merge.

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: STANNP_PURGE_GROUPTool to remove all recipients from a mailing list. Recipients remain on your account if delete_recipients is false.

Input Parameters

integer
required
ID of the group to purge.
boolean
If true, completely delete all recipients. Defaults to false.

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: STANNP_RECALCULATE_GROUPTool 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

integer
required
The ID of the group to recalculate.

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: STANNP_REMOVE_RECIPIENTS_FROM_GROUPTool 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

integer
required
ID of the group to remove recipients from.
string
required
Comma-separated recipient IDs to remove from the group.

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: STANNP_UPLOAD_FILETool 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

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’).
integer
A folder ID for placing the file in a specific folder

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: STANNP_VALIDATE_ADDRESSTool 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

string
Address city.
string
Two-letter state abbreviation if possible.
string
Company name.
string
ISO 3166-1 Alpha 2 Country Code (US, GB, CA, FR…).
string
Address zipcode.
string
Address line 1.
string
Address line 2.

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