- Category: marketing automation
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 24
- Triggers: 0
- Slug:
POSTALYTICS - Version: 20261101_00
Tools
Add Account
Add Account
Slug:
POSTALYTICS_ADD_ACCOUNTCreate a new Postalytics sub-account associated with the requester as parent. The response may include the account ID, API key, and creation date.Input Parameters
The password associated with the account. Must follow password guidelines - minimum 8 characters including 1 uppercase letter, 1 lowercase letter, 1 number, and 1 special character
Output
Add Contact
Add Contact
Create New Campaign
Create New Campaign
Slug:
POSTALYTICS_CREATE_NEW_CAMPAIGNTool to create a new direct mail campaign in Postalytics. Use when you need to start a new campaign with specified sender details and template. Important: A template must be created and proofed before creating the campaign.Input Parameters
Identifies media type. Valid values are 21-34, including postcards, letters, and bifolds in first class or standard mail.
The ID of the template to use for the front of this campaign. Template must be created and proofed before campaign creation.
Custom envelope ID for letter campaigns. Optional parameter only applicable to letter-type campaigns.
Output
Create Suppression List
Create Suppression List
Slug:
POSTALYTICS_CREATE_SUPPRESSION_LISTTool to create a new suppression list that can be used in campaigns to suppress contacts from being sent mail. Use when you need to create an empty suppression list. Note that contacts must be added separately using the SuppressionListContact API after the list is created.Input Parameters
Output
Create Suppression List Contact
Create Suppression List Contact
Create Template
Create Template
Slug:
POSTALYTICS_CREATE_TEMPLATECreate a mail template for postcards, letters, or bifolds using HTML, with optional front and back image URLs.Input Parameters
Template dimensions: ‘0’=letter, ‘1’=4x6 postcard, ‘2’=6x9 postcard, ‘3’=6x11 postcard, ‘6’=12x9 bifold, ‘7’=6x18 bifold.
Determines whether HTML is sent as complete markup (true) or as separate front/back images (false). Default: true.
Output
Create Webhook
Create Webhook
Slug:
POSTALYTICS_CREATE_WEBHOOKTool to create a new webhook to receive campaign event notifications from Postalytics. Use when you need to set up a webhook endpoint that will be notified about campaign events like sent, delivered, opened, or clicked.Input Parameters
List of campaign event types to subscribe to. Common events include ‘sent’, ‘delivered’, ‘opened’, ‘clicked’.
Output
Delete Account
Delete Account
Slug:
POSTALYTICS_DELETE_ACCOUNTTool to delete a Postalytics account and all associated campaigns, templates, and lists. Use when you need to permanently remove a sub account or sub user account. Cannot delete parent accounts.Input Parameters
The unique identifier of the account to delete. Only sub accounts and sub user accounts can be deleted. Cannot delete parent accounts.
Output
Delete Campaign
Delete Campaign
Delete Suppression List
Delete Suppression List
Delete Suppression List Contact
Delete Suppression List Contact
Get All Contact Lists
Get All Contact Lists
Get All Contacts on a List
Get All Contacts on a List
Get All Drip Campaigns
Get All Drip Campaigns
Get All Flows
Get All Flows
Get All Webhooks
Get All Webhooks
Get Integrations
Get Integrations
Get My Account
Get My Account
Get Suppression List
Get Suppression List
Get Suppression List Contact
Get Suppression List Contact
Get Suppression List Contacts
Get Suppression List Contacts
Get Suppression Lists
Get Suppression Lists
Slug:
POSTALYTICS_GET_SUPPRESSION_LISTSTool to retrieve all suppression lists for the authenticated user. Use when you need to view or manage suppression lists. Returns all lists or a specific list when ID is provided.Input Parameters
The identifier of a specific suppression list to retrieve. If not provided, all suppression lists will be returned.
Output
Update Account
Update Account
Slug:
POSTALYTICS_UPDATE_ACCOUNTTool to update an existing account in the Postalytics system. Use when you need to modify account information such as contact details, address, or credentials for an existing account.Input Parameters
The password associated with the account. Must follow password guidelines - minimum 8 characters including 1 uppercase letter, 1 lowercase letter, 1 number, and 1 special character