list_groups
List Groups
Retrieve a paginated list of mailing groups (mailing lists) on the account.
list_groups
Retrieve a paginated list of mailing groups (mailing lists) on the account.
create_recipient
Add a new recipient to a mailing group. Duplicate handling can be configured to update, ignore, or create a duplicate entry.
create_campaign
Create a new bulk mail campaign that targets a recipient group with a design template. After creation, the campaign needs to be approved and booked before it is dispatched.
send_sms
Send an SMS message to a phone number or an existing recipient. Supports template tags when using a recipient ID. Use test mode to validate without sending.
approve_campaign
Approve a campaign, locking its design and recipient list. This must be done before booking the campaign for dispatch.
validate_address
Verify that a mailing address is valid and deliverable before sending mail. Currently supports US and UK addresses.
list_templates
Retrieve all available design templates. Templates can be used when creating postcards, letters, or campaigns.
get_account_info
Retrieve account information and current balance. Useful for checking available funds before sending mail or booking campaigns.
get_campaign_cost
Calculate the cost breakdown for a campaign including per-item rates, recipient counts, and totals.
list_recipients
Retrieve a paginated list of recipients. Optionally filter by group ID.
book_campaign
Schedule an approved campaign for dispatch on a specific date. The campaign must be approved first.
send_postcard
Send a personalized postcard to a recipient. You can target an existing recipient by ID or provide inline address details. Supports custom front/back images, templates, and test mode for generating sample PDFs without dispatch.
delete_recipient
Permanently remove a recipient from the account by their ID.
add_recipients_to_group
Add one or more existing recipients to a mailing group by their IDs.
list_campaigns
Retrieve all campaigns on the account with their current status and details.
delete_campaign
Permanently delete an unbooked campaign. Campaigns that have already been booked or dispatched cannot be deleted.
get_recipient
Retrieve detailed information about a single recipient by their ID.
create_group
Create a new mailing group (mailing list) that recipients can be added to.
get_report_summary
Retrieve a status summary of all mailpieces within a date range. Shows totals for each status: received, printing, handed over, local delivery, delivered, returned, and cancelled.
get_campaign
Retrieve detailed information about a specific campaign including its status, cost, and send date.
list_mailpieces
Retrieve a detailed list of individual mailpiece objects sent within a date range. Optionally filter by status or tag.
delete_group
Delete a mailing group. Optionally delete all recipients in the group permanently.
send_letter
Send a letter to a recipient. Supports mail-merged letters via template ID or fully pre-formatted letters via file URL/base64. Options include duplex printing, first-class postage, and test mode.
remove_recipients_from_group
Remove one or more recipients from a mailing group. Recipients remain on the account but are no longer part of this group.
Send physical postcards, letters, greetings cards, and self-mailers programmatically. Manage recipients and groups, create and track bulk mail campaigns, validate addresses, send SMS messages, and generate QR codes. Upload design templates and artwork, check account balance, and monitor mailpiece delivery status. Supports US, UK, Canada, and worldwide destinations.
Common questions about connecting Stannp to AI agents with Metorial.